README_JP.md

aiaccel: an HPO library for ABCI

AI橋渡しクラウドABCI向けハイパーパラメータ最適化ライブラリ。 ランダムサーチ、グリッドサーチ、Sobol列、Nelder-Mead法、およびベイズ最適化法 (TPE)をサポートしています。

インストール

本ソフトウェアは下記コマンドでインストールできます。

> pip install git+https://github.com/aistairc/aiaccel.git

実行例

ローカル環境で実行する場合

0. (オプション) Virtualenvをインストールし、仮想環境を作成します。

   > python3 -m venv optenv
   > source optenv/bin/activate

1. aiaccelをインストールします

   > pip install git+https://github.com/aistairc/aiaccel.git

2. ワークスペースを作成し、sphereディレクトリをコピーします。

   > mkdir your_workspace_directory
   > cd your_workspace_directory
   > git clone https://github.com/aistairc/aiaccel.git 
   > cp -R ./aiaccel/examples .
   > cd examples
   > ls
   sphere
   
   > cd sphere
   > ls
   config.yaml         user.py

3. パラメータ最適化を実行します。

   > aiaccel-start --config config.yaml

   または、

   > python -m aiaccel.cli.start --config config.yaml

   Tips: ワークスペースは --clean を付加することで実行前に初期化できます。

   > aiaccel-start --config config.yaml --clean

4. 結果を確認する。

   > ls ./work
   abci_output         alive               hp                  lock
   log                 result              runner              state
   
   > cat ./work/result/final_result.result

5. 設定を変更したい場合は、config.yamlファイルを編集してください。

   > vi config.yaml

ABCI上で実行する

1. まず、ABCIユーザーズガイドに従って、pythonの環境を構築してください。

   > module load python/3.11/3.11.2
   > python3 -m venv optenv
   > source optenv/bin/activate

2. ワークスペースを用意します．ここからの作業は、ローカル環境で実行する場合の1,2と同じです。

3. config.yamlのresourceをABCIに変更します。

   resource:
       type: "abci"
       num_workers: 4

4. 実行

   > aiaccel-start --config config.yaml

5. 実行中のジョブを確認したい場合は、ABCIユーザーズガイドを参照してください。

その他

• 処理の進捗を確認

  > aiaccel-view --config config.yaml

• 簡易グラフを表示

  > aiaccel-plot --config config.yaml

• workspace/results.csvに結果を出力

  > aiaccel-report --config config.yaml

謝辞

• この成果の一部は、国立研究開発法人新エネルギー・産業技術総合開発機構(NEDO)の委託業務として開発されたものです。
• TPEアルゴリズムは Optuna を利用しました。