Ultralytics Руководство по управлению моделями HUB-SDK

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

Получение модели по ее уникальному идентификатору

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

from hub_sdk import HUBClient

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

model = client.model("<Model ID>")
print(model.data)  # Outputs the model's metadata and configuration

Необходимые условия для проекта и набора данных Access

Перед созданием модели или обучением очень важно убедиться в наличии проекта и набора данных. Этот простой фрагмент кода поможет вам убедиться в наличии этих компонентов, инициализировав их объекты. Хотя использование проекта и набора данных для организации обучения модели полезно, важно отметить, что оно не является обязательным. Если один из идентификаторов отсутствует, данные объекта (project.data, dataset.data) будет пустым.

from hub_sdk import HUBClient

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

project = client.project("<Project ID>")
dataset = client.dataset("<Dataset ID>")

Создание новой модели с пользовательской конфигурацией

Создание новой модели, соответствующей требованиям вашего проекта, упрощается с помощью этой удобной функции. Укажите имя модели и свяжите ее с проектом и набором данных. Вы также можете настроить конфигурации в соответствии с вашими потребностями, например, задать размер партии или устройство. Обратите внимание, что projectId и datasetId параметры необязательны, если вы еще не готовы привязать модель к проекту или набору данных.

from hub_sdk import HUBClient

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

data = {
    "meta": {"name": "sdk model"},  # Give your model a recognizable name
    "projectId": project.id,  # Associate with an existing project
    "datasetId": dataset.id,  # Associate with an existing dataset
    "config": {  # Define hyperparameters and settings
        "batchSize": "-1",
        "cache": "ram",
        "device": "name",
        "epochs": "5",
        "imageSize": "640",
        "patience": "5",  # Stop training if validation doesn't improve
    },
}
model = client.model()
model.create_model(data)  # Creates the model with your specified details

Обновление метаданных или конфигурации существующей модели

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

from hub_sdk import HUBClient

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

model = client.model("<Model ID>")
model.update({"meta": {"name": "Updated Model Name"}})  # Renames the specified model

Безопасное удаление модели

Удаление модели необратимо, поэтому эту функцию следует использовать с осторожностью. Если вы уверены, что хотите удалить модель из системы, следующая команда навсегда удалит указанную модель вместе со всеми связанными с ней данными.

from hub_sdk import HUBClient

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

model = client.model("<Model ID>")
model.delete(hard=True)  # Permanently deletes the specified model

По умолчанию метод delete выполняет мягкое удаление, помечая модель как неактивную и не удаляя ее окончательно. Если вы хотите выполнить жесткое удаление и удалить модель вместе с ее связанными данными навсегда, вы можете передать аргумент hard=True как показано в примере выше. Будьте осторожны при использовании опции жесткого удаления, поскольку она необратима и приводит к полному удалению указанной модели из системы.

Перечисление всех моделей с помощью пагинации

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

from hub_sdk import HUBClient

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

model_list = client.model_list(page_size=10)  # Fetches the first page with 10 models
print("Current result:", model_list.results)  # Displays the current page's models

model_list.next()  # Move to the next page of results
print("Next page result:", model_list.results)  # Displays the next page's models

model_list.previous()  # Return to the previous page of results
print("Previous page result:", model_list.results)  # Displays the previous page's models

Загрузка и визуализация показателей обучения

Чтобы отслеживать и визуализировать показатели работы модели на протяжении всего процесса обучения, используйте эту функцию для загрузки таких показателей, как потери и точность. Это позволяет постоянно отслеживать ход обучения и упрощает этап анализа.

from hub_sdk import HUBClient

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

model = client.model("<Model ID>")

# Define your metrics structure. Keys are steps, and values are JSON strings of metrics.
data = {
    1: '{"loss/1": 0.5, "accuracy/1": 0.85}',
    2: '{"loss/2": 0.4, "accuracy/2": 0.88}',
    3: '{"loss/3": 0.3, "accuracy/3": 0.90}',
}

model.upload_metrics(data)  # Uploads the specified metrics to the model

Экспорт модели для развертывания или анализа

Экспорт моделей для различных целей, таких как развертывание или углубленный анализ, никогда не был таким простым. Укажите необходимый формат, и эта функция подготовит модель соответствующим образом. Независимо от того, нужен ли вам формат Tensorflow или PyTorch , SDK легко справится с этой задачей.

from hub_sdk import HUBClient

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

model = client.model("<Model ID>")
model.export(format="pyTorch")  # Exports the model as a PyTorch file

Получение URL-адреса прямого веса

Иногда вам может потребоваться прямой доступ к удаленно хранящимся артефактам вашей модели. Эта удобная функция предоставляет URL-адрес для доступа к определенным файлам, например к весам вашей модели с наилучшими показателями.

from hub_sdk import HUBClient

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

model = client.model("<Model ID>")
weight_url = model.get_weights_url("best")  # or "last"
print("Weight URL link:", weight_url)  # Prints out the weight url link

Загрузка контрольной точки модели

Загрузка контрольной точки модели осуществляется с помощью upload_model Функция. Просто укажите значение контрольной точки с помощью is_best флаг и эпоху обучения для наглядности.

from hub_sdk import HUBClient

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

model = client.model("<Model ID>")
model.upload_model(is_best=True, epoch=5, weights="<Weight File>")  # Uploads the specified model checkpoint

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

Комментарии