Run - Weights & Biases Documentation

クラス wandb.apis.public.Run

entity と project に関連付けられた 1 つの run。

(service_api: 'ServiceApi',
entity: 'str',
project: 'str',
run_id: 'str',
attrs: 'Mapping | None' = None,
include_sweeps: 'bool' = False,
lazy: 'bool' = True,
api_key: 'str | None' = None)

引数

ServiceApi

この run の W&B API 呼び出しを実行する wandb-core サービスへのインターフェースです。

str

run に関連付けられた entity です。

str

run に関連付けられた project です。

str

run の一意の ID です。

Mapping | None

run の属性です。

bool

run に sweeps を含めるかどうかです。

bool

説明はありません。

str | None

説明はありません。

属性

tags ([str]): run に関連付けられているタグのリスト
url (str): この run の URL
id (str): run の一意の ID (デフォルトは 8 文字)
name (str): run の名前
state (str): 次のいずれか: running, finished, crashed, killed, preempting, preempted
config (dict): run に関連付けられているハイパーパラメーターの dict
created_at (str): run が開始された日時を示す ISO タイムスタンプ
system_metrics (dict): run について記録された最新のシステムメトリクス
summary (dict): 現在の summary を保持する、変更可能な dict 風のプロパティです。update を呼び出すと、変更内容が永続化されます。
project (str): run に関連付けられている project
entity (str): run に関連付けられている entity の名前
project_internal_id (int): project の内部 ID
user (str): run を作成したユーザーの名前
path (str): 一意の ID [entity]/[project]/[run_id]
notes (str): run に関するメモ
read_only (boolean): run を編集可能かどうか
history_keys (str): wandb.Run.log({"key": "value"}) でログされた履歴メトリクスのキー
metadata (str): wandb-metadata.json に含まれる run のメタデータ

プロパティ

dict[str, Any]

run 設定を取得します。遅延モードの場合は、完全なデータを自動的に読み込みます。

str

run に関連付けられている entity です。

str

run の一意の ID です。

int

run の履歴にログされた最後の step を返します。

dict[str, Any] | None

wandb-metadata.json に含まれる run のメタデータです。メタデータには、run の説明、タグ、開始時刻、メモリ使用量などが含まれます。

str | None

run の名前です。

list[str]

run のパスです。パスは entity、project、run_id を含むリストです。

dict[str, Any]

内部キーを含む生の run 設定を取得します。遅延モードの場合は、完全なデータを自動的に読み込みます。

str

run の状態です。次の表は、run が取り得る状態を示しています。

状態	説明
Crashed	マシンのクラッシュなどにより、内部プロセスからのハートビート送信が停止した状態です。
Failed	Run がゼロ以外の終了ステータスで終了した状態です。
Finished	Run が終了し、データの同期が完了した、または `wandb.Run.finish()` が呼び出された状態です。
Killed	完了前に Run が強制的に停止された状態です。
Running	Run は現在も実行中で、直近でハートビートを送信しています。
Pending	Run はスケジュールされていますが、まだ開始されていない状態です (sweep や Launch job で一般的です) 。

str

run の一意のストレージ ID です。

HTTPSummary

run のサマリーメトリクスを取得します。遅延モードの場合は、完全なデータを自動的に読み込みます。

dict[str, Any]

run のサマリーメトリクスを取得します。遅延モードの場合は、完全なデータを自動的に読み込みます。

public.Sweep | None

この run に関連付けられている sweep です。include_sweeps が False の場合、sweep データを読み込みます。

str | None

sweep 名を取得します。sweepName は軽量フラグメントに含まれているため、常に利用できます。

dict[str, Any]

run のシステムメトリクスを取得します。遅延モードの場合は、完全なデータを自動的に読み込みます。

str

run の URL です。run の URL は entity、project、run_id から生成されます。 SaaS ユーザーの場合、https://wandb.ai/entity/project/run_id 形式になります。

str

この API は非推奨です。代わりに entity を使用してください。

メソッド

メソッド Run.beta_scan_history()

self,
keys: 'list[str] | None' = None,
page_size: 'int' = 1000,
min_step: 'int' = 0,
max_step: 'int | None' = None,
use_cache: 'bool' = True

引数

list[str] | None

説明はありません。

int

説明はありません。

int

説明はありません。

int | None

説明はありません。

bool

説明はありません。

メソッド Run.console_logs()

self, *,
per_page: 'int' = 1000,
last: 'int | None' = None

