Hydra

Hydra と W&B を統合して、機械学習実験向けの複雑な設定を管理し、ハイパーパラメーターを自動的にログします。

Hydra は、研究用途やそのほかの複雑なアプリケーションの開発を簡素化するオープンソースの Python フレームワークです。主な機能は、設定を組み合わせて階層的な設定を動的に作成し、設定ファイルやコマンドラインからそれをオーバーライドできることです。

設定管理には引き続き Hydra を使用しながら、W&B の強力な機能も活用できます。

​

メトリクスをトラッキングする

通常どおり、wandb.init() と wandb.Run.log() を使ってメトリクスをログします。ここでは、wandb.entity と wandb.project は Hydra の設定ファイル内で定義されています。

import wandb


@hydra.main(config_path="configs/", config_name="defaults")
def run_experiment(cfg):

    with wandb.init(entity=cfg.wandb.entity, project=cfg.wandb.project) as run:
      run.log({"loss": loss})

​

ハイパーパラメーターをトラッキングする

Hydra は、設定辞書を扱うためのデフォルトのインターフェースとして OmegaConf を使用します。OmegaConf の設定オブジェクト (たとえば omegaconf.DictConfig) は、通常の Python の dict インスタンスではありません。

wandb.Run.config は読み取り専用のプロパティであるため、OmegaConf の設定オブジェクトを渡そうとして wandb.Run.config = ... を実行すると、AttributeError が発生します。

OmegaConf.to_container() を使って cfg を通常の dict に変換し、それを wandb.init(config=...) に渡してください (または wandb.Run.config.update(...) を呼び出してください) 。

import hydra
import omegaconf
import wandb


@hydra.main(version_base=None, config_path="configs/", config_name="defaults")
def run_experiment(cfg):
    cfg_dict = omegaconf.OmegaConf.to_container(
        cfg, resolve=True, throw_on_missing=True
    )
    # オプション: W&B のメタデータ（entity/project など）を run の設定としてログしないようにする
    cfg_dict.pop("wandb", None)
    with wandb.init(
        entity=cfg.wandb.entity,
        project=cfg.wandb.project,
        config=cfg_dict,
    ) as run:
        run.log({"loss": loss})
        model = Model(**run.config["model"]["configs"])

​

マルチプロセシングのトラブルシューティング

プロセスの起動時にハングする場合は、この既知の問題が原因の可能性があります。これを解決するには、次のように wandb.init() に settings パラメーターを追加して、wandb のマルチプロセシングプロトコルを変更してみてください。

wandb.init(settings=wandb.Settings(start_method="thread"))

または、シェルからグローバル環境変数を設定することでも可能です。

$ export WANDB_START_METHOD=thread

​

ハイパーパラメーターを最適化する

W&B Sweeps は、高い拡張性を備えたハイパーパラメーター探索プラットフォームです。最小限のコード変更で、W&B Experiments に関する有益なインサイトや可視化を提供します。Sweeps は、コーディング不要で Hydra プロジェクトにシームレスに統合できます。必要なのは、通常どおり sweep 対象となる各種パラメーターを記述した設定ファイルだけです。

シンプルな sweep.yaml ファイルの例を次に示します。

program: main.py
method: bayes
metric:
  goal: maximize
  name: test/accuracy
parameters:
  dataset:
    values: [mnist, cifar10]

command:
  - ${env}
  - python
  - ${program}
  - ${args_no_hyphens}

sweep を起動します:

wandb sweep sweep.yaml

W&B はプロジェクト内に自動的に sweep を作成し、sweep を実行する各マシンで実行する wandb agent コマンドを返します。

​

Hydra のデフォルト設定にないパラメーターを渡す

Hydra では、デフォルトの設定ファイルにない追加のパラメーターを、コマンドの前に + を付けることでコマンドライン経由で渡せます。たとえば、追加のパラメーターに値を指定するには、次のように呼び出します。

$ python program.py +experiment=some_experiment

Hydra Experiments の設定時のように、この種の + 設定に対して sweep を実行することはできません。これを回避するには、experiment パラメーターをデフォルトの空ファイルで初期化し、各 call でそれらの空の設定を上書きするように W&B Sweep を使用します。詳細については、こちらの W&B Reportを参照してください。