Ultralytics HUB-SDK モデル管理

Ultralytics HUB-SDK モデル管理ドキュメントへようこそ！機械学習モデルの管理を始めたばかりでも、具体的な操作方法を探している熟練のデータサイエンティストでも、このドキュメントを読めば大丈夫です。このガイドでは、HUB-SDKの機能をスムーズに使いこなし、モデルを効率的に管理するためのノウハウを身につけることができます。

一意の識別子でモデルを検索する

機械学習ワークフローにおいて、特定のモデルにアクセスすることは一般的な要件です。Ultralytics HUB-SDKを使えば、IDでモデルを取得するのは簡単です。この関数は、提供された一意の識別子に基づいてモデルオブジェクトを設定し、モデルの詳細と操作への完全なアクセスを許可します。

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プロジェクトとデータセットの前提条件

モデルを作成したり、トレーニングしたりする前に、以下の2点を確認することが重要である。プロジェクトそしてデータセットが存在します。以下のコード・スニペットは、これらのコンポーネントのオブジェクトを初期化することで、これらのコンポーネントを検証するのに役立ちます。モデル学習を整理するためにプロジェクトとデータセットを利用することは有益ですが、必須ではありません。どちらかのIDが欠落している場合、オブジェクトデータ(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"},  # Model name
    "projectId": project.id,  # Optional: Associate with an existing project
    "datasetId": dataset.id,  # Optional: 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
print("Next page result:", model_list.results)

model_list.previous()  # Return to the previous page
print("Previous page result:", model_list.results)

トレーニングメトリクスのアップロードと可視化

トレーニング・プロセスを通じてモデルのパフォーマンス・メトリクスを追跡・可視化するには、この機能を使って損失や精度などのメトリクスをアップロードします。これにより、トレーニングの進捗状況を継続的に監視し、分析段階を簡素化することができます。

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)

モデルのチェックポイントをアップロードする

アップロードモデル・チェックポイントを使えば簡単だ。 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は、効率的なモデル管理のための包括的な操作セットを提供し、機械学習の取り組みで最高の結果を達成することに集中できるようにします。ご質問やサポートが必要な場合は、当社のコミュニティまたはサポートチームにご連絡ください。良いモデリングを！🚀

📅作成：1年前 ✏️更新：1ヶ月前