Ultralytics HUB-SDK

¡Bienvenido a la documentación de Ultralytics HUB-SDK! Si busca integrar potentes herramientas y servicios de aprendizaje automático en sus aplicaciones de python, ha llegado al lugar adecuado. Tanto si es un entusiasta de la IA, un experto en aprendizaje automático o un desarrollador de software que busca aprovechar las capacidades de los servicios de Ultralytics, nuestro SDK lo hace fácil y eficiente.

Nuestra documentación amigable y profesional te guiará en un viaje desde la instalación hasta el dominio del HUB-SDK. ¡Sumérgete y comienza a aprovechar toda la potencia del ecosistema Ultralytics en tus proyectos!

Por dónde empezar

¿Listo para empezar con el HUB-SDK? Nuestra guía de inicio rápido ofrece un camino directo para poner en marcha el SDK en su entorno de python.

Impulsa tu desarrollo y optimiza tu configuración visitando la página de Inicio rápido.

Instalación desde PyPI

Obtenga acceso a la última versión estable de HUB-SDK a través de PyPI. Simplemente ejecute el siguiente comando en su terminal o shell para agregar sin problemas el SDK a su proyecto Python:

pip install hub-sdk

Después de ejecutar este comando, el SDK se descargará e instalará, desbloqueando las capacidades de los servicios de Ultralytics en tu aplicación.

Inicializar HUBClient

La integración con los servicios de Ultralytics comienza con la inicialización de un HUBClient objeto. Este paso fundamental crea un puente entre tu código y nuestras APIs y requiere las credenciales apropiadas para la autenticación. Puedes optar por el método estándar de clave API o utilizar tu correo electrónico y contraseña. ¡Configurémoslo juntos! 🚀

Opción 1: Usar una clave API

Para utilizar la simplicidad de una clave API, prepare un diccionario con su clave de la siguiente manera:

# Replace <YOUR-API-KEY> with the actual key provided to you by Ultralytics.
credentials = {"api_key": "<YOUR-API-KEY>"}

El uso de una clave API es un método de autenticación común adecuado para el acceso programático. Es perfecto para escenarios en los que se desea integrar una clave directamente en su framework para una interacción de servicio rápida y segura. El HUBClient clase hereda capacidades de autenticación de la Auth clase.

Opción 2: Usar correo electrónico y contraseña

¿Prefieres aprovechar las credenciales de tu cuenta? Configura el HUBClient con tu correo electrónico y contraseña en el diccionario de credenciales:

# Replace <YOUR-EMAIL> with your email address and <YOUR-PASSWORD> with your password.
credentials = {"email": "<YOUR-EMAIL>", "password": "<YOUR-PASSWORD>"}

Emplear su correo electrónico y contraseña es una opción conveniente si busca una experiencia de inicio de sesión tradicional o si desea utilizar funciones personalizadas vinculadas a su cuenta de Ultralytics.

Reuniendo todo

Ahora que sus credenciales están preparadas, inicie su HUBClient:

Autenticación del HUB SDK

Autenticación con clave APIAutenticación con correo electrónico y contraseña

from hub_sdk import HUBClient

credentials = {"api_key": "<YOUR-API-KEY>"}  # api key
client = HUBClient(credentials)

from hub_sdk import HUBClient

credentials = {"email": "<YOUR-EMAIL>", "password": "<YOUR-PASSWORD>"}  # email and password
client = HUBClient(credentials)

Esta línea de código crucial crea una nueva instancia de HUBClient, conectándole al vasto panorama de servicios ofrecidos por la plataforma Ultralytics. Con sus datos de autenticación seguros, ¡está listo para explorar las funcionalidades a su alcance! El login method gestiona la autenticación utilizando las credenciales proporcionadas.

Funcionalidades del HUB-SDK

El HUB-SDK de Ultralytics proporciona una variedad de funcionalidades para interactuar con sus proyectos de aprendizaje automático. Estas son algunas operaciones clave que puede realizar:

Gestión de conjuntos de datos: Interactúa con los conjuntos de datos utilizando el dataset método, que devuelve un Datasets objeto. Puedes obtener, crear, actualizar, eliminar, lista, obtener una URL para el acceso al conjunto de datos, y subir conjuntos de datos.
Listado de conjuntos de datos: Obtén una lista de conjuntos de datos con el dataset_list método, que devuelve un DatasetList objeto.
Gestión de proyectos: Gestione sus proyectos obteniendo, creando, actualizando o eliminandolos.

¡Enhorabuena por configurar el HUB-SDK de Ultralytics! Ahora estás bien equipado para embarcarte en tu viaje hacia la integración de servicios de aprendizaje automático de vanguardia en tus aplicaciones. Explora nuestra documentación adicional para obtener orientación sobre el uso de APIs específicas y consulta nuestros foros de la comunidad si encuentras algún obstáculo. ¡Feliz codificación y que tus proyectos prosperen con el poder de Ultralytics! 🌟