View the source code
例:
最も一般的な初期化方法引数 | Description |
---|---|
overrides | (dict) https://api.wandb.ai 以外の wandb サーバーを使用している場合に base_url を設定できます。また、entity 、project 、および run のデフォルト設定をすることができます。 |
属性 | Description |
---|
メソッド
artifact
ソースを表示
project/name
または entity/project/name
の形式でパスを解析することにより、単一のアーティファクトを返します。
引数 | Description |
---|---|
name | (str) アーティファクト名。project/ または entity/project/ で始まる場合があります。name に entity が指定されていない場合、Run または API 設定の entity が使用されます。有効な名前は次の形式になります: name:version name:alias |
type | (str, オプション) 取得するアーティファクトのタイプ。 |
戻り値 | Description |
---|---|
Artifact オブジェクト。 |
例外 | Description |
---|---|
ValueError | アーティファクト名が指定されていない場合。 |
ValueError | アーティファクトタイプが指定されているが、取得したアーティファクトのタイプと一致しない場合。 |
注意:
このメソッドは外部利用のみを目的としています。wandb リポジトリコード内でapi.artifact()
を呼び出さないでください。
artifact_collection
ソースを表示
entity/project/name
の形式でパスを解析することにより、単一のアーティファクトコレクションを返します。
引数 | Description |
---|---|
type_name | (str) 取得するアーティファクトコレクションのタイプ。 |
name | (str) アーティファクトコレクション名。entity/project で始まる場合があります。 |
戻り値 | Description |
---|---|
ArtifactCollection オブジェクト。 |
artifact_collection_exists
ソースを表示
引数 | Description |
---|---|
name | (str) アーティファクトコレクション名。entity/project で始まる場合があります。entity または project が指定されていない場合、オーバーライドパラメーターから推測されます。その他の場合、entity はユーザー設定から取得され、project は “uncategorized” にデフォルト設定されます。 |
type | (str) アーティファクトコレクションのタイプ |
戻り値 | Description |
---|---|
アーティファクトコレクションが存在する場合は True、そうでない場合は False。 |
artifact_collections
ソースを表示
引数 | Description |
---|---|
project_name | (str) フィルタリングするプロジェクトの名前。 |
type_name | (str) フィルタリングするアーティファクトタイプの名前。 |
per_page | (int, オプション) クエリのページネーションのページサイズを設定します。None はデフォルトサイズを使用します。通常、これを変更する理由はありません。 |
戻り値 | Description |
---|---|
イテラブルな ArtifactCollections オブジェクト。 |
artifact_exists
ソースを表示
引数 | Description |
---|---|
name | (str) アーティファクト名。entity/project で始まる場合があります。entity または project が指定されていない場合、オーバーライドパラメータから推測されます。その他の場合、entity はユーザー設定から取得され、project は “uncategorized” にデフォルト設定されます。有効な名前は次の形式になります: name:version name:alias |
type | (str, オプション) アーティファクトのタイプ |
戻り値 | Description |
---|---|
アーティファクトバージョンが存在する場合は True、そうでない場合は False。 |
artifact_type
ソースを表示
ArtifactType
を返します。
引数 | Description |
---|---|
type_name | (str) 取得するアーティファクトタイプの名前。 |
project | (str, オプション) 指定されている場合、フィルタリングするプロジェクト名またはパス。 |
戻り値 | Description |
---|---|
ArtifactType オブジェクト。 |
artifact_types
ソースを表示
引数 | Description |
---|---|
project | (str, オプション) 指定されている場合、フィルタリングするプロジェクト名またはパス。 |
戻り値 | Description |
---|---|
イテラブルな ArtifactTypes オブジェクト。 |
artifact_versions
ソースを表示
artifacts(type_name, name)
を使用してください。
artifacts
ソースを表示
Artifacts
コレクションを返します。
引数 | Description |
---|---|
type_name | (str) 取得するアーティファクトのタイプ。 |
name | (str) アーティファクトコレクションの名前。entity/project で始まる場合があります。 |
per_page | (int, オプション) クエリのページネーションのページサイズを設定します。None はデフォルトサイズを使用します。通常、これを変更する理由はありません。 |
tags | (list[str], オプション) これらのタグがすべて含まれているアーティファクトのみを返します。 |
戻り値 | Description |
---|---|
イテラブルな Artifacts オブジェクト。 |
create_project
ソースを表示
引数 | Description |
---|---|
name | (str) 新しいプロジェクトの名前。 |
entity | (str) 新しいプロジェクトのエンティティ。 |
create_run
ソースを表示
引数 | Description |
---|---|
run_id | (str, オプション) 指定された場合、run に割り当てられる ID。run ID はデフォルトで自動生成されますので、通常はこれを指定する必要はありません。指定する場合はリスクを負ってください。 |
project | (str, オプション) 指定された場合、新しい run のプロジェクト。 |
entity | (str, オプション) 指定された場合、新しい run のエンティティ。 |
戻り値 | Description |
---|---|
新たに作成された Run 。 |
create_run_queue
ソースを表示
引数 | Description |
---|---|
name | (str) 作成するキューの名前 |
type | (str) キューに使用されるリソースのタイプ。“local-container”、“local-process”、“kubernetes”、“sagemaker”、または “gcp-vertex” のいずれか。 |
entity | (str) キューを作成するエンティティのオプションの名前。None の場合、設定されたまたはデフォルトのエンティティが使用されます。 |
prioritization_mode | (str) オプションのプライオリティバージョン。“V0” または None |
config | (dict) キューに使用されるデフォルトのリソース設定のオプション。テンプレート変数を指定するにはハンドルバー(例:{{var}} )を使用します。 |
template_variables | (dict) 設定内で使用されるテンプレート変数のスキーマの辞書。期待される形式: { "var-name": { "schema": { "type": ("string", "number", or "integer"), "default": (optional value), "minimum": (optional minimum), "maximum": (optional maximum), "enum": [..."(options)"] } } } |
戻り値 | Description |
---|---|
新しく作成された RunQueue |
例外 | Description |
---|---|
ValueError: パラメーターのいずれかが無効な場合 wandb.Error: wandb API のエラー |
create_team
ソースを表示
引数 | Description |
---|---|
team | (str) チーム名 |
admin_username | (str) チームの管理ユーザーのオプションのユーザー名、デフォルトは現在のユーザーです。 |
戻り値 | Description |
---|---|
Team オブジェクト |
create_user
ソースを表示
引数 | Description |
---|---|
email | (str) ユーザーのメールアドレス |
admin | (bool) このユーザーがグローバルインスタンス管理者であるかどうか |
戻り値 | Description |
---|---|
User オブジェクト |
flush
ソースを表示
api.flush()
を使用してローカルキャッシュをクリアし、run に関連付けられた最新の値を取得します。
from_path
ソースを表示
例:
引数 | Description |
---|---|
path | (str) プロジェクト、run、sweep、またはレポートへのパス |
戻り値 | Description |
---|---|
Project 、Run 、Sweep 、または BetaReport インスタンス。 |
例外 | Description |
---|---|
wandb.Error: パスが無効、またはオブジェクトが存在しない場合 |
job
ソースを表示
Job
を返します。
引数 | Description |
---|---|
name | (str) ジョブの名前。 |
path | (str, オプション) 指定された場合、ジョブアーティファクトをダウンロードするルートパス。 |
戻り値 | Description |
---|---|
Job オブジェクト。 |
list_jobs
ソースを表示
引数 | Description |
---|---|
entity | (str) リストされたジョブのエンティティ。 |
project | (str) リストされたジョブのプロジェクト。 |
戻り値 | Description |
---|---|
一致するジョブのリスト。 |
project
ソースを表示
Project
を返します。
引数 | Description |
---|---|
name | (str) プロジェクト名。 |
entity | (str) リクエストされたエンティティ名。None の場合、Api に渡されたデフォルトのエンティティにフォールバックします。デフォルトのエンティティがない場合は、ValueError をスローします。 |
戻り値 | Description |
---|---|
Project オブジェクト。 |
projects
ソースを表示
引数 | Description |
---|---|
entity | (str) リクエストされたエンティティ名。None の場合、Api に渡されたデフォルトのエンティティにフォールバックします。デフォルトのエンティティがない場合は、ValueError をスローします。 |
per_page | (int) クエリのページネーションのページサイズを設定します。None はデフォルトサイズを使用します。通常、これを変更する理由はありません。 |
戻り値 | Description |
---|---|
Projects オブジェクトで、Project オブジェクトのイテラブルなコレクションです。 |
queued_run
ソースを表示
entity/project/queue_id/run_queue_item_id
の形式のパスを解析します。
registries
ソースを表示
例:
“model” を含む名前のすべてのレジストリを見つけます。引数 | Description |
---|---|
organization | (str, オプション) 取得するレジストリの組織。指定されていない場合、ユーザー設定で指定された組織を使用します。 |
filter | (dict, オプション) レジストリイテレータ内の各オブジェクトに適用する MongoDB スタイルのフィルタ。コレクションをフィルタリングする際に利用可能なフィールド: name , description , created_at , updated_at 。コレクションをフィルタリングする際に利用可能なフィールド: name , tag , description , created_at , updated_at 。バージョンをフィルタリングする際に利用可能なフィールド: tag , alias , created_at , updated_at , metadata |
戻り値 | Description |
---|---|
レジストリのイテレータ。 |
reports
ソースを表示
引数 | Description |
---|---|
path | (str) レポートが存在するプロジェクトのパス、形式は: “entity/project” となります。 |
name | (str, オプション) リクエストされたレポートのオプションの名前。 |
per_page | (int) クエリのページネーションのページサイズを設定します。None はデフォルトサイズを使用します。通常、これを変更する理由はありません。 |
戻り値 | Description |
---|---|
Reports オブジェクトで、BetaReport オブジェクトのイテラブルなコレクションです。 |
run
ソースを表示
entity/project/run_id
の形式でパスを解析することにより、単一の run を返します。
引数 | Description |
---|---|
path | (str) entity/project/run_id 形式の run へのパス。api.entity が設定されている場合、この形式は project/run_id となり、api.project が設定されている場合、run_id のみです。 |
戻り値 | Description |
---|---|
Run オブジェクト。 |
run_queue
ソースを表示
RunQueue
を返します。
新しい RunQueue
を作成するには、wandb.Api().create_run_queue(...)
を使用してください。
runs
ソースを表示
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 を開始したユーザーのユーザー名。
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 を見つけます引数 | Description |
---|---|
path | (str) プロジェクトへのパス。形式は: “entity/project” |
filters | (dict) MongoDB クエリ言語を使用して特定の run をクエリします。run のプロパティ(config.key、summary_metrics.key、state、entity、createdAt など)でフィルタリングできます。例: {"config.experiment_name": "foo"} は、実験名に foo が設定されている run を見つけます。 |
order | (str) 並び順は created_at 、heartbeat_at 、config.*.value 、summary_metrics.* にできます。order の前に + を付けると昇順になります。order の前に - を付けると降順(デフォルト)になります。デフォルトの並び順は、run の created_at で、古い順から新しい順です。 |
per_page | (int) クエリのページネーションのページサイズを設定します。 |
include_sweeps | (bool) 結果に sweep run を含めるかどうか。 |
戻り値 | Description |
---|---|
Runs オブジェクトで、Run オブジェクトのイテラブルなコレクションです。 |
sweep
ソースを表示
sweep_id
の形式でパスを解析することにより、sweep を返します。
引数 | Description |
---|---|
path | (str, オプション) エンティティまたはプロジェクトの設定がされていない場合、sweep に対するパスの形式は entity/project/sweep_id である必要があります。api.entity が設定されている場合、この形式は project/sweep_id になり、api.project が設定されている場合、sweep_id のみです。 |
戻り値 | Description |
---|---|
Sweep オブジェクト。 |
sync_tensorboard
ソースを表示
team
ソースを表示
Team
を返します。
引数 | Description |
---|---|
team | (str) チーム名。 |
戻り値 | Description |
---|---|
Team オブジェクト。 |
upsert_run_queue
ソースを表示
引数 | Description |
---|---|
name | (str) 作成するキューの名前 |
entity | (str) 作成するキューのエンティティのオプションの名前。None の場合、設定されたまたはデフォルトのエンティティを使用します。 |
resource_config | (dict) キューに使用されるデフォルトのリソース設定のオプション。テンプレート変数を指定するにはハンドルバー(例:{{var}} )を使用します。 |
resource_type | (str) キューに使用されるリソースのタイプ。“local-container”、“local-process”、“kubernetes”、“sagemaker”、または “gcp-vertex” のいずれか。 |
template_variables | (dict) 設定内で使用されるテンプレート変数のスキーマの辞書。期待される形式: { "var-name": { "schema": { "type": ("string", "number", or "integer"), "default": (optional value), "minimum": (optional minimum), "maximum": (optional maximum), "enum": [..."(options)"] } } } |
external_links | (dict) キューで使用される外部リンクのオプションの辞書。期待される形式: { "name": "url" } |
prioritization_mode | (str) 使用するプライオリティのバージョン。 “V0” または None |
戻り値 | Description |
---|---|
アップサートされた RunQueue 。 |
例外 | Description |
---|---|
ValueError: パラメーターのいずれかが無効な場合 wandb.Error: wandb API のエラー |
user
ソースを表示
api.viewer
を使用してください。
引数 | Description |
---|---|
username_or_email | (str) ユーザーのユーザー名またはメールアドレス |
戻り値 | Description |
---|---|
User オブジェクトまたはユーザーが見つからない場合は None |
users
ソースを表示
api.viewer
を使用してください。
引数 | Description |
---|---|
username_or_email | (str) 検索したいユーザーのプレフィックスまたはサフィックス |
戻り値 | Description |
---|---|
User オブジェクトの配列 |
クラス変数 | Description |
---|---|
CREATE_PROJECT | |
DEFAULT_ENTITY_QUERY | |
USERS_QUERY | |
VIEWER_QUERY |