> ## Documentation Index
> Fetch the complete documentation index at: https://docs.coreweave.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Run
export const GitHubLink = ({url, compact = false}) =>
{compact ? "View source" : <>
GitHub source
}
;
この run の W\&B API 呼び出しを実行する wandb-core サービスへのインターフェースです。
run に関連付けられた entity です。
run に関連付けられた project です。
run の一意の ID です。
run の属性です。
run に sweep を含めるかどうか。
説明はありません。
説明はありません。
属性
* `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 のメタデータ
プロパティ
run 設定を取得します。遅延モードの場合は、完全なデータを自動的に読み込みます。
run に関連付けられた entity。
run の一意の ID。
run の履歴に最後にログされたステップを返します。
wandb-metadata.json から取得した run のメタデータ。
メタデータには、run の説明、タグ、開始時刻、メモリ
使用量などが含まれます。
run の名前。
run のパス。entity、project、run\_id を要素とするリストです。
内部キーを含む未加工の run 設定を取得します。遅延モードの場合は、完全なデータを自動的に読み込みます。
run の状態。
次の表に、run が取りうる状態を示します。
| 状態 | 説明 |
| - | - |
| Crashed | 内部プロセスで run からのハートビートが途絶えた状態です。マシンがクラッシュした場合などに発生します。 |
| Failed | run がゼロ以外の終了ステータスで終了しました。 |
| Finished | run が終了してデータの同期が完了したか、`wandb.Run.finish()` が呼び出されました。 |
| Killed | run が完了する前に強制停止されました。 |
| Running | run は実行中で、直近にハートビートを送信しています。 |
| Pending | run はスケジュール済みですが、まだ開始されていません (sweep や Launch job でよく見られます)。 |
run の一意のストレージ ID。
run のサマリー メトリクスを取得します。遅延モードの場合は、完全なデータを自動的に読み込みます。
run のサマリー メトリクスを取得します。遅延モードの場合は、完全なデータを自動的に読み込みます。
この run に関連付けられた sweep。include\_sweeps が False の場合は sweep データを読み込みます。
sweep 名を取得します。sweepName は軽量フラグメントに含まれているため、常に取得できます。
run のシステムメトリクスを取得します。遅延モードの場合は、完全なデータを自動的に読み込みます。
run の URL。
run の URL は entity、project、run\_id から生成されます。
SaaS ユーザーの場合、`https://wandb.ai/entity/project/run_id` の形式になります。
この API は非推奨です。代わりに `entity` を使用してください。
```python theme={"system"}
self, *,
per_page: 'int' = 1000,
last: 'int | None' = None
```
run で取得されたコンソール出力を返します。
run の実行中、W\&B はそのプロセスが
stdout と stderr に書き込んだ内容を取得し、run のコンソールログとして記録します。これは
W\&B App の run ページにある「Logs」タブに表示されるログと同じものです。
このメソッドは、終了した run と実行中の run の
どちらについても、そのログを読み取ります。
引数
ログを先頭から読み込む際に、1 回のリクエストで取得する行数です。`last` を指定した場合は無視されます。
設定すると、ログの末尾 N 行のみを 1 回のリクエストで取得します。実行中の run の状況確認やクラッシュの原因調査に便利です。1 回のリクエストで返される行数にはバックエンド側で上限が設けられているため、上限を超える行数を指定した場合は、最新の行のみに切り詰めて返されます。
送出される例外
* `CommError`: イテレーション中にリクエストが失敗した場合。ログを先頭から読み取るには W\&B サーバー 0.77 以降が必要です。それより古いサーバーでは、代わりに末尾の N 行を読み取ってください。
サンプル
```python theme={"system"}
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)
```
W\&B API インスタンス。
run ID (オプション) 。指定しない場合は、ランダムな ID が生成されます。
プロジェクト名 (オプション) 。デフォルトは API 設定で指定された project、または "uncategorized" です。
entity (ユーザーまたはチーム) 名 (オプション) 。
run の初期状態。後で再開する run の場合は "pending" を、すぐに実行する場合は "running" を使用します。
サンプル
後で実行する保留中の run を作成する
```python theme={"system"}
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,
)
```
```python theme={"system"}
self,
per_page: 'int' = 100
```
この run でログされたすべてのアーティファクトを取得します。
run 中にログされたすべての出力アーティファクトを取得します。
ページネーションされた結果を返します。この結果は反復処理することも、1 つのリストにまとめることもできます。
引数
1 回の API リクエストで取得するアーティファクトの数。
サンプル
```python theme={"system"}
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()
```python theme={"system"}
self
```
Run オブジェクトへの変更を W\&B バックエンドに保存します。
メソッド Run.scan\_history()
```python theme={"system"}
self,
keys: 'list[str] | None' = None,
page_size: 'int' = 1000,
min_step: 'int' = 0,
max_step: 'int | None' = None,
use_cache: 'bool' = True
```
run のすべての履歴レコードを含むイテラブルなコレクションを返します。
引数
run の履歴から読み取るメトリクスのリストです。スキャンでは、リクエストしたすべてのキーを含む行のみが返されます。キーごとにログされた ステップ が異なる場合は、キーごとに個別に呼び出すか、この引数を省略してください。キーを指定しない場合は、すべてのメトリクスが返されます。
一度に読み取る履歴レコードの数です。
履歴の読み取りを開始する最小の ステップ です (この値を含みます) 。
履歴の読み取りを終了する最大の ステップ です (この値は含みません) 。
True に設定すると、WANDB\_CACHE\_DIR 内に run の履歴があるかを確認します。キャッシュ内に run の履歴が見つからない場合は、サーバーからダウンロードされます。False に設定すると、run の履歴は毎回ダウンロードされます。
メソッド Run.stop()
```python theme={"system"}
self
```
この run の正常停止をリクエストします。
これにより、W\&B バックエンド上で run の停止フラグが設定されます。これは W\&B App UI の「Stop run」ボタンから送信されるものと同じシグナルです。run を実行しているプロセスは、定期的なハートビートを通じてこのフラグを検出し、
run を正常にシャットダウンします。そのため、リモートの run
(たとえば Kubernetes の Pod 上の run) の終了にも安全に使用できます。
停止処理は非同期で行われます。このメソッドは、run の終了時ではなく、バックエンドが
run にフラグを設定した時点で制御を返します。再度呼び出した場合や、
すでに実行中でない run に対して呼び出した場合は、何も起こりません。
送出される例外
* `wandb.Error`: リクエストが失敗した場合。
サンプル
```python theme={"system"}
import wandb
run = wandb.Api().run("entity/project/run_id")
run.stop()
```
メソッド Run.to\_html()
```python theme={"system"}
self,
height: 'int' = 420,
hidden: 'bool' = False
```
この run を表示する iframe を含む HTML を生成します。
引数
説明はありません。
説明はありません。
メソッド Run.update()
```python theme={"system"}
self
```
Run オブジェクトへの変更を wandb バックエンドに保存します。
メソッド Run.update\_state()
```python theme={"system"}
self,
state: 'str'
```
run の状態を更新します。
サポートされる遷移:
* `running`、`failed`、`crashed`、`preempted` から `pending` へ
(例: 終了した run や実行中の run をキューに入れ直す場合)
* `pending` または `running` から `failed` へ
(例: プリエンプトされた run や応答がなくなった run を失敗としてマークする場合)
sweep の run は状態を更新できません。
run が取り得る状態の一覧については、`Run.state` を参照してください。