Run - Weights & Biases Documentation

クラス wandb.Run

W&B でログされる計算の単位です。通常は ML の実験です。新しい run を作成するには、wandb.init() を呼び出します。wandb.init() は新しい run を開始し、wandb.Run オブジェクトを返します。各 run には一意の ID (run ID) が関連付けられます。W&B では、コンテキストマネージャー (with 文) を使用して run を自動的に終了することを推奨しています。分散トレーニング実験では、プロセスごとに 1 つの run を使って各プロセスを個別にトラッキングすることも、すべてのプロセスを 1 つの run でトラッキングすることもできます。詳細は Log distributed training experiments を参照してください。 wandb.Run.log() を使って run にデータをログできます。wandb.Run.log() を使用してログしたものはすべて、その run に送信されます。詳細は Create an experiment または wandb.init API リファレンスページを参照してください。 wandb.apis.public 名前空間には、別の Run オブジェクトがあります。このオブジェクトは、すでに作成されている Runs を操作するために使用します。

属性

summary: (Summary) run のサマリーであり、辞書のようなオブジェクトです。詳細は Log summary metrics を参照してください。

例

wandb.init() で run を作成します:

import wandb

# 新しい run を開始してデータをログする
# コンテキストマネージャー (`with` 文) を使用して run を自動的に終了する
with wandb.init(entity="entity", project="project") as run:
    run.log({"accuracy": acc, "loss": loss})

プロパティ

wandb_config.Config

この run に関連付けられた Config オブジェクト。

wandb_config.ConfigStatic

この run に関連付けられた静的な設定オブジェクト。

str

run の file が保存されるディレクトリ。これは、run.save() で保存された file (run.log() に渡された特定のデータタイプに対して自動作成される file を含む) を指します。run のすべてのデータを含むディレクトリについては、run.sync_dir を参照してください。

bool

run が無効な場合は True、それ以外の場合は False。

str

run に関連付けられた W&B entity の名。entity には、ユーザー名、チーム名、または組織名を指定できます。

str

この run に関連付けられた group の名を返します。run をグループ化すると、関連する experiment を整理し、 W&B UI でまとめて可視化できます。これは、分散トレーニングや交差検証など、複数の run を 1 つの experiment として表示・管理する必要があるシナリオで特に役立ちます。すべてのプロセスが同じ Run オブジェクトを共有する共有モードでは、 run は 1 つしかなくグループ化も不要なため、通常は group を設定する必要はありません。

str

この run の識別子。

str

run に関連付けられたジョブタイプの名。W&B App の run の Overview ページで、run のジョブタイプを確認できます。これを使用して、“training”、“evaluation”、“inference” などのジョブタイプ別に run を分類できます。これは、W&B UI で run を整理・フィルタリングする際、特に同じ project 内に異なるジョブタイプの複数の run がある場合に役立ちます。詳細については、 Organize runs を参照してください。

str | None

run の表示名。表示名は一意であるとは限らず、任意の説明的な名を設定できます。デフォルトでは、ランダムに生成されます。

str | None

run に関連付けられたメモ (ある場合) 。メモには複数行の string を指定でき、$$ 内では $x + 3$ のような Markdown や LaTeX の数式も使用できます。

bool

run がオフラインの場合は True、それ以外の場合は False。

str

run へのパス。run パスには entity、project、run ID が含まれ、形式は entity/project/run_id です。

str

run に関連付けられた W&B のプロジェクトの名。

str | None

run に関連付けられた W&B のプロジェクトの URL (ある場合) 。オフライン run には project URL がありません。

bool

run が再開された場合は True、それ以外の場合は False。

Settings

run の Settings オブジェクトの凍結されたコピー。

float

run が開始された時刻の Unix Timestamp (秒) 。

int

次の log() 呼び出しの W&B step。mode=“shared” の run ではエラーが発生します。

str | None

run に関連付けられた sweep の識別子 (ある場合) 。

str | None

run に関連付けられた sweep の URL (ある場合) 。オフライン run には sweep URL がありません。

str

run のすべてのデータを含むディレクトリ。これを wandb sync に渡すと、run をアップロードまたは再アップロードできます。

tuple | None

run に関連付けられたタグ (ある場合) 。

