Ultralytics HUB-SDK
Bienvenue dans la documentation du HUB-SDK Ultralytics ! Si vous cherchez à intégrer de puissants outils et services de machine learning dans vos applications Python, vous êtes au bon endroit. Que vous soyez un passionné de l'IA, un praticien expérimenté du machine learning ou un développeur de logiciels cherchant à exploiter les capacités des services Ultralytics, notre SDK rend cela facile et efficace.
Notre documentation conviviale et professionnelle vous guidera dans un parcours allant de l'installation à la maîtrise du HUB-SDK. Plongeons-nous et commençons à exploiter toute la puissance de l'écosystème Ultralytics dans vos projets !
Par où commencer
Prêt à démarrer avec le HUB-SDK ? Notre guide de démarrage rapide offre un chemin simple pour que le SDK soit opérationnel dans votre environnement python.
- Faites progresser votre développement et rationalisez votre configuration en visitant la page Démarrage rapide.
Installation à partir de PyPI
Accédez à la dernière version stable de HUB-SDK via PyPI. Exécutez simplement la commande ci-dessous dans votre terminal ou shell pour ajouter de manière transparente le SDK à votre projet Python :
pip install hub-sdk
Après avoir exécuté cette commande, le SDK sera téléchargé et installé, déverrouillant ainsi les capacités des services Ultralytics dans votre application.
Initialiser HUBClient
L'intégration avec les services Ultralytics commence par l'initialisation d'un HUBClient
objet. Cette étape cruciale crée un pont entre votre code et nos API et nécessite des informations d'identification appropriées pour l'authentification. Vous pouvez opter pour la méthode standard de clé API ou utiliser votre adresse e-mail et votre mot de passe. Configurons cela ensemble ! 🚀
Option 1 : Utilisation d'une clé API
Pour utiliser la simplicité d'une clé API, préparez un dictionnaire avec votre clé comme ceci :
# Replace <YOUR-API-KEY> with the actual key provided to you by Ultralytics.
credentials = {"api_key": "<YOUR-API-KEY>"}
L'utilisation d'une clé API est une méthode d'authentification courante adaptée à l'accès programmatique. Elle est parfaite pour les scénarios où l'intégration d'une clé directement dans votre framework est souhaitée pour une interaction de service rapide et sécurisée. Le HUBClient
mais si vous préférez travailler directement avec les fonctions, consultez les sous-sections suivantes pour savoir comment les importer indépendamment. hérite des capacités d'authentification de la Auth
class.
Option 2 : Utilisation d'un e-mail et d'un mot de passe
Vous préférez exploiter les informations d'identification de votre compte ? Configurez le HUBClient
avec votre adresse e-mail et votre mot de passe dans le dictionnaire des informations d'identification :
# Replace <YOUR-EMAIL> with your email address and <YOUR-PASSWORD> with your password.
credentials = {"email": "<YOUR-EMAIL>", "password": "<YOUR-PASSWORD>"}
Utiliser votre e-mail et votre mot de passe est un choix pratique si vous recherchez une expérience de connexion traditionnelle ou si vous souhaitez utiliser des fonctionnalités personnalisées liées à votre compte Ultralytics.
Pour faire la synthèse
Maintenant que vos informations d'identification sont prêtes, lancez votre HUBClient
:
Authentification SDK HUB
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)
Cette ligne de code cruciale crée une nouvelle instance de HUBClient
, vous connectant au vaste éventail de services offerts par la plateforme Ultralytics. Une fois vos informations d'authentification en place et sécurisées, vous êtes prêt à explorer les fonctionnalités à portée de main ! Le login
méthode gère l'authentification en utilisant les informations d'identification fournies.
Fonctionnalités du HUB-SDK
Le Ultralytics HUB-SDK fournit une gamme de fonctionnalités pour interagir avec vos projets de machine learning. Voici quelques opérations clés que vous pouvez effectuer :
- Gestion des ensembles de données: Interagissez avec les ensembles de données en utilisant le
dataset
méthode, qui renvoie unDatasets
objet. Vous pouvez obtenir, créer, mettre à jour, supprimer, liste, obtenir une URL pour l'accès aux données, et télécharger datasets. - Liste des ensembles de données: Obtenez une liste des ensembles de données avec le
dataset_list
méthode, qui renvoie unDatasetList
objet. - Gestion de projet : Gérez vos projets en les récupérant, en les créant, en les mettant à jour ou en les supprimant.
Félicitations pour la configuration du Ultralytics HUB-SDK ! Vous êtes maintenant bien équipé pour entreprendre votre parcours d’intégration de services d’apprentissage automatique de pointe dans vos applications. Explorez notre documentation supplémentaire pour obtenir des conseils sur l’utilisation d’API spécifiques et consultez nos forums communautaires si vous rencontrez des difficultés. Bon codage, et que vos projets prospèrent grâce à la puissance d’Ultralytics ! 🌟