Run の config プロパティを使用して、トレーニング設定を保存します：
ハイパーパラメーター
データセット名やモデルタイプなどの入力設定
実験におけるその他の独立変数
wandb.Run.config プロパティを使用すると、実験の分析や将来的な再現が容易になります。 W&B App で設定値ごとにグループ化したり、異なる W&B Runs の設定を比較したり、各トレーニング設定が出力にどのように影響するかを評価したりできます。 config プロパティは辞書（dictionary）のようなオブジェクトで、複数の辞書形式のオブジェクトから構成することも可能です。損失（loss）や精度（accuracy）などの出力メトリクスや従属変数を保存する場合は、 wandb.Run.config ではなく wandb.Run.log() を使用してください。
実験設定のセットアップ 通常、設定はトレーニングスクリプトの冒頭で定義されます。ただし、機械学習のワークフローは多岐にわたるため、必ずしもスクリプトの最初に定義する必要はありません。
config の変数名には、ピリオド（.）の代わりにダッシュ（-）またはアンダースコア（_）を使用してください。
スクリプト内でルート階層より下の wandb.Run.config キーにアクセスする場合は、属性アクセス構文 config.key.value ではなく、辞書アクセス構文 ["key"]["value"] を使用してください。
以下のセクションでは、実験設定を定義する際の代表的なシナリオをいくつか紹介します。
初期化時に設定を行う wandb.init() API を呼び出して、データを W&B Run として同期・ログ記録するバックグラウンドプロセスを生成する際に、スクリプトの冒頭で辞書を渡します。以下のコードスニペットは、設定値を含む Python の辞書を定義し、W&B Run を初期化する際にその辞書を引数として渡す方法を示しています。
import wandb # config 辞書オブジェクトを定義 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: ...
ネストされた辞書を 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" )
開発者ガイドや例の中では、可読性のために設定値を個別の変数にコピーしていることがありますが、このステップは任意です。
argparse で設定を行う argparse オブジェクトを使用して設定を行うことができます。 argparse （argument parser の略）は、Python 3.2 以降の標準ライブラリモジュールで、コマンドライン引数の柔軟性とパワーを活かしたスクリプトを簡単に記述できるようにします。
これは、コマンドラインから起動されるスクリプトの結果を追跡するのに便利です。
以下の Python スクリプトは、パーサーオブジェクトを定義して実験 config を設定する方法を示しています。 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: # 可読性のために config 辞書から値を取得し # 変数に格納する 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 = int , default = 0.001 , help = "Learning rate" ) args = parser.parse_args() main(args)
スクリプト全体で設定を行う スクリプトの途中で config オブジェクトにパラメータを追加することができます。以下のコードスニペットは、config オブジェクトに新しいキーと値のペアを追加する方法を示しています。
import wandb # config 辞書オブジェクトを定義 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[ "dropout" ] = 0.2 run.config.epochs = 4 run.config[ "batch_size" ] = 32
複数の値を一度に更新することもできます：
run.config.update({ "lr" : 0.1 , "channels" : 16 })
Run 終了後に設定を行う W&B Public API を使用して、完了した run の config を更新します。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()
absl.FLAGSabsl フラグflags.DEFINE_string( "model" , None , "model to run" ) # 名前、デフォルト値、ヘルプ run.config.update(flags. FLAGS ) # absl フラグを config に追加
ファイルベースの Config 実行スクリプトと同じディレクトリに config-defaults.yaml という名前のファイルを置くと、run は自動的にそのファイルで定義されたキーと値のペアを読み込み、 wandb.Run.config に渡します。
以下のコードスニペットは、 config-defaults.yaml YAML ファイルの例です。
batch_size : desc : 各ミニバッチのサイズ value : 32
wandb.init の config 引数に更新された値を設定することで、 config-defaults.yaml から自動的にロードされたデフォルト値を上書きできます。例：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 のメタデータが含まれる 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 フラグを config として追加