run によって取得されたコンソール出力を返します。 run の実行中、W&B はそのプロセスが stdout および stderr に書き込む内容を取得し、run のコンソールログとして記録します。これは、W&B App の Run page の「Logs」タブに表示されるログと同じです。 finished の run と実行中の run のいずれについても、このログを読み取れます。

引数

int

ログを先頭から読み取る際、リクエストごとに取得する行数。last が指定されている場合は無視されます。

int | None

指定した場合、1 回のリクエストでログの末尾 N 行のみを取得します。実行中の run の確認やクラッシュの診断に役立ちます。バックエンドでは 1 回のリクエストで返せる行数に上限があるため、より多くの行を指定すると、最新の行に切り詰められて返されます。

送出される例外

CommError: 反復処理中にリクエストが失敗した場合に発生します。ログを先頭から読み取るには、W&B Server 0.77 以降が必要です。古いサーバーでは、代わりに末尾の N 行を読み取ってください。

例

import wandb

run = wandb.Api().run("entity/project/run_id")

# ログ全体を古い行から順に読み取ります。
for line in run.console_logs():
    print(line.content)

# 末尾の 100 行のみを読み取ります。
for line in run.console_logs(last=100):
    print(line.timestamp, line.content)

メソッド Run.create()

api: 'public.Api',
run_id: 'str | None' = None,
project: 'str | None' = None,
entity: 'str | None' = None,
state: "Literal['running', 'pending']" = 'running'

指定されたprojectに対して run を作成します。ほとんどのユースケースでは、wandb.init() を使用してください。wandb.init() のほうが、run の作成と更新をより堅牢に処理できます。wandb.apis.public.Run.create は、スケジュールできない可能性があるジョブ (たとえば、GPU が不足している Kubernetes クラスター内のジョブや、競合が激しいジョブ) に対して “pending” 状態の run を作成する場合など、特定のシナリオ向けです。これらの pending run は、後で再開して W&B でトラッキングできます。このメソッドで作成された run には機能上の制限があります。この方法で作成した run に対して update() を呼び出しても、期待どおりに動作しない場合があります。

引数

public.Api

W&B API のインスタンス。

str | None

省略可能な run ID。指定しない場合は、ランダムな ID が生成されます。

str | None

省略可能なプロジェクト名。デフォルトでは、API Settings の project または “uncategorized” が使用されます。

str | None

省略可能な entity (ユーザーまたはチーム) 名。

Literal['running', 'pending']

run の初期状態。後で再開する run には “pending” を、すぐに実行する run には “running” を使用します。

例

後で実行するための pending run を作成する

import wandb

api = wandb.Api()

run_name = "my-pending-run"

run = Run.create(
    api=api,
    project="project",
    entity="entity",
    state="pending",
    run_id=run_name,
)

メソッド Run.delete()

self,
delete_artifacts: 'bool' = False

指定されたrunをwandbバックエンドから削除します。

引数

bool

runに関連付けられたartifactも削除するかどうか。

メソッド Run.download_history_exports()

self,
download_dir: 'pathlib.Path | str',
require_complete_history: 'bool' = True

run の parquet 形式の履歴ファイルをすべて、指定したディレクトリにダウンロードします。

引数

pathlib.Path | str

履歴ファイルのダウンロード先ディレクトリ。

bool

完全な履歴のダウンロードを必須にするかどうか。true の場合、run にまだ parquet ファイルへエクスポートされていないデータが含まれていると、IncompleteRunHistoryError が発生します。

送出される例外

IncompleteRunHistoryError: require_complete_history が True で、run にまだ parquet ファイルへエクスポートされていないデータが含まれている場合。
WandbApiFailedError: 履歴が不完全な場合以外の理由で API リクエストが失敗した場合。

メソッド Run.file()

self,
name: 'str'

artifact 内で、指定した名前のファイルのパスを返します。

引数

str

取得するファイルの名前。

メソッド Run.files()

self,
names: 'list[str] | None' = None,
pattern: 'str | None' = None,
per_page: 'int' = 50

指定した条件に一致する run 内のすべてのファイルに対応する Files オブジェクトを返します。一致対象として、完全なファイル名のリストまたはパターンを指定できます。両方を指定した場合、パターンは無視されます。

引数

list[str] | None

取得するファイル名のリスト。空の場合はすべてのファイルを返します

str | None

W&B からファイルを返す際に使用するマッチングパターンです。このパターンには mySQL の LIKE 構文を使用します。たとえば、.json で終わるすべてのファイルに一致させるには %.json を指定します。names と pattern の両方を指定すると、ValueError が発生します。

int

1 ページあたりの結果数。

メソッド Run.history()

