Быстрый старт: Установка HUB-SDK

Здравствуйте и добро пожаловать! 🎉 Если вы хотите быстро и без проблем интегрироваться с сервисами Ultralytics , вы пришли по адресу. Наше руководство по установке HUB-SDK разработано для того, чтобы помочь вам быстро приступить к работе с помощью четких пошаговых инструкций. Независимо от того, опытный вы разработчик или только начинаете, наша цель - предоставить вам простой и понятный процесс установки. Так что берите свой любимый напиток и давайте вместе отправимся в путешествие по установке!

Пререквизиты

Прежде чем приступить к основной части установки, давайте убедимся, что у нас есть все необходимые инструменты. Процесс установки начинается с правильной настройки, поэтому вот что должно быть у вас под рукой:

Python: Для работы с HUB-SDK необходимо, чтобы на вашей машине был установлен Python . Загрузите последнюю версию с python.org, если она еще не установлена на вашей системе.
Git (необязательно): Хотя Git не является обязательным для установки HUB-SDK, он настоятельно рекомендуется, если вы хотите получить самые последние и лучшие функции прямо из источника. Git можно получить с сайта git-scm.com.

После выполнения этих предварительных условий вы можете переходить к этапу установки.

Способы установки

В зависимости от ваших потребностей, вы можете выбрать один из двух основных способов установки HUB-SDK. Вот что предлагает каждый из этих способов:

Установка из PyPI

Если вам нужна стабильность и простота установки, то лучше всего взять последний стабильный выпуск HUB-SDK с PyPI. Вот как это можно сделать с помощью pip, программы установки пакетов Python:

pip install hub-sdk

Выполнив эту команду, вы получите стабильную версию HUB-SDK и установите ее прямо в ваше окружение Python . Это самый быстрый путь к началу работы с HUB-SDK.

Инициализация HUBClient

После завершения установки настало время приступить к работе с HUBClient. HUBClient станет вашим шлюзом для взаимодействия с экосистемой Ultralytics . Ниже приведены два способа аутентификации и использования клиента.

Вариант A: Использование ключа API для аутентификации

Для тех, кто предпочитает использовать API-ключи для простоты и безопасности, вот как их настроить:

credentials = {"api_key": "<YOUR-API-KEY>"}

Вставьте свой фактический ключ API, предоставленный Ultralytics , вместо <YOUR-API-KEY>. Это предпочтительный метод, когда для доступа к API требуется защищенный ключ.

Вариант B: Использование пары "электронная почта/пароль" для аутентификации

Если вам нужно использовать комбинацию из электронной почты и пароля, это так же просто:

credentials = {"email": "<YOUR-EMAIL>", "password": "<YOUR-PASSWORD>"}

Заменить <YOUR-EMAIL> и <YOUR-PASSWORD> с вашими учетными данными для входа в систему. Этот подход более традиционный, но не менее надежный.

Наконец, создайте объект HUBClient с выбранным методом получения учетных данных:

Аутентификация HUB SDK

Аутентификация с помощью ключа APIАутентификация с помощью электронной почты и пароля

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)

Выполнив приведенную выше строку кода, вы успешно создали экземпляр HUBClient, готовый к выполнению различных операций с помощью сервисов Ultralytics !

Все готово! Теперь в вашем распоряжении установлен HUB-SDK и инициализированный HUBClient. С этого момента вы можете начать погружаться в богатые возможности, предоставляемые экосистемой Ultralytics . Используйте мощь и гибкость HUB-SDK для своих проектов, изучайте документацию, чтобы узнать, что еще вы можете сделать, а если у вас возникнут какие-либо проблемы, наша дружелюбная служба поддержки находится всего в одном клике от вас. Счастливого кодинга!