Run
3 minute read
エンティティおよびプロジェクトに関連付けられた単一の run。
Run(
client: "RetryingClient",
entity: str,
project: str,
run_id: str,
attrs: Optional[Mapping] = None,
include_sweeps: bool = (True)
)
属性 |
---|
メソッド
create
@classmethod
create(
api, run_id=None, project=None, entity=None
)
指定されたプロジェクトのために run を作成します。
delete
delete(
delete_artifacts=(False)
)
指定された run を wandb バックエンドから削除します。
display
display(
height=420, hidden=(False)
) -> bool
このオブジェクトを Jupyter で表示します。
file
file(
name
)
指定された名前のファイルのパスをアーティファクトで返します。
引数 | |
---|---|
name (str): 要求されたファイルの名前。 |
戻り値 | |
---|---|
指定された name 引数と一致する File 。 |
files
files(
names=None, per_page=50
)
指定された名前のすべてのファイルのファイルパスを返します。
引数 | |
---|---|
names (list): 要求されたファイルの名前、指定されていない場合はすべてのファイルを返す。 per_page (int): ページあたりの結果数。 |
戻り値 | |
---|---|
Files オブジェクトで、これは File オブジェクトのイテレータです。 |
history
history(
samples=500, keys=None, x_axis="_step", pandas=(True), stream="default"
)
run のサンプル化された履歴メトリクスを返します。
履歴レコードがサンプリングされることを許容できる場合、こちらの方が簡単で高速です。
引数 | |
---|---|
samples |
(int, オプション) 返すサンプル数 |
pandas |
(bool, オプション) パンダのデータフレームを返す |
keys |
(list, オプション) 特定のキーのメトリクスのみを返す |
x_axis |
(str, オプション) xAxis として使用するメトリクス、デフォルトは _step |
stream |
(str, オプション) メトリクス用の “default”、マシンメトリクス用の “system” |
戻り値 | |
---|---|
pandas.DataFrame |
pandas=True の場合は歴史メトリクスの pandas.DataFrame を返します。 pandas=False の場合は歴史メトリクスの辞書のリストを返します。 |
load
load(
force=(False)
)
log_artifact
log_artifact(
artifact: "wandb.Artifact",
aliases: Optional[Collection[str]] = None,
tags: Optional[Collection[str]] = None
)
アーティファクトを run の出力として宣言します。
引数 | |
---|---|
artifact (Artifact ): wandb.Api().artifact(name) から返されたアーティファクト。 aliases (list, オプション): このアーティファクトに適用するエイリアス。 |
|
tags |
(list, オプション) このアーティファクトに適用するタグ。 |
戻り値 | |
---|---|
Artifact オブジェクト。 |
logged_artifacts
logged_artifacts(
per_page: int = 100
) -> public.RunArtifacts
この run によってログされているすべてのアーティファクトを取得します。
run 中にログされたすべての出力アーティファクトを取得します。取得した結果はページネーションされ、イテレートするか、単一のリストにまとめることができます。
引数 | |
---|---|
per_page |
API リクエストごとに取得するアーティファクトの数。 |
戻り値 | |
---|---|
この run 中に出力として記録されたすべての Artifact オブジェクトのイテレート可能なコレクション。 |
例:
>>> import wandb
>>> import tempfile
>>> with tempfile.NamedTemporaryFile(
... mode="w", delete=False, suffix=".txt"
... ) as tmp:
... tmp.write("これはテストアーティファクトです")
... 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
save()
scan_history
scan_history(
keys=None, page_size=1000, min_step=None, max_step=None
)
run のすべての履歴レコードをイテレート可能なコレクションで返します。
例:
例として全ての損失値をエクスポート
run = api.run("l2k2/examples-numpy-boston/i0wt6xua")
history = run.scan_history(keys=["Loss"])
losses = [row["Loss"] for row in history]
引数 | |
---|---|
keys ([str], オプション): これらのキーのみをフェッチし、これらの定義されたすべてのキーを含む行のみをフェッチします。 page_size (int, オプション): API からフェッチするページのサイズ。 min_step (int, オプション): 一度にスキャンするページの最小数。 max_step (int, オプション): 一度にスキャンするページの最大数。 |
戻り値 | |
---|---|
履歴レコード (辞書) のイテレート可能なコレクション。 |
snake_to_camel
snake_to_camel(
string
)
to_html
to_html(
height=420, hidden=(False)
)
この run を表示する iframe を含む HTML を生成します。
update
update()
run オブジェクトに対する変更を wandb バックエンドに保存します。
upload_file
upload_file(
path, root="."
)
ファイルをアップロードします。
引数 | |
---|---|
path (str): アップロードするファイルの名前。 root (str): ファイルを保存するルートパス。例: ファイルを “my_dir/file.txt” として保存したい場合で、現在 “my_dir” にいる場合は、 root を “../” に設定します。 |
戻り値 | |
---|---|
指定された name 引数に一致する File 。 |
use_artifact
use_artifact(
artifact, use_as=None
)
アーティファクトを run への入力として宣言します。
引数 | |
---|---|
artifact (Artifact ): wandb.Api().artifact(name) から返されたアーティファクト。 use_as (string, オプション): スクリプトでアーティファクトがどのように使用されるかを識別する文字列。 run で使用されるアーティファクトを簡単に識別するために、ベータ版の wandb launch 機能のアーティファクト交換機能を使用します。 |
戻り値 | |
---|---|
Artifact オブジェクト。 |
used_artifacts
used_artifacts(
per_page: int = 100
) -> public.RunArtifacts
この run で明示的に使用されているアーティファクトを取得します。
run 中に明示的に使用された入力アーティファクトのみを取得します。通常は run.use_artifact()
を通じて宣言される。取得した結果はページネーションされ、イテレートするか、単一のリストにまとめることができます。
引数 | |
---|---|
per_page |
API リクエストごとに取得するアーティファクトの数。 |
戻り値 | |
---|---|
この run 中に入力として明示的に使用された 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
wait_until_finished
wait_until_finished()
フィードバック
このページは役に立ちましたか?
Glad to hear it! If you have further feedback, please let us know.
Sorry to hear that. Please tell us how we can improve.