Run

ある entity と project に関連付けられた単一の run。

Run(
    client: "RetryingClient",
    entity: str,
    project: str,
    run_id: str,
    attrs: Optional[Mapping] = None,
    include_sweeps: bool = (True)
)

Methods

create

View source

@classmethod
create(
    api, run_id=None, project=None, entity=None
)

指定された project の run を作成します。

delete

View source

delete(
    delete_artifacts=(False)
)

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

display

View source

display(
    height=420, hidden=(False)
) -> bool

このオブジェクトを jupyter で表示します。

file

View source

file(
    name
)

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

files

View source

files(
    names=None, per_page=50
)

名前が指定された各ファイルのファイルパスを返します。

history

View source

history(
    samples=500, keys=None, x_axis="_step", pandas=(True), stream="default"
)

run のサンプルされた履歴メトリクスを返します。

履歴レコードのサンプリングが問題ない場合は、これを使用するとより簡単かつ高速になります。

load

View source

load(
    force=(False)
)

log_artifact

View source

log_artifact(
    artifact: "wandb.Artifact",
    aliases: Optional[Collection[str]] = None,
    tags: Optional[Collection[str]] = None
)

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

logged_artifacts

View source

logged_artifacts(
    per_page: int = 100
) -> public.RunArtifacts

この run によって記録されたすべてのアーティファクトをフェッチします。

run 中に記録されたすべての出力 Artifacts を取得します。反復処理したり、単一のリストに収集したりできるページ分割された結果を返します。

Example:

>>> 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)
test_artifact

save

View source

save()

scan_history

View source

scan_history(
    keys=None, page_size=1000, min_step=None, max_step=None
)

run のすべての履歴レコードの反復可能なコレクションを返します。

Example:

サンプル run のすべての損失値をエクスポートします。

run = api.run("l2k2/examples-numpy-boston/i0wt6xua")
history = run.scan_history(keys=["Loss"])
losses = [row["Loss"] for row in history]

snake_to_camel

View source

snake_to_camel(
    string
)

to_html

View source

to_html(
    height=420, hidden=(False)
)

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

update

View source

update()

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

upload_file

View source

upload_file(
    path, root="."
)

ファイルをアップロードします。

use_artifact

View source

use_artifact(
    artifact, use_as=None
)

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

used_artifacts

View source

used_artifacts(
    per_page: int = 100
) -> public.RunArtifacts

この run で明示的に使用されている Artifacts をフェッチします。

通常は run.use_artifact() を介して、run 中に使用されたと明示的に宣言された入力 Artifacts のみを取得します。反復処理したり、単一のリストに収集したりできるページ分割された結果を返します。

Example:

>>> 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

wait_until_finished

View source

wait_until_finished()