実験を設定する

run の config プロパティを使用して、トレーニングの設定を保存します。

ハイパーパラメーター
データセット名やモデルのタイプなどの入力設定
Experiments のためのその他の独立変数

wandb.Run.config プロパティを使うと、Experiments の分析や後からの再現が容易になります。W&B App では、設定値でグループ化したり、異なる W&B run の設定を比較したり、各トレーニング設定が出力にどのような影響を与えるかを評価したりできます。config プロパティは辞書のようなオブジェクトで、複数の辞書のようなオブジェクトを組み合わせて構成できます。

損失や精度のような出力メトリクスや従属変数を保存するには、wandb.Run.config ではなく wandb.Run.log() を使用してください。

実験の設定を行う

通常、設定はトレーニングスクリプトの冒頭で定義します。ただし、機械学習のワークフローはさまざまであるため、トレーニングスクリプトの冒頭で設定を定義する必要はありません。設定変数名には、ピリオド (.) の代わりにダッシュ (-) またはアンダースコア (_) を使用してください。スクリプトでルートより下位の wandb.Run.config キーにアクセスする場合は、属性アクセス構文 config.key.value ではなく、辞書アクセス構文 ["key"]["value"] を使用してください。以下のセクションでは、実験の設定を定義する一般的なシナリオをいくつか紹介します。

初期化時に設定を行う

W&B run としてデータを Sync してログするバックグラウンドプロセスを生成するには、wandb.init() API を呼び出す際に、スクリプトの先頭で辞書を渡します。次のコードスニペットでは、設定値を含む Python の辞書を定義する方法と、W&B run を初期化する際にその辞書を引数として渡す方法を示します。

import wandb

# 設定の辞書オブジェクトを定義する
config = {
    "hidden_layer_sizes": [32, 64],
    "kernel_sizes": [3],
    "activation": "ReLU",
    "pool_sizes": [2],
    "dropout": 0.5,
    "num_classes": 10,
}

# W&B を初期化する際に設定の辞書を渡す
with wandb.init(project="config_example", config=config) as run:
    ...

config として入れ子の辞書を渡すと、W&B はキー名をドット区切りのフラットな形式にします。その辞書の値には、Python で他の辞書にアクセスするのと同様にアクセスできます:

# インデックス値としてキーを使って値にアクセスする
hidden_layer_sizes = run.config["hidden_layer_sizes"]
kernel_sizes = run.config["kernel_sizes"]
activation = run.config["activation"]

# Python の辞書の get() メソッド
hidden_layer_sizes = run.config.get("hidden_layer_sizes")
kernel_sizes = run.config.get("kernel_sizes")
activation = run.config.get("activation")

Developer Guideと各例では、設定値を別々の変数にコピーしています。このstepは任意です。可読性を高めるために行っています。

argparseで設定する

argparse オブジェクトを使用して設定できます。argparse は argument parser の略で、Python 3.2 以降で利用できる標準ライブラリモジュールです。コマンドライン引数の柔軟性と機能を活かしたスクリプトを簡単に作成できます。これは、コマンドラインから起動したスクリプトの結果をトラッキングする場合に役立ちます。次の Python スクリプトは、実験の設定を定義して適用するための parser オブジェクトの定義方法を示しています。関数 train_one_epoch と evaluate_one_epoch は、このデモ用にトレーニングループを模擬するためのものです。

# config_experiment.py
import argparse
import random

import numpy as np
import wandb


# トレーニングと評価のデモコード
def train_one_epoch(epoch, lr, bs):
    acc = 0.25 + ((epoch / 30) + (random.random() / 10))
    loss = 0.2 + (1 - ((epoch - 1) / 10 + random.random() / 5))
    return acc, loss


def evaluate_one_epoch(epoch):
    acc = 0.1 + ((epoch / 20) + (random.random() / 10))
    loss = 0.25 + (1 - ((epoch - 1) / 10 + random.random() / 6))
    return acc, loss


