Ultralytics HUB-SDK
Добро пожаловать в документацию Ultralytics HUB-SDK! Если вы хотите интегрировать мощные инструменты и сервисы машинного обучения в свои приложения Python, вы попали в нужное место. Независимо от того, являетесь ли вы энтузиастом ИИ, опытным специалистом по машинному обучению или разработчиком программного обеспечения, стремящимся использовать возможности сервисов Ultralytics, наш SDK сделает это простым и эффективным.
Наша дружелюбная и профессиональная документация проведет вас от установки до мастерства HUB-SDK. Давайте погрузимся и начнем использовать всю мощь экосистемы Ultralytics в ваших проектах!
С чего начать
Готовы начать работу с HUB-SDK? Наше руководство по быстрому старту предлагает простой способ запуска SDK в вашей среде Python.
- Ускорьте разработку и упростите настройку, посетив страницу Quickstart.
Установка из PyPI
Получите доступ к последней стабильной версии HUB-SDK через PyPI. Просто выполните команду ниже в своем терминале или оболочке, чтобы легко добавить SDK в свой проект Python:
pip install hub-sdk
После выполнения этой команды SDK будет загружен и установлен, открывая возможности сервисов Ultralytics в вашем приложении.
Инициализировать HUBClient
Интеграция со службами Ultralytics начинается с инициализации HUBClient
объект. Этот важный шаг создает мост между вашим кодом и нашими API и требует соответствующих учетных данных для аутентификации. Вы можете выбрать стандартный метод ключа API или использовать свою электронную почту и пароль. Давайте настроим это вместе! 🚀
Вариант 1: Использование API-ключа
Чтобы воспользоваться простотой ключа API, подготовьте словарь с вашим ключом следующим образом:
# Replace <YOUR-API-KEY> with the actual key provided to you by Ultralytics.
credentials = {"api_key": "<YOUR-API-KEY>"}
Использование ключа API — это распространенный метод аутентификации, подходящий для программного доступа. Он идеально подходит для сценариев, где требуется интеграция ключа непосредственно в ваш фреймворк для быстрого и безопасного взаимодействия со службой. The HUBClient
класс наследует возможности аутентификации из Auth
class.
Вариант 2: Использование электронной почты и пароля
Предпочитаете использовать учетные данные своей учетной записи? Настройте HUBClient
с вашим адресом электронной почты и паролем в словаре учетных данных:
# Replace <YOUR-EMAIL> with your email address and <YOUR-PASSWORD> with your password.
credentials = {"email": "<YOUR-EMAIL>", "password": "<YOUR-PASSWORD>"}
Использование вашей электронной почты и пароля — удобный выбор, если вы ищете традиционный способ входа в систему или хотите использовать персонализированные функции, связанные с вашей учетной записью Ultralytics.
Объединяя все вместе
Теперь, когда ваши учетные данные подготовлены, инициируйте свой HUBClient
:
Аутентификация HUB SDK
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. После того, как ваши данные аутентификации будут надежно сохранены, вы будете готовы изучить функциональные возможности, которые у вас под рукой! The login
метод обрабатывает аутентификацию используя предоставленные учетные данные.
Функциональные возможности HUB-SDK
Ultralytics HUB-SDK предоставляет ряд функций для взаимодействия с вашими проектами машинного обучения. Вот некоторые ключевые операции, которые вы можете выполнять:
- Управление набором данных: Взаимодействуйте с наборами данных, используя
dataset
метод, который возвращает aDatasets
объект. Вы можете получить, создать, обновить, удалить, список, получить URL-адрес для доступа к набору данныхи загрузить наборы данных. - Список наборов данных: Получите список наборов данных с помощью
dataset_list
метод, который возвращает aDatasetList
объект. - Управление проектами: Управляйте своими проектами путем получения, создания, обновления или удаления их.
Поздравляем с настройкой Ultralytics HUB-SDK! Теперь у вас есть все необходимое, чтобы начать свой путь к интеграции передовых сервисов машинного обучения в ваши приложения. Изучите нашу дальнейшую документацию для получения инструкций по использованию конкретных API и обратитесь к нашим форумам сообщества, если у вас возникнут какие-либо трудности. Удачи в программировании, и пусть ваши проекты процветают благодаря мощи Ultralytics! 🌟