> ## Documentation Index
> Fetch the complete documentation index at: https://docs.coreweave.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Public API 概要

> W&B Public API を使用して W&B のデータをプログラムでアクセスおよび管理します

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

> モデルをトレーニングしたりファインチューニングしたりするには、[W\&B Python SDK](/ja/products/wandb/ref/python) を使用します。W\&B にデータをログした*後*で、そのデータをクエリしたり管理したりするには、Public API を使用します。

<h2 id="available-components">
  利用可能なコンポーネント
</h2>

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

<h2 id="common-use-cases">
  一般的な使用例
</h2>

<h3 id="data-export-and-analysis">
  データのエクスポートと分析
</h3>

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

<h3 id="post-hoc-updates">
  事後更新
</h3>

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

<h3 id="artifact-management">
  アーティファクト管理
</h3>

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

<h3 id="sweep-analysis">
  Sweep Analysis
</h3>

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

<h2 id="authentication">
  認証
</h2>

Public API は Python SDK と同じ認証メカニズムを使用します。認証にはいくつかの方法があります。

`WANDB_API_KEY` 環境変数を使用して APIキーを設定します。

```bash theme={"system"}
export WANDB_API_KEY=your_api_key
```

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

```python theme={"system"}
api = Api(api_key="your_api_key")
```

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

```python theme={"system"}
import wandb

wandb.login()
api = Api()
```

<h2 id="example-usage">
  使用例
</h2>

<h3 id="download-an-artifact-by-name-and-alias">
  名前とエイリアスで アーティファクト をダウンロードする
</h3>

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

```python theme={"system"}
import wandb

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

<h3 id="download-an-artifact-from-a-registry">
  Registry からアーティファクトをダウンロードする
</h3>

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

```python theme={"system"}
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()
```

<h3 id="query-registry">
  Registry をクエリする
</h3>

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

```python theme={"system"}
import wandb

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

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

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

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


## Related topics

- [API の概要](/ja/products/inference/serverless/api-reference.md)