def main(args):
    # W&B Run を開始する
    with wandb.init(project="config_example", config=args) as run:
        # 設定辞書から値を取得して、読みやすいように
        # 変数に格納する
        lr = run.config["learning_rate"]
        bs = run.config["batch_size"]
        epochs = run.config["epochs"]

        # トレーニングを模擬して W&B に値をログする
        for epoch in np.arange(1, epochs):
            train_acc, train_loss = train_one_epoch(epoch, lr, bs)
            val_acc, val_loss = evaluate_one_epoch(epoch)

            run.log(
                {
                    "epoch": epoch,
                    "train_acc": train_acc,
                    "train_loss": train_loss,
                    "val_acc": val_acc,
                    "val_loss": val_loss,
                }
            )


if __name__ == "__main__":
    parser = argparse.ArgumentParser(
        formatter_class=argparse.ArgumentDefaultsHelpFormatter
    )

    parser.add_argument("-b", "--batch_size", type=int, default=32, help="Batch size")
    parser.add_argument(
        "-e", "--epochs", type=int, default=50, help="Number of training epochs"
    )
    parser.add_argument(
        "-lr", "--learning_rate", type=float, default=0.001, help="Learning rate"
    )

    args = parser.parse_args()
    main(args)

スクリプト全体で設定する

config オブジェクトには、スクリプト全体を通してさらにパラメーターを追加できます。次のコードスニペットは、既存の config オブジェクトに新しいキーと値のペアを追加する方法を示しています。

import wandb

# 設定の辞書オブジェクトを定義する
config = {
    "hidden_layer_sizes": [32, 64],
    "kernel_sizes": [3],
    "activation": "ReLU",
    "pool_sizes": [2],
    "dropout": 0.5,
    "num_classes": 10,
}

# W&B を初期化するときに config 辞書を渡す
with wandb.init(project="config_example", config=config) as run:
    # W&B を初期化した後に config を更新する
    run.config["epochs"] = 4
    run.config["batch_size"] = 32

一度に複数の値を追加できます。次のコードスニペットは、既存の config オブジェクト内の複数のキーと値のペアを更新する方法を示しています。

# 設定の辞書オブジェクトを定義する
config = {
    "channels": 24,
    "lr": 1.0,
}

with wandb.init(project="config_example", config=config) as run:
    run.config.update(
        {
            "lr": 0.1,
            "channels": 16,
        },
        allow_val_change=True,
    )

既存のキーの値を更新する場合は、allow_val_change=True を設定してください。このパラメーターを設定しないと、既存のキーの値を更新しようとした際に W&B でエラーが発生します。

run の完了後に設定する

完了した run の設定を更新するには、W&B Public API を使用します。 API には、entity、プロジェクト名、run の ID を渡す必要があります。これらの情報は、Run オブジェクトまたは W&B App で確認できます。

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

# 以下の値は、現在のスクリプトまたはノートブックから開始した Run オブジェクトから取得するか、
# W&B App の UI からコピーしてください。
username = run.entity
project = run.project
run_id = run.id

# api.run() は wandb.init() とは異なるタイプのオブジェクトを返すことに注意してください。
api = wandb.Api()
api_run = api.run(f"{username}/{project}/{run_id}")
api_run.config["bar"] = 32
api_run.update()

設定値をハイライトする

run の概要ページ上部にある References セクションに、設定キーをピン留めできます。 Python SDK で 1 つ以上の設定キーをピン留めするには、wandb.Run.pin_config_keys を使用します。たとえば、Grafana ダッシュボードを使用してトレーニング用の run を監視している場合は、ダッシュボードの URL を設定に追加し、grafana_url キーをピン留めします。

config = {
    "hidden_layer_sizes": [32, 64],
    "kernel_sizes": [3],
    "activation": "ReLU",
    "pool_sizes": [2],
    "dropout": 0.5,
    "num_classes": 10,
    "grafana_url": "[Grafana dashboard](https://my-grafana-instance.com/)"
}

with wandb.init(config=config) as run:
    # "grafana_url" 設定キーを References セクションに追加する。
    run.pin_config_keys(["grafana_url"])

設定値を表示する

W&B App、run の実行中、または既存の run から設定値にアクセスできます。ローカルファイルシステムから設定値にアクセスすることもできます。

