Api

wandb サーバー のクエリに使用されます。

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

例:

初期化の最も一般的な方法

>>> wandb.Api()

メソッド

artifact

View source

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

project/name または entity/project/name の形式でパスを解析して、単一の artifact を返します。

注:

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

artifact_collection

View source

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

型で単一の artifact collection を返し、entity/project/name の形式でパスを解析します。

artifact_collection_exists

View source

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

artifact collection が指定された project および entity 内に存在するかどうかを返します。

artifact_collections

View source

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

一致する artifact collection の collection を返します。

artifact_exists

View source

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

artifact バージョンが指定された project および entity 内に存在するかどうかを返します。

artifact_type

View source

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

一致する ArtifactType を返します。

artifact_types

View source

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

一致する artifact 型の collection を返します。

artifact_versions

View source

artifact_versions(
    type_name, name, per_page=50
)

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

artifacts

View source

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

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

create_project

View source

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

新しい project を作成します。

create_run

View source

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

新しい run を作成します。

create_run_queue

View source

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 queue (Launch) を作成します。

create_team

View source

create_team(
    team, admin_username=None
)

新しい team を作成します。

create_user

View source

create_user(
    email, admin=(False)
)

新しい user を作成します。

flush

View source

flush()

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

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

from_path

View source

from_path(
    path
)

パスから run、sweep、project、または report を返します。

例:

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

View source

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

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

list_jobs

View source

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

指定された entity および project のジョブ (存在する場合) のリストを返します。

project

View source

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

指定された名前 (および指定された場合は entity) を持つ Project を返します。

projects

View source

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

指定された entity の projects を取得します。

queued_run

View source

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

パスに基づいて、単一の queue に入れられた run を返します。

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

registries

View source

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

Registry イテレーターを返します。

イテレーターを使用して、組織の registry 全体で registry、collection、または artifact バージョンを検索およびフィルタリングします。

例:

名前に “model” が含まれるすべての registry を検索します

import wandb

api = wandb.Api()  # entity が複数の org に属している場合は org を指定します
api.registries(filter={"name": {"$regex": "model"}})

名前が “my_collection” でタグが “my_tag” の registry 内のすべての collection を検索します

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

名前が “my_collection” を含み、エイリアスが “best” のバージョンを持つ registry 内のすべての artifact バージョンを検索します

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

“model” を含み、タグ “prod” またはエイリアス “best” を持つ registry 内のすべての artifact バージョンを検索します

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

reports

View source

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

指定された project パスの reports を取得します。

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

run

View source

run(
    path=""
)

entity/project/run_id の形式でパスを解析して、単一の run を返します。

run_queue

View source

run_queue(
    entity, name
)

entity の名前付き RunQueue を返します。

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

runs

View source

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

指定されたフィルターに一致する project から 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 または summary metrics の項目でフィルタリングできます。 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

例:

config.experiment_name が “foo” に設定されている my_project で run を検索します

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

config.experiment_name が “foo” または “bar” に設定されている my_project で run を検索します

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

config.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.*"}},
)

config.experiment に値 “testing” を持つネストされたフィールド “category” が含まれている my_project で run を検索します

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

summary metrics の model1 の下の辞書にネストされた損失値が 0.5 の my_project で 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

View source

sweep(
    path=""
)

entity/project/sweep_id の形式でパスを解析して sweep を返します。

sync_tensorboard

View source

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

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

team

View source

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

指定された名前を持つ一致する Team を返します。

upsert_run_queue

View source

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 queue (Launch) をアップサートします。

user

View source

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

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

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

users

View source

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

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

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