str | None

W&B run の URL (ある場合) 。オフライン run には URL がありません。

メソッド

method Run.alert()

self,
title: 'str',
text: 'str',
level: 'str | AlertLevel | None' = None,
wait_duration: 'int | float | timedelta | None' = None

指定されたタイトルとテキストでアラートを作成します。

引数

str

アラートのタイトル。64 文字未満である必要があります。

str

アラートの本文。

str | AlertLevel | None

使用するアラートレベル。INFO、WARN、ERROR のいずれかです。

int | float | timedelta | None

同じタイトルの次のアラートを送信するまでの待機時間 (秒) 。

method Run.define_metric()

self,
name: 'str',
step_metric: 'str | wandb_metric.Metric | None' = None,
step_sync: 'bool | None' = None,
hidden: 'bool | None' = None,
summary: 'str | None' = None,
overwrite: 'bool | None' = None

wandb.Run.log() でログするメトリクスをカスタマイズします。

引数

str

カスタマイズするメトリクスの名。

str | wandb_metric.Metric | None

自動生成されるチャートで、このメトリクスの X 軸として使用する別のメトリクスの名。

bool | None

明示的に指定されていない場合、step_metric の最後の値を wandb.Run.log() に自動的に挿入します。step_metric が指定されている場合、デフォルトは True です。

bool | None

このメトリクスを自動プロットから非表示にします。

str | None

summary に追加する集約メトリクスを指定します。サポートされる集約には、“min”、“max”、“mean”、“last”、“first”、“copy”、“none” があります。“none” を指定すると summary は生成されません。“copy” は非推奨のため、使用しないでください。

bool | None

false の場合、未指定のパラメーターには以前の値が使用され、この呼び出しは同じメトリクスに対する以前の define_metric 呼び出しとマージされます。true の場合、未指定のパラメーターによって以前の呼び出しで指定された値が上書きされます。

method Run.display()

self,
height: 'int' = 420,
hidden: 'bool' = False

Jupyterでこの run を表示します。

引数

int

説明は提供されていません。

bool

説明は提供されていません。

method Run.finish()

self,
exit_code: 'int | None' = None

run を終了し、残っているデータをアップロードします。 W&B run の完了を記録し、すべてのデータがサーバーに Sync されるようにします。run の最終状態は、終了条件と Sync ステータスによって決まります。 run の状態:

Running: データをログし、かつ/またはハートビートを送信しているアクティブな run。
Crashed: ハートビートの送信が予期せず止まった run。
Finished: すべてのデータが Sync され、正常に完了した run (exit_code=0) 。
Failed: エラーにより完了した run (exit_code!=0) 。
Killed: 完了前に強制的に停止された run。

引数

int | None

run の終了ステータスを示す整数です。成功時は 0 を使用し、それ以外の値を指定すると run は失敗として扱われます。

method Run.finish_artifact()

self,
artifact_or_path: 'Artifact | str',
name: 'str | None' = None,
type: 'str | None' = None,
aliases: 'list[str] | None' = None,
distributed_id: 'str | None' = None

未確定のアーティファクトを run の出力として確定します。同じ distributed ID を持つ後続の “upsert” では、新しいバージョンが作成されます。

引数

Artifact | str

このアーティファクトの内容へのパス。指定できる形式は次のとおりです:

/local/directory
/local/directory/file.txt
s3://bucket/path wandb.Artifact を呼び出して作成した Artifact オブジェクトを渡すこともできます。

str | None

アーティファクト名。entity/プロジェクトを接頭辞として付けることもできます。有効な名前の形式は次のとおりです:

name:version
name:alias
digest 指定しない場合、現在の run id を先頭に付けたパスの basename がデフォルトになります。

str | None

ログするアーティファクトのタイプ。例: dataset, model

list[str] | None

このアーティファクトに適用するエイリアス。デフォルトは ["latest"] です

str | None

すべての分散ジョブで共有される一意の文字列。None の場合は、run の group 名がデフォルトになります。

method Run.link_artifact()

self,
artifact: 'Artifact',
target_path: 'str',
aliases: 'list[str] | None' = None

