W&B の run を初期化すると、W&B はその run に run ID と呼ばれる一意の識別子を割り当てます。各 run には、人間が読みやすくカスタマイズ可能な 一意ではない run name もあります。
run の ID は、その run を一意に識別します。デフォルトでは、新しい run を初期化するときに、ランダムで一意な run ID が自動的に生成されます。run を初期化するときに、独自の一意な run ID を指定することもできます。
W&B Python SDK を使ってプログラムから、または W&B App でインタラクティブに run の一意の ID を取得できます。
run を初期化すると、W&B はターミナルに一意の run ID を出力します。例えば、次のコードスニペットは W&B run を初期化します:import wandb
entity = "nico" # 自分の W&B エンティティに置き換えてください
project = "awesome-project"
with wandb.init(entity=entity, project=project) as run:
# ここに自分のコードを記述します
ターミナルには次のように出力されます:wandb: Syncing run earnest-sunset-1
wandb: ⭐️ View project at https://wandb.ai/nico/awesome-project
wandb: 🚀 View run at https://wandb.ai/nico/awesome-project/runs/1jx1ud12
run の URL の最後の部分(1jx1ud12)が一意の run ID です。 W&B App でも run の一意の ID を確認できます:
- W&B App に移動します。
- run を初期化したときに指定した W&B プロジェクトに移動します。
- プロジェクトのワークスペース内で、Workspace または Runs タブを選択します。
- 表示したい run を選択します。
- Overview タブを選択します。
W&B は Run path フィールドに run ID を表示します。run path はチーム名、プロジェクト名、run ID で構成されます。一意の ID は run path の最後の部分です。例えば、次の画像では、一意の run ID は 9mxi1arc です:
run の一意の ID を使うと、その run の概要ページに W&B App から直接移動できます。次のコードブロックは、run 用の URL パスの形式を示しています:https://wandb.ai/<entity>/<project>/<run-id>
山括弧(< >)で囲まれた値を、実際の entity、project、run ID の値に置き換えてください。
run を初期化するときに、任意の run ID を文字列として id パラメータに指定します。
import wandb
with wandb.init(entity="<project>", project="<project>", id="<run-id>") as run:
# ここにコードを記述
各runには、人間が読みやすい(ただし一意ではない)run名があります。デフォルトでは、新しいrunを初期化するときにrun名を指定しなければ、W&Bがランダムなrun名を自動生成します。runの名前は、プロジェクトのワークスペース内およびrunのOverviewページの上部に表示されます。
前の例から続けると、このrunの名前は glowing-shadows-8 です。
runを初期化するときに名前を付けることも、後から名前を変更することもできます。
wandb.init() メソッドに name パラメータを指定して、run の名前を設定します。
import wandb
with wandb.init(entity="<project>", project="<project>", name="<run-name>") as run:
# ここにコードを記述
Python SDK を使ってプログラムから、または W&B App 上でインタラクティブに、初期化済みの run の名前を変更できます。
wandb.Api.Run を使用して、W&B にログされた run にアクセスします。このメソッドは run オブジェクト を返し、run 名を更新するために使用できます。変更を永続化するには wandb.Api.Run.update() メソッドを呼び出します。山かっこ(< >)で囲まれた値を自身の値に置き換えてください。import wandb
api = wandb.Api()
# パスを指定して run にアクセス
run = api.run(path = "<entity>/<project>/<run-id>")
# 新しい run 名を指定
run.name = "<new-run-name>"
run.update()
- 対象の W&B プロジェクトに移動します。
- Workspace タブまたは Runs タブを選択します。
- 名前を変更したい run を検索するか、スクロールして探します。
- run 名にカーソルを合わせて縦三点リーダーアイコンをクリックし、Rename run をクリックします。
- run 名を変更するには、Run name フィールドを更新します。
- Save をクリックします。
各 run には、ワークスペースごとにカスタマイズできる run 表示名 もあります。
あるワークスペースで run の表示名を変更しても、その変更が反映されるのはそのワークスペース内だけであり、他のワークスペースやプロジェクトには影響しません。
表示名のデフォルト値は run 名と同じです。表示名は、その run の Workspace と runs テーブルに表示されます。
run 表示名を使うと、プロジェクト内の run 自体の名前は変更せずに、そのワークスペースで表示される run 名だけを上書きできます。
W&B App から run の表示名を変更するには、次の手順を実行します:
- W&B プロジェクトに移動します。
- Workspace または Runs タブを選択します。
- 名前を変更したい run を検索するか、スクロールして探します。
- run 名にカーソルを合わせて縦三点リーダーをクリックし、Rename run をクリックします。
- Display name フィールドに新しい値を入力します。
- Save をクリックします。
デフォルトでは、長い run 名は読みやすさのため中央部分が省略されます。run 名の省略方法をカスタマイズするには、次の手順を実行します。
- Runs の一覧上部にあるアクション
... メニューをクリックします。
- Run name cropping で、末尾・中央・先頭のいずれを省略するかを選択します。