self,
samples: 'int' = 500,
keys: 'list[str] | None' = None,
x_axis: 'str' = '_step',
pandas: 'bool' = True,
stream: "Literal['default', 'system']" = 'default'

run のサンプリングされた履歴メトリクスを返します。履歴レコードがサンプリングされていても問題なければ、この方法のほうがシンプルで高速です。

引数

int

(int, optional) 返すサンプルの数

list[str] | None

(list, optional) 指定したキーのメトリクスのみを返します

str

(str, optional) このメトリクスを xAxis として使用します。デフォルトは _step です

bool

(bool, optional) pandas dataframe を返します

Literal['default', 'system']

(str, optional) メトリクスには “default”、マシンメトリクスには “system” を指定します

メソッド Run.load()

self,
force: 'bool' = False

遅延モードに応じた適切なフラグメントを使用して run データを読み込みます。

引数

bool

True の場合、すでに読み込み済みであっても、サーバーから run データを再取得します。

送出される例外

RunNotFoundError: run が見つからない場合、または run のデータを読み込めない場合。

メソッド Run.load_full_data()

self,
force: 'bool' = False

設定、systemMetrics、summaryMetrics などの重いフィールドを含む run の完全なデータを読み込みます。このメソッドは、Runs を一覧表示する際に最初に lazy=True を指定したものの、特定の run について完全なデータにアクセスする必要がある場合に便利です。

引数

bool

データがすでに読み込まれている場合でも強制的に再読み込みします

メソッド Run.log_artifact()

self,
artifact: 'wandb.Artifact',
aliases: 'Collection[str] | None' = None,
tags: 'Collection[str] | None' = None

artifact を run の出力として宣言します。

引数

wandb.Artifact

wandb.Api().artifact(name) から返されるArtifact。

Collection[str] | None

このArtifact に適用するエイリアス。

Collection[str] | None

(リスト、省略可) このArtifact に適用するタグ。

メソッド Run.logged_artifacts()

self,
per_page: 'int' = 100

この run によってログされたすべての artifact を取得します。 run の実行中にログされたすべての出力 artifact を取得します。反復処理することも、1 つのリストにまとめることもできる、ページ分割された結果を返します。

引数

int

API リクエストごとに取得する artifact の数。

例

import wandb
import tempfile

with tempfile.NamedTemporaryFile(mode="w", delete=False, suffix=".txt") as tmp:
    tmp.write("This is a test artifact")
    tmp_path = tmp.name
run = wandb.init(project="artifact-example")
artifact = wandb.Artifact("test_artifact", type="dataset")
artifact.add_file(tmp_path)
run.log_artifact(artifact)
run.finish()

api = wandb.Api()

finished_run = api.run(f"{run.entity}/{run.project}/{run.id}")

for logged_artifact in finished_run.logged_artifacts():
    print(logged_artifact.name)

メソッド Run.save()

self

run オブジェクトへの変更を W&B バックエンドに保存します。

メソッド Run.scan_history()

self,
keys: 'list[str] | None' = None,
page_size: 'int' = 1000,
min_step: 'int' = 0,
max_step: 'int | None' = None,
use_cache: 'bool' = True

run のすべての履歴レコードを反復処理できる iterable なコレクションを返します。

引数

list[str] | None

run の履歴から読み取るメトリクスのリストです。scan は、要求されたすべての keys を含む行のみを返します。keys が異なる step でログされた場合は、key ごとに個別の Call を使用するか、この引数を省略してください。keys が指定されていない場合は、すべてのメトリクスを返します。

int

一度に読み取る履歴レコード数です。

int

履歴の読み取りを開始する最小の step (この値を含む) です。

int | None

履歴を読み取る最大の step (この値は含まない) です。

bool

True に設定すると、WANDB_CACHE_DIR に run の履歴があるか確認します。キャッシュ内に run の履歴が見つからない場合は、サーバーからダウンロードされます。False に設定すると、run の履歴は毎回ダウンロードされます。

メソッド Run.stop()

self

この run が正常に停止するようリクエストします。これにより、W&B バックエンドで run の停止フラグが設定されます。これは、W&B App UI の “Stop run” ボタンによって送信されるシグナルと同じものです。run を実行しているプロセスは、通常のハートビートを通じてこのフラグを検知し、run を正常にシャットダウンします。そのため、リモートの run (たとえば Kubernetes pod 上の run) を終了する場合にも安全です。停止は非同期です。このメソッドは、run が終了した時点ではなく、バックエンドで run にフラグが設定された時点で返ります。再度呼び出しても、またはすでに実行されていない run に対して呼び出しても、効果はありません。

送出される例外

wandb.Error: リクエストに失敗した場合。