アーティファクトをコレクションにリンクします。「link」という用語は、W&B でアーティファクトが保存されている場所と、レジストリ内でそのアーティファクトにアクセスできる場所を結び付けるポインタを指します。アーティファクトをコレクションにリンクしても、W&B がアーティファクトを複製することはありません。指定したコレクションにリンクされたアーティファクトを Registry UI で表示します。

引数

Artifact

コレクションにリンクするアーティファクトオブジェクト。

str

コレクションのパスです。パスは、プレフィックス “wandb-registry-”、レジストリ名、およびコレクション名 wandb-registry-{REGISTRY_NAME}/{COLLECTION_NAME} で構成されます。

list[str] | None

リンクしたアーティファクトに 1 つ以上のエイリアスを追加します。“latest” エイリアスは、リンクした最新のアーティファクトに自動的に適用されます。

例

import wandb

entity = "team_entity"
project = "project_name"

artifact_name = "artifact_name"
artifact_type = "artifact_type"
local_path = "path/to/local/file"

registry_name = "registry_name"
collection_name = "collection_name"
target_path = f"wandb-registry-{registry_name}/{collection_name}"

with wandb.init(entity=entity, project=project) as run:
    # アーティファクト オブジェクトを作成します
    artifact = wandb.Artifact(name=artifact_name, type=artifact_type)

    # file をアーティファクト オブジェクトに追加します。
    artifact.add_file(local_path=local_path)

    # アーティファクト をコレクションにリンクします
    run.link_artifact(artifact=artifact, target_path=target_path)

method Run.link_model()

self,
path: 'StrPath',
registered_model_name: 'str',
name: 'str | None' = None,
aliases: 'list[str] | None' = None

モデルアーティファクトのバージョンをログし、モデルレジストリ内の登録済みモデルにリンクします。リンクされたモデルバージョンは、指定した登録済みモデルの UI で確認できます。この method は次を行います:

モデルアーティファクト ‘name’ がすでにログされているかどうかを確認します。ログされている場合は、‘path’ にあるファイルに一致するアーティファクトバージョンを使用するか、新しいバージョンをログします。ログされていない場合は、‘path’ 配下のファイルを、タイプ ‘model’ の新しいモデルアーティファクト ‘name’ としてログします。
‘model-registry’ プロジェクトに、‘registered_model_name’ という名の登録済みモデルが存在するかどうかを確認します。存在しない場合は、‘registered_model_name’ という名の新しい登録済みモデルを作成します。
モデルアーティファクト ‘name’ のバージョンを、登録済みモデル ‘registered_model_name’ にリンクします。
‘aliases’ リストのエイリアスを、新たにリンクされたモデルアーティファクトバージョンに付与します。

引数

StrPath

(str) このモデルの内容へのパスです。次の形式を指定できます:

/local/directory
/local/directory/file.txt
s3://bucket/path

str

モデルのリンク先となる登録済みモデルの名前です。登録済みモデルは、モデルレジストリにリンクされたモデルバージョンのコレクションで、通常はチーム固有の ML タスクを表します。この登録済みモデルが属する entity は run から導出されます。

str | None

‘path’ 内のファイルのログ先となるモデルアーティファクトの名前です。指定しない場合は、パスの basename の先頭に current run id を付けたものがデフォルトで使用されます。

list[str] | None

登録済みモデル内で、このリンクされたアーティファクトにのみ適用されるエイリアスです。エイリアス “latest” は、リンクされたアーティファクトの最新バージョンに常に適用されます。

送出される例外

AssertionError: registered_model_name がパスである場合、またはモデルアーティファクト ‘name’ のタイプに部分文字列 ‘model’ が含まれていない場合。
ValueError: name に無効な特殊文字が含まれている場合。

method Run.log()

self,
data: 'dict[str, Any]',
step: 'int | None' = None,
commit: 'bool | None' = None

run データをアップロードします。スカラー、画像、動画、ヒストグラム、プロット、表などの run データをログするには、log を使用します。コードスニペット、ベストプラクティスなどについては、オブジェクトとメディアをログするを参照してください。基本的な使用方法:

import wandb

with wandb.init() as run:
    run.log({"train-loss": 0.5, "accuracy": 0.9})

