Public API 概要 - CoreWeave Docs

W&B Public API は、W&B に保存されたデータをクエリしたり、エクスポートしたり、更新したりするためのプログラムによるアクセスを提供します。この API を使用して、事後分析、データエクスポート、および run、アーティファクト、sweep のプログラムによる管理を行います。メインの SDK がトレーニング中にリアルタイムでログする処理を担う一方で、Public API を使用すると、履歴データの取得、メタデータの更新、アーティファクトの管理、完了した実験の分析を行うことができます。メインの Api クラスは、ほとんどの機能へのエントリポイントとして機能します。

モデルをトレーニングしたりファインチューニングしたりするには、W&B Python SDK を使用します。W&B にデータをログした後で、そのデータをクエリしたり管理したりするには、Public API を使用します。

利用可能なコンポーネント

Component	説明
`Api`	Public API のメインエントリポイントです。組織全体の run、project、アーティファクトをクエリします。
`Runs`	個々のトレーニング run にアクセスして管理します。履歴、ログ、メトリクスを含みます。
`Artifacts`	モデルアーティファクト、データセット、その他のバージョン付きファイルをクエリしてダウンロードします。
`Sweeps`	ハイパーパラメーター sweep データにアクセスし、最適化結果を分析します。
`Projects`	project を管理し、project レベルのメタデータと設定にアクセスします。
`Reports`	W&B Reports にプログラムでアクセスして管理します。
`Team`	チーム情報をクエリし、チームレベルのリソースを管理します。
`User`	ユーザープロフィールとユーザー固有のデータにアクセスします。
`Files`	run に関連付けられたファイルをダウンロードして管理します。
`History`	トレーニング中にログされた詳細な時系列メトリクスにアクセスします (Run.history を参照) 。
`Automations`	オートメーションワークフローと action を管理します。
`Integrations`	サードパーティインテグレーションを構成して管理します。

一般的な使用例

データのエクスポートと分析

run の履歴をデータフレームとしてエクスポートし、Jupyter ノートブックで分析します
カスタムな可視化や report のためにメトリクスをダウンロードします
複数の実験にわたる結果を集計します

事後更新

完了後に実行のメタデータを更新する
完了した実験にタグやノートを追加する
実行の設定やサマリーを変更する

アーティファクト管理

バージョンまたはエイリアスでアーティファクトをクエリする
モデルチェックポイントをプログラムでダウンロードする
アーティファクトのリネージと依存関係をトラッキングする

Sweep Analysis

sweep の結果と最高パフォーマンスの run にアクセス
ハイパーパラメーター探索の結果をエクスポート
パラメーター重要度を分析

認証

Public API は Python SDK と同じ認証メカニズムを使用します。認証にはいくつかの方法があります。 WANDB_API_KEY 環境変数を使用して APIキーを設定します。

export WANDB_API_KEY=your_api_key

Api クラスを初期化する際に、APIキーを直接渡します：

api = Api(api_key="your_api_key")

または wandb.login() を使用して現在のセッションを認証します：

import wandb

wandb.login()
api = Api()

使用例

名前とエイリアスでアーティファクトをダウンロードする

次の例では、W&B に記録されたアーティファクトを名前とエイリアスで取得し、その内容をダウンロードする方法を示します。

import wandb

api = wandb.Api()
artifact = api.artifact("entity/project/artifact:alias")
artifact.download()

Registry からアーティファクトをダウンロードする

次の例は、Registry からリンクされたアーティファクトを取得する方法を示しています。

import wandb

REGISTRY = "<registry_name>"
COLLECTION = "<collection_name>"
VERSION = "<version>"

api = wandb.Api()
artifact_name = f"wandb-registry-{REGISTRY}/{COLLECTION}:{VERSION}"

# アーティファクトを取得します
fetched_artifact = api.artifact(name = artifact_name)

# アーティファクトをダウンロードします。ダウンロードした内容のパスを返します
downloaded_path = fetched_artifact.download()

Registry をクエリする

Mongo 形式のフィルターを使用して、Registry、コレクション、アーティファクトをクエリします。次の例では、正規表現を使用してコレクションを名前でフィルターする方法を示します。

import wandb

# wandb API を初期化します
api = wandb.Api()

# レジストリに関係なく、コレクション名に文字列 `yolo` を含む
# すべてのコレクションをフィルターします
collection_filters = {
    "name": {"$regex": "yolo"}
}

# フィルターに一致するすべてのコレクションのイテラブルを返します
collections = api.registries().collections(filter=collection_filters)

Registry、コレクション、またはアーティファクトをクエリする方法の詳細については、Registry 項目を検索するを参照してください。

​利用可能なコンポーネント

​一般的な使用例

​データのエクスポートと分析

​事後更新

​アーティファクト管理

​Sweep Analysis

​認証

​使用例

​名前とエイリアスで アーティファクト をダウンロードする

​Registry からアーティファクトをダウンロードする

​Registry をクエリする