W&B App
run の実行中
既存の run
ローカルファイルシステム

W&B App で run の設定を表示するには、次の手順に従います。

W&B App でプロジェクトにアクセスします。
表示する run を選択します。
Overview タブを選択します。
Config セクションまでスクロールします。
任意で、View raw data をクリックして設定を JSON 形式で表示します。

生の JSON 形式は、設定値、ログされたメトリクス、summary 値を使用して折れ線グラフを作成または変換する式を記述する際に便利です。詳細については、Expressions を参照してください。

wandb.Run.config プロパティを使用すると、run の実行中に設定値にアクセスできます。wandb.Run.config は、設定のキーと値のペアを含む辞書オブジェクトを返します。次の例は、run の実行中に設定値にアクセスする方法を示しています。設定辞書内の値をご自身のハイパーパラメーター、モデルアーキテクチャ、データセット名、その他の設定に置き換えてください。"<my-project>" は W&B のプロジェクト名に置き換えてください。

import wandb

config = {
    "epochs": 100,
    "learning_rate": 0.001,
    "model_type": "CNN",
    "dataset_id": "cats-0192"
}

with wandb.init(project="<my-project>", config=config) as run:
  print(dict(run.config))

次のスニペットは、上記のコードを実行したときのターミナル出力例を示しています。

{'_runtime': 0.0970615, '_step': 97, 'accuracy': 0.9746484067793967, 'loss': 0.025044765547545846, '_timestamp': 1785255343.65151}

W&B Public API を使用して、以前にログされた run の設定にアクセスできます。entity、プロジェクト名、run ID を wandb.Api.run() に渡してから、wandb.Api.Run.config プロパティで run の設定にアクセスします。次の例の "<entity>"、"<project>"、"<run_id>" を、それぞれ W&B entity、プロジェクト名、run ID に置き換えてください。

import wandb

api = wandb.Api()
run = api.run("<entity>/<project>/<run_id>")

print(run.name)
print(run.config)

プロジェクト内の複数の run の設定値にアクセスするには、wandb.Api.runs() を使用して Runs を取得し、返された Run オブジェクトを反復処理します。

import wandb

api = wandb.Api()
runs = api.runs("<entity>/<project>")

for run in runs:
    print(f"Run name: {run.name}")
    print(f"Run ID: {run.id}")
    print(f"Run config: {run.config}")
    print("----------")

次のスニペットは、上記のコードを実行したときのターミナル出力例を示しています。

Run name: clean-oath-11
Run ID: mt2dasoz
Run config: {'epochs': 1000, 'learning_rate': 0.1, 'model_type': 'Multivariate_neural_network_classifier'}
----------

Run name: zesty-snowball-7
Run ID: qne08r7u
Run config: {'epochs': 1000, 'learning_rate': 0.1, 'model_type': 'Multivariate_neural_network_classifier'}
----------

W&B は、run ディレクトリ内の config.yaml ファイルに run の設定値を保存します。ローカルで設定値を読み取るには、config.yaml ファイルを開きます。デフォルトでは、run ディレクトリは ./wandb/run-<timestamp>-<run_id> にあります。

ファイルベースの設定

config-defaults.yaml という名前のファイルを run スクリプトと同じディレクトリに配置すると、run はそのファイルで定義されたキーと値のペアを自動的に読み取り、wandb.Run.config に渡します。次のコードスニペットは、config-defaults.yaml YAML ファイルのサンプルを示しています。

batch_size:
  desc: Size of each mini-batch
  value: 32

config-defaults.yaml から自動的に読み込まれるデフォルト値は、wandb.init() の config 引数に更新した値を設定することで上書きできます。たとえば、

import wandb

# カスタム値を渡して config-defaults.yaml を上書きする
with wandb.init(config={"epochs": 200, "batch_size": 64}) as run:
    ...

config-defaults.yaml 以外の設定ファイルを読み込むには、--configs コマンドライン引数を使用し、ファイルのパスを指定します:

python train.py --configs other-config.yaml

config 内のネストされた辞書

run config にネストされた値を保存するには、ネストされた辞書を wandb.init() に渡します。次の例では、config 内にネストされた optimizer 辞書と training 辞書を定義しています。