前のコードスニペットでは、損失と accuracy を run の history に保存し、これらのメトリクスの summary 値を更新します。ログしたデータは、wandb.ai の Workspace や、W&B app のセルフホストインスタンスで可視化できます。あるいは、データをエクスポートして、Jupyter notebook などのローカル環境で Public API を使用して可視化や探索を行うこともできます。ログする値はスカラーである必要はありません。画像、オーディオ、video など、任意の W&B でサポートされる Data Type をログできます。たとえば、wandb.Table を使用して構造化データをログできます。詳しくは、Log tables, visualize and query data チュートリアルを参照してください。 W&B は、名にスラッシュ (/) を含むメトリクスを、最後のスラッシュより前のテキストを名前とするセクションに整理します。たとえば、次のようにすると、“train” と “validate” という 2 つのセクションが作成されます。

with wandb.init() as run:
    # "train" セクションにメトリクスをログする。
    run.log(
        {
            "train/accuracy": 0.9,
            "train/loss": 30,
            "validate/accuracy": 0.8,
            "validate/loss": 20,
        }
    )

ネストは 1 レベルまでのみサポートされます。run.log({"a/b/c": 1}) を実行すると、“a” という名前のセクションが作成されます。 run.log() は、1 秒間に数回を超えて呼び出す用途を想定していません。最適なパフォーマンスを得るには、N 回の反復ごとに 1 回だけログするか、複数回の反復でデータを収集して 1 つの step としてまとめてログしてください。デフォルトでは、log を呼び出すたびに新しい “step” が作成されます。step は常に増加している必要があり、前の step にログすることはできません。チャートの X 軸には任意のメトリクスを使用できます。詳しくは Custom log axes を参照してください。多くの場合、W&B の step は、トレーニング step というよりもタイムスタンプのように扱うほうが適切です。

with wandb.init() as run:
    # 例: X 軸として使用する "epoch" メトリクスをログする。
    run.log({"epoch": 40, "train-loss": 0.5})

step および commit パラメーターを使用すると、複数の wandb.Run.log() 呼び出しで同じ step にログできます。以下はすべて同じ意味です。

with wandb.init() as run:
    # 通常の使用方法:
    run.log({"train-loss": 0.5, "accuracy": 0.8})
    run.log({"train-loss": 0.4, "accuracy": 0.9})

    # 自動インクリメントなしの暗黙的な step:
    run.log({"train-loss": 0.5}, commit=False)
    run.log({"accuracy": 0.8})
    run.log({"train-loss": 0.4}, commit=False)
    run.log({"accuracy": 0.9})

    # 明示的な step:
    run.log({"train-loss": 0.5}, step=current_step)
    run.log({"accuracy": 0.8}, step=current_step)
    current_step += 1
    run.log({"train-loss": 0.4}, step=current_step)
    run.log({"accuracy": 0.9}, step=current_step, commit=True)

引数

dict[str, Any]

str キーと、int、float、string、任意の wandb.data_types、シリアライズ可能な Python オブジェクトのリスト、タプル、NumPy 配列、および同じ構造の他の dict を含む、シリアライズ可能な Python オブジェクトの値を持つ dict です。

int | None

ログする step 番号です。None の場合は、暗黙的に自動インクリメントされる step が使用されます。説明内のメモを参照してください。

bool | None

true の場合は、step を確定してアップロードします。false の場合は、その step のデータを蓄積します。説明内のメモを参照してください。step が None の場合、デフォルトは commit=True です。それ以外の場合、デフォルトは commit=False です。

送出される例外

wandb.Error: wandb.init() より前に呼び出した場合。
ValueError: 無効なデータが渡された場合。

例

さらに多くの詳しい例については、ログに関するガイドを参照してください。基本的な使用方法

import wandb

