Api API (Application Programming Interface) は、プログラム間でデータや機能をやり取りするためのインターフェースを提供します。W&B API は、ユーザーがwandb を通じて**Projects**、**Entities**、**Runs**などのデータにアクセスし、管理することを可能にします。このAPIにより、**Experiments**の追跡や**Reports**の共有を自動化できます。W&B APIはPythonを含むさまざまなプログラミング言語で利用可能です。これにより、カスタムスクリプトの作成や他のツールとの統合が簡単になります。APIの使用方法に関する詳細な情報は、[API documentation](https://wandb.ai)を参照してください。

wandb サーバーをクエリするために使用されます。

Api(
    overrides: Optional[Dict[str, Any]] = None,
    timeout: Optional[int] = None,
    api_key: Optional[str] = None
) -> None

例:

最も一般的な初期化方法

>>> wandb.Api()

メソッド

artifact

ソースを表示

artifact(
    name: str,
    type: Optional[str] = None
)

project/name または entity/project/name の形式でパスを解析することにより、単一のアーティファクトを返します。

注意:

このメソッドは外部利用のみを目的としています。wandb リポジトリコード内で api.artifact() を呼び出さないでください。

artifact_collection

ソースを表示

artifact_collection(
    type_name: str,
    name: str
) -> "public.ArtifactCollection"

タイプと entity/project/name の形式でパスを解析することにより、単一のアーティファクトコレクションを返します。

artifact_collection_exists

ソースを表示

artifact_collection_exists(
    name: str,
    type: str
) -> bool

指定されたプロジェクトとエンティティ内にアーティファクトコレクションが存在するかどうかを返します。

artifact_collections

ソースを表示

artifact_collections(
    project_name: str,
    type_name: str,
    per_page: Optional[int] = 50
) -> "public.ArtifactCollections"

一致するアーティファクトコレクションのコレクションを返します。

artifact_exists

ソースを表示

artifact_exists(
    name: str,
    type: Optional[str] = None
) -> bool

指定されたプロジェクトとエンティティ内にアーティファクトバージョンが存在するかどうかを返します。

artifact_type

ソースを表示

artifact_type(
    type_name: str,
    project: Optional[str] = None
) -> "public.ArtifactType"

一致する ArtifactType を返します。

artifact_types

ソースを表示

artifact_types(
    project: Optional[str] = None
) -> "public.ArtifactTypes"

一致するアーティファクトタイプのコレクションを返します。

artifact_versions

ソースを表示

artifact_versions(
    type_name, name, per_page=50
)

非推奨、代わりに artifacts(type_name, name) を使用してください。

artifacts

ソースを表示

artifacts(
    type_name: str,
    name: str,
    per_page: Optional[int] = 50,
    tags: Optional[List[str]] = None
) -> "public.Artifacts"

指定されたパラメータから Artifacts コレクションを返します。

create_project

ソースを表示

create_project(
    name: str,
    entity: str
) -> None

新しいプロジェクトを作成します。

create_run

ソースを表示

create_run(
    *,
    run_id: Optional[str] = None,
    project: Optional[str] = None,
    entity: Optional[str] = None
) -> "public.Run"

新しい run を作成します。

create_run_queue

ソースを表示

create_run_queue(
    name: str,
    type: "public.RunQueueResourceType",
    entity: Optional[str] = None,
    prioritization_mode: Optional['public.RunQueuePrioritizationMode'] = None,
    config: Optional[dict] = None,
    template_variables: Optional[dict] = None
) -> "public.RunQueue"

新しい run キュー (launch) を作成します。

create_team

ソースを表示

create_team(
    team, admin_username=None
)

新しいチームを作成します。

create_user

ソースを表示

create_user(
    email, admin=(False)
)

新しいユーザーを作成します。

flush

ソースを表示

flush()

ローカルキャッシュをフラッシュします。

API オブジェクトは run のローカルキャッシュを保持するため、スクリプトを実行中に run の状態が変更される可能性がある場合、api.flush() を使用してローカルキャッシュをクリアし、run に関連付けられた最新の値を取得します。

from_path

ソースを表示

from_path(
    path
)

パスから run、sweep、プロジェクト、またはレポートを返します。

例:

project = api.from_path("my_project")
team_project = api.from_path("my_team/my_project")
run = api.from_path("my_team/my_project/runs/id")
sweep = api.from_path("my_team/my_project/sweeps/id")
report = api.from_path("my_team/my_project/reports/My-Report-Vm11dsdf")

job

ソースを表示

job(
    name: Optional[str],
    path: Optional[str] = None
) -> "public.Job"

指定されたパラメーターから Job を返します。

list_jobs

ソースを表示

list_jobs(
    entity: str,
    project: str
) -> List[Dict[str, Any]]

指定されたエンティティとプロジェクトに対して、利用可能なジョブのリストを返します。

project

ソースを表示

project(
    name: str,
    entity: Optional[str] = None
) -> "public.Project"

指定された名前 (および指定された場合はエンティティ) の Project を返します。

projects

ソースを表示

projects(
    entity: Optional[str] = None,
    per_page: Optional[int] = 200
) -> "public.Projects"

指定されたエンティティのプロジェクトを取得します。

queued_run

ソースを表示

queued_run(
    entity, project, queue_name, run_queue_item_id, project_queue=None,
    priority=None
)

パスに基づいて単一のキューされた run を返します。

entity/project/queue_id/run_queue_item_id の形式のパスを解析します。

registries

ソースを表示

registries(
    organization: Optional[str] = None,
    filter: Optional[Dict[str, Any]] = None
) -> Registries

レジストリのイテレータを返します。

イテレータを使用して、組織のレジストリ内のレジストリ、コレクション、またはアーティファクトバージョンを検索およびフィルタリングします。

例:

“model” を含む名前のすべてのレジストリを見つけます。

import wandb

api = wandb.Api()  # エンティティが複数の組織に属する場合、組織を指定します。
api.registries(filter={"name": {"$regex": "model"}})

“my_collection” という名前と “my_tag” というタグのあるコレクションをレジストリで見つけます。

api.registries().collections(filter={"name": "my_collection", "tag": "my_tag"})

“my_collection” を含むコレクション名と “best” というエイリアスを持つバージョンのあるすべてのアーティファクトバージョンを見つけます。

api.registries().collections(
    filter={"name": {"$regex": "my_collection"}}
).versions(filter={"alias": "best"})

“model” を含み、タグ “prod” またはエイリアス “best” を持つすべてのアーティファクトバージョンをレジストリで見つけます。

api.registries(filter={"name": {"$regex": "model"}}).versions(
    filter={"$or": [{"tag": "prod"}, {"alias": "best"}]}
)

reports

ソースを表示

reports(
    path: str = "",
    name: Optional[str] = None,
    per_page: Optional[int] = 50
) -> "public.Reports"

指定されたプロジェクトパスのレポートを取得します。

警告: この API はベータ版であり、将来のリリースで変更される可能性があります。

run

ソースを表示

run(
    path=""
)

entity/project/run_id の形式でパスを解析することにより、単一の run を返します。

run_queue

ソースを表示

run_queue(
    entity, name
)

エンティティの名前付き RunQueue を返します。

新しい RunQueue を作成するには、wandb.Api().create_run_queue(...) を使用してください。

runs

ソースを表示

runs(
    path: Optional[str] = None,
    filters: Optional[Dict[str, Any]] = None,
    order: str = "+created_at",
    per_page: int = 50,
    include_sweeps: bool = (True)
)

指定されたフィルターに一致するプロジェクトからの一連の run を返します。

フィルターに使用できるフィールドには以下のものがあります:

• createdAt: run が作成されたタイムスタンプ。（ISO 8601 フォーマット、例: “2023-01-01T12:00:00Z”）
• displayName: run の人間が読みやすい表示名。（例: “eager-fox-1”）
• duration: run の合計実行時間（秒単位）。
• group: 関連する run をまとめるために使用されるグループ名。
• host: run が実行されたホスト名。
• jobType: ジョブのタイプまたは run の目的。
• name: run の一意の識別子。（例: “a1b2cdef”）
• state: run の現在の状態。
• tags: run に関連付けられたタグ。
• username: run を開始したユーザーのユーザー名。

さらに、run の設定や要約メトリクス内の項目によるフィルタリングが可能です。例: config.experiment_name, summary_metrics.loss など。

より複雑なフィルタリングには、MongoDB クエリオペレーターを使用できます。詳細は、以下を参照してください: https://docs.mongodb.com/manual/reference/operator/query サポートされている操作には以下のものがあります:

• $and
• $or
• $nor
• $eq
• $ne
• $gt
• $gte
• $lt
• $lte
• $in
• $nin
• $exists
• $regex

例:

設定されている foo という experiment_name を持つ my_project 内の run を見つけます

api.runs(
    path="my_entity/my_project",
    filters={"config.experiment_name": "foo"},
)

設定されている foo または bar という experiment_name を持つ my_project 内の run を見つけます

api.runs(
    path="my_entity/my_project",
    filters={
        "$or": [
            {"config.experiment_name": "foo"},
            {"config.experiment_name": "bar"},
        ]
    },
)

experiment_name が正規表現に一致する my_project 内の run を見つけます（アンカーはサポートされていません）

api.runs(
    path="my_entity/my_project",
    filters={"config.experiment_name": {"$regex": "b.*"}},
)

run の名前が正規表現に一致する my_project 内の run を見つけます（アンカーはサポートされていません）

api.runs(
    path="my_entity/my_project",
    filters={"display_name": {"$regex": "^foo.*"}},
)

実験に “category” というネストされたフィールドを持つ run を探します

api.runs(
    path="my_entity/my_project",
    filters={"config.experiment.category": "testing"},
)

要約メトリクスの model1 下に辞書としてネストされている損失値0.5を持つ run を探します

api.runs(
    path="my_entity/my_project",
    filters={"summary_metrics.model1.loss": 0.5},
)

上昇損失に基づいて my_project 内の run を探します

api.runs(path="my_entity/my_project", order="+summary_metrics.loss")

sweep

ソースを表示

sweep(
    path=""
)

sweep_id の形式でパスを解析することにより、sweep を返します。

sync_tensorboard

ソースを表示

sync_tensorboard(
    root_dir, run_id=None, project=None, entity=None
)

tfevent ファイルを含むローカルディレクトリを wandb に同期します。

team

ソースを表示

team(
    team: str
) -> "public.Team"

指定された名前の Team を返します。

upsert_run_queue

ソースを表示

upsert_run_queue(
    name: str,
    resource_config: dict,
    resource_type: "public.RunQueueResourceType",
    entity: Optional[str] = None,
    template_variables: Optional[dict] = None,
    external_links: Optional[dict] = None,
    prioritization_mode: Optional['public.RunQueuePrioritizationMode'] = None
)

run キュー (launch) をアップサートします。

user

ソースを表示

user(
    username_or_email: str
) -> Optional['public.User']

ユーザー名またはメールアドレスからユーザーを返します。

注意: この関数はローカル管理者のみ機能します。 自分のユーザーオブジェクトを取得しようとしている場合は api.viewer を使用してください。

users

ソースを表示

users(
    username_or_email: str
) -> List['public.User']

部分的なユーザー名またはメールアドレスクエリからすべてのユーザーを返します。

注意: この関数はローカル管理者のみ機能します。 自分のユーザーオブジェクトを取得しようとしている場合は api.viewer を使用してください。