例

import wandb

run = wandb.Api().run("entity/project/run_id")
run.stop()

メソッド Run.to_html()

self,
height: 'int' = 420,
hidden: 'bool' = False

このrunを表示するiframeを含むHTMLを生成します。

引数

int

説明はありません。

bool

説明はありません。

メソッド Run.update()

self

run オブジェクトへの変更を wandb バックエンドに保存します。

メソッド Run.update_state()

self,
state: 'str'

run の状態を更新します。サポートされる遷移:

running、failed、crashed、または preempted から pending へ (例: 終了した run または進行中の run をキューに入れ直す)
- pending または running から failed へ (例: プリエンプトされた run または失われた run を failed としてマークする)

sweep の run の状態は更新できません。可能な run の状態の一覧については Run.state を参照してください。

引数

str

遷移先の run の状態です。"pending" または "failed" のいずれかです。

送出される例外

wandb.Error: 要求された状態遷移が許可されていない場合、またはサーバーがこの操作をサポートしていない場合。

メソッド Run.upload_file()

self,
path: 'str',
root: 'str' = '.'

ローカルファイルを W&B にアップロードし、この run に関連付けます。

引数

str

アップロードするファイルのパス。絶対パスまたは相対パスを指定できます。

str

ファイルの保存先の基準となるルートパス。たとえば、ファイルを run 内で “my_dir/file.txt” として保存し、現在 “my_dir” にいる場合は、root を ”../” に設定します。デフォルトは現在のディレクトリ (”.”) です。

メソッド Run.use_artifact()

self,
artifact: 'wandb.Artifact',
use_as: 'str | None' = None

artifact を run の入力として宣言します。

引数

wandb.Artifact

wandb.Api().artifact(name) が返す artifact

str | None

スクリプト内で artifact の使用方法を識別する文字列。ベータ版の wandb Launch の artifact スワップ機能を使用する際に、run で使用される artifact を簡単に区別するために使われます。

メソッド Run.used_artifacts()

self,
per_page: 'int' = 100

この run で明示的に使用された artifact を取得します。通常は run.use_artifact() を使用して、run 中に使用すると明示的に宣言された入力 artifact のみを取得します。イテレートすることも、1 つの list にまとめることもできる、ページ分割された結果を返します。

引数

int

API リクエストごとに取得する artifact の数。

例

import wandb

run = wandb.init(project="artifact-example")
run.use_artifact("test_artifact:latest")
run.finish()

api = wandb.Api()
finished_run = api.run(f"{run.entity}/{run.project}/{run.id}")
for used_artifact in finished_run.used_artifacts():
    print(used_artifact.name)
test_artifact

メソッド Run.wait_until_finished()

self

run が完了するまで、その状態を確認します。

​クラス wandb.apis.public.Run

​引数

​属性

​プロパティ

​メソッド

​メソッド Run.beta_scan_history()

引数

​メソッド Run.console_logs()

引数

送出される例外

例

​メソッド Run.create()

引数

例

​メソッド Run.delete()

引数

​メソッド Run.download_history_exports()

引数

送出される例外

​メソッド Run.file()

引数

​メソッド Run.files()

引数

​メソッド Run.history()

引数

​メソッド Run.load()

引数

送出される例外

​メソッド Run.load_full_data()

引数

​メソッド Run.log_artifact()

引数

​メソッド Run.logged_artifacts()

引数

例

​メソッド Run.save()

​メソッド Run.scan_history()

引数

​メソッド Run.stop()

送出される例外

例

​メソッド Run.to_html()

引数

​メソッド Run.update()

​メソッド Run.update_state()

引数

送出される例外

​メソッド Run.upload_file()

引数

​メソッド Run.use_artifact()

引数

​メソッド Run.used_artifacts()

引数

例

​メソッド Run.wait_until_finished()

クラス wandb.apis.public.Run

引数

属性

プロパティ

メソッド

メソッド Run.beta_scan_history()

メソッド Run.console_logs()

メソッド Run.create()

メソッド Run.delete()

メソッド Run.download_history_exports()

メソッド Run.file()

メソッド Run.files()

メソッド Run.history()

メソッド Run.load()

メソッド Run.load_full_data()

メソッド Run.log_artifact()

メソッド Run.logged_artifacts()

メソッド Run.save()

メソッド Run.scan_history()

メソッド Run.stop()

メソッド Run.to_html()

メソッド Run.update()

メソッド Run.update_state()

メソッド Run.upload_file()

メソッド Run.use_artifact()

メソッド Run.used_artifacts()

メソッド Run.wait_until_finished()