with wandb.init() as run:
    run.log({"train-loss": 0.5, "accuracy": 0.9

段階的なロギング

import wandb

with wandb.init() as run:
    run.log({"loss": 0.2}, commit=False)
    # この step を report する準備ができたら、別の箇所で:
    run.log({"accuracy": 0.8})

ヒストグラム

import numpy as np
import wandb

# 正規分布からランダムにgradientをサンプリングする
gradients = np.random.randn(100, 100)
with wandb.init() as run:
    run.log({"gradients": wandb.Histogram(gradients)})

NumPy から作成した画像

import numpy as np
import wandb

with wandb.init() as run:
    examples = []
    for i in range(3):
        pixels = np.random.randint(low=0, high=256, size=(100, 100, 3))
        image = wandb.Image(pixels, caption=f"random field {i}")
        examples.append(image)
    run.log({"examples": examples})

PIL の画像

import numpy as np
from PIL import Image as PILImage
import wandb

with wandb.init() as run:
    examples = []
    for i in range(3):
        pixels = np.random.randint(
            low=0,
            high=256,
            size=(100, 100, 3),
            dtype=np.uint8,
        )
        pil_image = PILImage.fromarray(pixels, mode="RGB")
        image = wandb.Image(pil_image, caption=f"random field {i}")
        examples.append(image)
    run.log({"examples": examples})

NumPy から作成した動画

import numpy as np
import wandb

with wandb.init() as run:
    # 軸は (time, channel, height, width)
    frames = np.random.randint(
        low=0,
        high=256,
        size=(10, 3, 100, 100),
        dtype=np.uint8,
    )
    run.log({"video": wandb.Video(frames, format="mp4", fps=4)})

Matplotlib のプロット

from matplotlib import pyplot as plt
import numpy as np
import wandb

with wandb.init() as run:
    fig, ax = plt.subplots()
    x = np.linspace(0, 10)
    y = x * x
    ax.plot(x, y)  # y = x^2 をプロット
    run.log({"chart": fig})

PR曲線

import wandb

with wandb.init() as run:
    run.log({"pr": wandb.plot.pr_curve(y_test, y_probas, labels)})

3D オブジェクト

import wandb

with wandb.init() as run:
    run.log(
        {
            "generated_samples": [
                wandb.Object3D(open("sample.obj")),
                wandb.Object3D(open("sample.gltf")),
                wandb.Object3D(open("sample.glb")),
            ]
        }
    )

method Run.log_artifact()

self,
artifact_or_path: 'Artifact | StrPath',
name: 'str | None' = None,
type: 'str | None' = None,
aliases: 'list[str] | None' = None,
tags: 'list[str] | None' = None

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

引数

Artifact | StrPath

(str または Artifact) このアーティファクトの内容へのパス。指定できる形式は次のとおりです:

/local/directory
/local/directory/file.txt
s3://bucket/path wandb.Artifact を呼び出して作成した Artifact オブジェクトを渡すこともできます。

str | None

(str, 任意) アーティファクト名。指定できる名前の形式は次のとおりです:

name:version
name:alias
digest 指定しない場合は、現在の run ID を先頭に付けたパスの basename がデフォルトになります。

str | None

(str) ログするアーティファクトのタイプ。dataset、model などがあります

list[str] | None

(list, 任意) このアーティファクトに適用するエイリアス。デフォルトは ["latest"] です

list[str] | None

(list, 任意) このアーティファクトに適用するタグ (存在する場合) 。

method Run.log_code()

self,
root: 'str | None' = '.',
name: 'str | None' = None,
include_fn: 'Callable[[str, str], bool] | Callable[[str], bool]' = _is_py_requirements_or_dockerfile,
exclude_fn: 'Callable[[str, str], bool] | Callable[[str], bool]' = exclude_wandb_fn

コードの現在の状態を W&B アーティファクトに保存します。デフォルトでは、現在のディレクトリを走査し、.py で終わるすべてのファイルをログします。

引数

str | None

コードを再帰的に検索する起点となる、os.getcwd() からの相対パスまたは絶対パス。

str | None

(str, optional) コードアーティファクトの名。デフォルトでは、アーティファクト名は source-$PROJECT_ID-$ENTRYPOINT_RELPATH になります。複数の run で同じアーティファクトを共有したい場合があります。name を指定すると、それが可能になります。

Callable[[str, str], bool] | Callable[[str], bool]

ファイルパスと (必要に応じて) ルートパスを受け取り、含める場合は True、そうでない場合は False を返す callable。デフォルトは lambda path, root: path.endswith(".py") です。

Callable[[str, str], bool] | Callable[[str], bool]

ファイルパスと (必要に応じて) ルートパスを受け取り、除外する場合は True、そうでない場合は False を返す callable。デフォルトでは、<root>/.wandb/ および <root>/wandb/ ディレクトリ内のすべてのファイルを除外する関数です。

例

基本的な使い方

import wandb

with wandb.init() as run:
    run.log_code()

応用的な使い方

import wandb

with wandb.init() as run:
    run.log_code(
        root="../",
        include_fn=lambda path: path.endswith(".py") or path.endswith(".ipynb"),
        exclude_fn=lambda path, root: os.path.relpath(path, root).startswith(
            "cache/"
        ),
    )

メソッド Run.log_model()

self,
path: 'StrPath',
name: 'str | None' = None,
aliases: 'list[str] | None' = None

path 内の内容を含むモデルアーティファクトを run にログし、この run の出力としてマークします。モデルアーティファクトの名前に使用できるのは、英数字、アンダースコア、ハイフンのみです。

引数

StrPath

(str) このモデルの内容へのパスです。次の形式を使用できます:

/local/directory
/local/directory/file.txt
s3://bucket/path

str | None

ファイルの内容を追加するモデルアーティファクトに割り当てる名前です。指定しない場合は、path の basename の先頭に現在の run ID を付けたものがデフォルトになります。

list[str] | None

作成されたモデルアーティファクトに適用するエイリアスです。デフォルトは ["latest"] です

送出される例外

ValueError: name に無効な特殊文字が含まれている場合。

メソッド Run.mark_preempting()

self

この run をプリエンプト中としてマークします。また、内部プロセスに対して、これを直ちにサーバーへ報告するよう指示します。

メソッド Run.pin_config_keys()

self,
keys: 'Sequence[str]' = ()

Run Overview の References セクションに表示する設定キーをピン留めします。ピン留めしたキーは、Run Overview ページのメモの上に目立つ形で表示されます。文字列値は markdown としてレンダリングされ、文字列以外の値はプレーンテキストとしてレンダリングされます。これを再度呼び出すと、以前ピン留めしたリストは置き換えられます。

引数

Sequence[str]

ピン留めする設定キー名です。run.config で設定したキーと一致している必要があります。これらは完全一致のキー文字列で、ドットやスラッシュはパス区切り文字ではなく、文字どおりに扱われます。順序は保持され、その順序が表示順になります。

メソッド Run.restore()

self,
name: 'str',
run_path: 'str | None' = None,
replace: 'bool' = False,
root: 'str | None' = None

指定したファイルをクラウドストレージからダウンロードします。ファイルは現在のディレクトリまたは run ディレクトリに保存されます。デフォルトでは、ファイルがまだ存在しない場合にのみダウンロードされます。

引数

str

ファイルの名。

str | None

ファイルの取得元となる run へのオプションのパス。例: username/project_name/run_id。wandb.init が呼び出されていない場合は必須です。

bool

ローカルにすでに存在する場合でもファイルをダウンロードするかどうか

str | None

ファイルのダウンロード先ディレクトリ。デフォルトでは現在のディレクトリ、または wandb.init が呼び出されている場合は run ディレクトリです。

送出される例外

CommError: W&B が W&B バックエンドに接続できない場合。
ValueError: ファイルが見つからない場合、または run_path が見つからない場合。

メソッド Run.save()

self,
glob_str: 'str | os.PathLike',
base_path: 'str | os.PathLike | None' = None,
policy: 'PolicyName' = 'live',
glob: 'bool' = True

1 つ以上のファイルを W&B に Sync します。相対パスは、現在の作業ディレクトリからの相対パスです。 “myfiles/*” のような Unix glob は、policy に関係なく、save が呼び出された時点で展開されます。特に、新しいファイルが自動的に自動反映されることはありません。 glob_str は Python の glob モジュールを使用して展開されます。正確な構文と動作については、 https://docs.python.org/3/library/glob.html を参照してください。特に、文字 *、?、[] は、実際のファイル名 (例: “myfile[1].txt”) に含まれている場合でも、リテラル文字ではなく glob のメタ文字として扱われます。ファイル名にこれらの文字が含まれていて、パターンではなく文字どおりに一致させたい場合は、save を呼び出す前に glob.escape() で自分でエスケープするか、glob=False を渡してパターン展開を完全に無効にし、glob_str をリテラルパスとして扱ってください。アップロードされるファイルのディレクトリ構造を制御するために、base_path を指定できます。これは glob_str のプレフィックスである必要があり、その配下のディレクトリ構造は保持されます。絶対パスまたは glob が指定され、base_path がない場合は、上記の例のように 1 階層分のディレクトリが保持されます。ファイルは自動的に重複排除されます。同じファイルを変更せずに save() を複数回呼び出しても、再アップロードされません。

引数

str | os.PathLike

相対パス、絶対パス、または Unix glob。

str | os.PathLike | None

ディレクトリ構造の推定に使用するパス。例を参照してください。

PolicyName

live、now、end のいずれかです。

live: ファイルが変更されるたびにアップロードし、前のバージョンを上書きします
now: 今すぐ 1 回だけファイルをアップロードします
end: run の終了時にファイルをアップロードします

bool

glob_str を glob パターンとして扱うかどうか。後方互換性のため、デフォルトでは True です。glob_str の名前に [、]、*、? などの glob メタ文字が含まれており、それらをパターンとして解釈したくない場合は、False に設定して glob_str をリテラルパスとして扱います。

メソッド Run.status()

self

内部バックエンドから、現在のrunのSyncステータス情報を取得します。

メソッド Run.unwatch()

self,
models: 'torch.nn.Module | Sequence[torch.nn.Module] | None' = None

pytorch モデルのトポロジー、勾配、パラメーターのフックを削除します。

引数

torch.nn.Module | Sequence[torch.nn.Module] | None

watch が呼び出されている pytorch モデルの任意のリスト。

メソッド Run.upsert_artifact()

self,
artifact_or_path: 'Artifact | str',
name: 'str | None' = None,
type: 'str | None' = None,
aliases: 'list[str] | None' = None,
distributed_id: 'str | None' = None

run の出力として、未確定のアーティファクトを宣言する (または追加する) 。アーティファクトを確定するには、run.finish_artifact() を呼び出す必要があることに注意してください。これは、分散ジョブのすべてが同じアーティファクトに書き込む必要がある場合に便利です。

引数

Artifact | str

このアーティファクトの内容へのパス。次の形式を指定できます。

/local/directory
/local/directory/file.txt
s3://bucket/path

str | None

アーティファクト名。entity/プロジェクト を接頭辞として付けることができます。指定しない場合、パスの basename の先頭に現在の run ID を付けたものがデフォルトになります。有効な名は次の形式です。

name:version
name:alias
digest

str | None

ログするアーティファクトのタイプ。一般的な例としては dataset、model があります。

list[str] | None

このアーティファクトに適用するエイリアス。デフォルトは ["latest"] です。

str | None

すべての分散ジョブで共有する一意の文字列です。None の場合、run のグループ名がデフォルトになります。

メソッド Run.use_artifact()

self,
artifact_or_name: 'str | Artifact',
type: 'str | None' = None,
aliases: 'list[str] | None' = None,
use_as: 'str | None' = None

アーティファクトを run への入力として宣言します。返されたオブジェクトに対して download または file を呼び出すと、内容をローカルに取得できます。

引数

str | Artifact

使用するアーティファクトの名前。アーティファクトがログされたプロジェクト名 (“entity” または “entity/project”) を接頭辞として付けることもできます。名前に entity が指定されていない場合は、Run または API 設定の entity が使用されます。有効な名前は次の形式です

name:version
name:alias

str | None

使用するアーティファクトのタイプ。

list[str] | None

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

str | None

この引数は非推奨で、何も行いません。

例

import wandb

run = wandb.init(project="<example>")

# 名前とエイリアスでアーティファクトを使用する
artifact_a = run.use_artifact(artifact_or_name="<name>:<alias>")

# 名前とバージョンでアーティファクトを使用する
artifact_b = run.use_artifact(artifact_or_name="<name>:v<version>")

# entity/project/name:alias でアーティファクトを使用する
artifact_c = run.use_artifact(
    artifact_or_name="<entity>/<project>/<name>:<alias>"
)

# entity/project/name:version でアーティファクトを使用する
artifact_d = run.use_artifact(
    artifact_or_name="<entity>/<project>/<name>:v<version>"
)

# コンテキストマネージャーを使用していないため、明示的に run を終了する。
run.finish()

メソッド Run.use_model()

self,
name: 'str'

モデルアーティファクト name にログされたファイルをダウンロードします。

引数

str

モデルアーティファクトの名です。‘name’ は、既存のログ済みモデルアーティファクトの名と一致している必要があります。entity/プロジェクト/ をプレフィックスとして付けることもできます。有効な名は次の形式です

model_artifact_name:version
model_artifact_name:alias

送出される例外

AssertionError: モデルアーティファクト name のタイプに部分文字列 model が含まれていない場合。

メソッド Run.watch()

self,
models: 'torch.nn.Module | Sequence[torch.nn.Module]',
criterion: 'torch.F | None' = None,
log: "Literal['gradients', 'parameters', 'all'] | None" = 'gradients',
log_freq: 'int' = 1000,
idx: 'int | None' = None,
log_graph: 'bool' = False

指定された PyTorch モデルにフックを設定し、勾配とモデルの計算グラフを監視します。この関数では、トレーニング中にパラメーター、勾配、またはその両方をトラッキングできます。

引数

torch.nn.Module | Sequence[torch.nn.Module]

モニターする単一のモデル、またはモデルのシーケンスです。

torch.F | None

最適化対象の損失関数 (任意) 。

Literal['gradients', 'parameters', 'all'] | None

ログする対象として “gradients”、“parameters”、または “all” を指定します。ログを無効にするには None に設定します。 (デフォルト=“gradients”)

int

勾配とパラメーターをログする頻度 (バッチ単位) 。 (デフォルト=1000)

int | None

wandb.watch で複数のモデルをトラッキングする際に使用するインデックス。 (デフォルト=None)

bool

モデルの計算グラフをログするかどうか。 (デフォルト=False)

送出される例外

ValueError: wandb.init() が呼び出されていない場合、またはいずれかのモデルが torch.nn.Module のインスタンスではない場合。

メソッド Run.write_logs()

self,
text: 'str'

run の Logs タブにテキストを書き込みます。 stdout/stderr の自動取得に依存せず、write_logs を使用して Logs タブに直接テキストを書き込みます。run の終了後にこのメソッドを呼び出しても、何も通知されずに無視されます。 Python の logging モジュールと連携する capture_loggers 設定の使用を検討してください。

引数

str

書き込むテキストです。末尾に改行がない場合は、改行が追加されます。

​クラス wandb.Run

​属性

​例

​プロパティ

​メソッド

​method Run.alert()

引数

​method Run.define_metric()

引数

​method Run.display()

引数

​method Run.finish()

引数

​method Run.finish_artifact()

引数

​method Run.link_artifact()

引数

例

​method Run.link_model()

引数

送出される例外

​method Run.log()

引数

送出される例外

例

​method Run.log_artifact()

引数

​method Run.log_code()

引数

例

​メソッド Run.log_model()

引数

送出される例外

​メソッド Run.mark_preempting()

​メソッド Run.pin_config_keys()

引数

​メソッド Run.restore()

引数

送出される例外

​メソッド Run.save()

引数

​メソッド Run.status()

​メソッド Run.unwatch()

引数

​メソッド Run.upsert_artifact()

引数

​メソッド Run.use_artifact()

引数

例

​メソッド Run.use_model()

引数

送出される例外

​メソッド Run.watch()

引数

送出される例外

​メソッド Run.write_logs()

引数

クラス wandb.Run

属性

例

プロパティ

メソッド

method Run.alert()

method Run.define_metric()

method Run.display()

method Run.finish()

method Run.finish_artifact()

method Run.link_artifact()

method Run.link_model()

method Run.log()

method Run.log_artifact()

method Run.log_code()

メソッド Run.log_model()

メソッド Run.mark_preempting()

メソッド Run.pin_config_keys()

メソッド Run.restore()

メソッド Run.save()

メソッド Run.status()

メソッド Run.unwatch()

メソッド Run.upsert_artifact()

メソッド Run.use_artifact()

メソッド Run.use_model()

メソッド Run.watch()

メソッド Run.write_logs()