> ## Documentation Index
> Fetch the complete documentation index at: https://wb-21fd5541-update-reference-docs-60.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# Run
export const GitHubLink = ({url, compact = false}) =>
{compact ? "ソースを表示" : <>
GitHub のソース
}
;
## クラス wandb.apis.public.Run
entity と project に関連付けられた 1 つの run。
```python theme={null}
(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)
```
## 引数
この run の W\&B API 呼び出しを実行する wandb-core サービスへのインターフェースです。
run に関連付けられた entity です。
run に関連付けられた project です。
run の一意の ID です。
run の属性です。
run に sweeps を含めるかどうかです。
説明はありません。
説明はありません。
## 属性
* `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 のメタデータ
## プロパティ
run 設定を取得します。遅延モードの場合は、完全なデータを自動的に読み込みます。
run に関連付けられている entity です。
run の一意の ID です。
run の履歴 にログされた最後の step を返します。
wandb-metadata.json に含まれる run のメタデータです。
メタデータには、run の説明、タグ、開始時刻、メモリ
使用量などが含まれます。
run の名前です。
run のパスです。パスは entity、project、run\_id を含むリストです。
内部キーを含む生の run 設定を取得します。遅延モードの場合は、完全なデータを自動的に読み込みます。
run の状態です。
次の表は、run が取り得る状態を示しています。
| 状態 | 説明 |
| -------- | --------------------------------------------------------------- |
| Crashed | マシンのクラッシュなどにより、内部プロセスからのハートビート送信が停止した状態です。 |
| 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` を使用してください。
説明はありません。
説明はありません。
説明はありません。
説明はありません。
説明はありません。
### メソッド Run.console\_logs()
```python theme={null}
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 のいずれについても、
このログを読み取れます。
##### 引数
ログを先頭から読み取る際、リクエストごとに取得する行数。`last` が指定されている場合は無視されます。
指定した場合、1 回のリクエストでログの末尾 N 行のみを取得します。実行中の run の確認やクラッシュの診断に役立ちます。バックエンドでは 1 回のリクエストで返せる行数に上限があるため、より多くの行を指定すると、最新の行に切り詰められて返されます。
##### 送出される例外
* `CommError`: 反復処理中にリクエストが失敗した場合に発生します。ログを先頭から読み取るには、W\&B Server 0.77 以降が必要です。古いサーバーでは、代わりに末尾の N 行を読み取ってください。
##### 例
```python theme={null}
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()
```python theme={null}
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()` を呼び出しても、期待どおりに動作しない場合があります。
##### 引数
W\&B API のインスタンス。
省略可能な run ID。指定しない場合は、ランダムな ID が生成されます。
省略可能なプロジェクト名。デフォルトでは、API Settings の project または "uncategorized" が使用されます。
省略可能な entity (ユーザーまたはチーム) 名。
run の初期状態。後で再開する run には "pending" を、すぐに実行する run には "running" を使用します。