Run - CoreWeave Docs

クラス wandb.apis.public.Run

entity と project に関連付けられた単一の 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 に sweep を含めるかどうか。

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): 現在のサマリーを保持する、変更可能な 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 の履歴に最後にログされたステップを返します。

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	内部プロセスで run からのハートビートが途絶えた状態です。マシンがクラッシュした場合などに発生します。
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 ページにある「Logs」タブに表示されるログと同じものです。このメソッドは、終了した run と実行中の run のどちらについても、そのログを読み取ります。

int

ログを先頭から読み込む際に、1 回のリクエストで取得する行数です。last を指定した場合は無視されます。

int | None

設定すると、ログの末尾 N 行のみを 1 回のリクエストで取得します。実行中の run の状況確認やクラッシュの原因調査に便利です。1 回のリクエストで返される行数にはバックエンド側で上限が設けられているため、上限を超える行数を指定した場合は、最新の行のみに切り詰めて返されます。

CommError: イテレーション中にリクエストが失敗した場合。ログを先頭から読み取るには W&B サーバー 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 は、スケジュールできない可能性のあるジョブ向けに “pending” 状態の run を作成するといった、特定のシナリオでの使用を想定しています (たとえば、GPU が不足している Kubernetes クラスターや、リソースの競合が激しい Kubernetes クラスターの場合など) 。こうした pending 状態の run は、後から再開して W&B で追跡できます。このメソッドで作成した run は、機能が制限されています。この方法で作成した run に対して update() を呼び出すと、想定どおりに動作しない場合があります。

public.Api

W&B API インスタンス。

str | None

run ID (オプション) 。指定しない場合は、ランダムな ID が生成されます。

str | None

プロジェクト名 (オプション) 。デフォルトは API 設定で指定された project、または “uncategorized” です。

str | None

entity (ユーザーまたはチーム) 名 (オプション) 。

Literal['running', 'pending']

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

後で実行する保留中の 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 に関連付けられたアーティファクトを削除するかどうか。

メソッド Run.download_history_exports()

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

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

pathlib.Path | str

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

bool

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

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

メソッド Run.file()

self,
name: 'str'

アーティファクト内にある、指定した名前のファイルのパスを返します。

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) x 軸として使用するメトリクス。デフォルトは _step です

bool

(bool, optional) pandas データフレームを返します

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

config、systemMetrics、summaryMetrics などのサイズの大きいフィールドを含め、run の全データを読み込みます。このメソッドは、run の一覧取得時に lazy=True を使用したものの、特定の run については全データにアクセスする必要がある場合に便利です。

bool

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

メソッド Run.log_artifact()

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

アーティファクトを run の出力として宣言します。

wandb.Artifact

wandb.Api().artifact(name) から返されたアーティファクト。

Collection[str] | None

このアーティファクトに付与するエイリアス。

Collection[str] | None

(list, optional) このアーティファクトに付与するタグ (ある場合)。

メソッド Run.logged_artifacts()

self,
per_page: 'int' = 100

この run でログされたすべてのアーティファクトを取得します。 run 中にログされたすべての出力アーティファクトを取得します。ページネーションされた結果を返します。この結果は反復処理することも、1 つのリストにまとめることもできます。

int

1 回の API リクエストで取得するアーティファクトの数。

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 のすべての履歴レコードを含むイテラブルなコレクションを返します。

list[str] | None

run の履歴から読み取るメトリクスのリストです。スキャンでは、リクエストしたすべてのキーを含む行のみが返されます。キーごとにログされたステップが異なる場合は、キーごとに個別に呼び出すか、この引数を省略してください。キーを指定しない場合は、すべてのメトリクスが返されます。

int

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

int

履歴の読み取りを開始する最小のステップです (この値を含みます) 。

int | None

履歴の読み取りを終了する最大のステップです (この値は含みません) 。

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 を失敗としてマークする場合)

sweep の run は状態を更新できません。 run が取り得る状態の一覧については、Run.state を参照してください。

str

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

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

メソッド Run.upload_file()

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

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

str

アップロードするファイルのパス。絶対パスと相対パスのどちらでも指定できます。

str

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

メソッド Run.use_artifact()

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

アーティファクトを run の入力として宣言します。

wandb.Artifact

wandb.Api().artifact(name) から返されたアーティファクト

str | None

スクリプト内でのアーティファクトの使用方法を識別する string です。ベータ版の wandb Launch 機能が備えるアーティファクトの入れ替え機能を使用する際に、run で使用されるアーティファクトを簡単に区別するために使用します。

メソッド Run.used_artifacts()

self,
per_page: 'int' = 100

この run で明示的に使用されたアーティファクトを取得します。 run 中に使用すると明示的に宣言された入力アーティファクトのみを取得します。宣言は通常、run.use_artifact() で行われます。ページネーションされた結果を返します。この結果は反復処理することも、1 つのリストにまとめることもできます。

int

1 回の API リクエストで取得するアーティファクトの数。

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 が終了するまで、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()