config = {
    "optimizer": {
        "type": "adamw",
        "learning_rate": 0.0001,
        "weight_decay": 0.01,
    },
    "training": {
        "epochs": 20,
        "batch_size": 64,
    },
}

with wandb.init(project="project", config=config) as run:
    ...

各トップレベルキーには value フィールドが必要です。ネストされた辞書は value に割り当てます:

optimizer:
  value:
    type: adamw
    learning_rate: 0.0001
    weight_decay: 0.01

training:
  value:
    epochs: 20
    batch_size: 64

Python では、dict のインデックス指定を使用してネストされた値にアクセスします。次の例では、run config 内のネストされた optimizer の dict から learning_rate の値を取得します。

with wandb.init(project="project", config=config) as run:
    run.config["optimizer"]["learning_rate"]

Public API のフィルターや折れ線グラフの式など、設定値をパスで参照するコンテキストでは、ドット記法を使用します。たとえば、Public API のフィルターでは config.optimizer.learning_rate、折れ線グラフの式では ${config:optimizer.learning_rate} を使用します。次の例では、ネストされた設定を持つ run を作成し、トレーニングのエポックごとに損失をログします。さらに Public API を使用して学習率が 1e-4 の runs を検索し、各 run の名前と学習率を出力します。

import random
import wandb

config = {
    "optimizer": {
        "type": "adamw",
        "learning_rate": 1e-4,
        "weight_decay": 0.01,
    },
    "training": {
        "epochs": 3,
        "batch_size": 64,
    },
}

with wandb.init(project="nested-config-example", config=config) as run:
    lr = run.config["optimizer"]["learning_rate"]

    for epoch in range(run.config["training"]["epochs"]):
        loss = 1.0 / (epoch + 1) + random.random() * 0.05
        run.log({"epoch": epoch, "train/loss": loss})

api = wandb.Api()
runs = api.runs(
    "wandb/nested-config-example",
    filters={"config.optimizer.learning_rate": 1e-4},
)

for run in runs:
    print(run.name, run.config["optimizer"]["learning_rate"])

実際の運用では、通常は run の作成とフィルターによるクエリを別々のスクリプトで行います。

ファイルベースの設定の使用例

run に関するメタデータを含む YAML ファイルと、Python スクリプト内のハイパーパラメーターの辞書があるとします。これらは両方とも、ネストされた config オブジェクトに保存できます。

hyperparameter_defaults = dict(
    dropout=0.5,
    batch_size=100,
    learning_rate=0.001,
)

config_dictionary = dict(
    yaml=my_yaml_file,
    params=hyperparameter_defaults,
)

with wandb.init(config=config_dictionary) as run:
    ...

TensorFlow v1 フラグ

TensorFlow のフラグは、wandb.Run.config オブジェクトに直接渡せます。

with wandb.init() as run:
    run.config.epochs = 4

    flags = tf.app.flags
    flags.DEFINE_string("data_dir", "/tmp/data")
    flags.DEFINE_integer("batch_size", 128, "Batch size.")
    run.config.update(flags.FLAGS)  # TensorFlow のフラグを設定に追加

ガイド

インテグレーション

リファレンス

実験の設定を行う

初期化時に設定を行う

argparseで設定する

スクリプト全体で設定する

run の完了後に設定する

設定値をハイライトする

設定値を表示する

ファイルベースの設定

config 内のネストされた辞書

ファイルベースの設定の使用例

TensorFlow v1 フラグ

​実験の設定を行う

​初期化時に設定を行う

​argparseで設定する

​スクリプト全体で設定する

​run の完了後に設定する

​設定値をハイライトする

​設定値を表示する

​ファイルベースの設定

​config 内のネストされた辞書

​ファイルベースの設定の使用例

​TensorFlow v1 フラグ

実験の設定を行う

初期化時に設定を行う

argparseで設定する

スクリプト全体で設定する

run の完了後に設定する

設定値をハイライトする

設定値を表示する

ファイルベースの設定

config 内のネストされた辞書

ファイルベースの設定の使用例

TensorFlow v1 フラグ