Быстрый старт: Установка 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's package installer:

pip install hub-sdk

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

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

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

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

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

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

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

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

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

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 в своих проектах, изучай документацию, чтобы узнать, что еще ты можешь сделать, а если у тебя возникнут какие-либо проблемы, то наша дружелюбная служба поддержки находится всего в одном клике от тебя. Счастливого кодинга!