実行環境・必要なパッケージ

PHYSBOの実行環境・必要なパッケージは以下の通りです。
Python 3.6以上で動作します。

  • Python >= 3.6
  • numpy
  • scipy

ダウンロード・インストール方法

  • PyPI を利用する方法(推奨)

以下のコマンドを打ってください。

$ pip3 install physbo

  • ソースコードを利用する方法(開発者向け)

    1. NumPyとCythonをインストールしておきます。 
      $ pip3 install numpy Cython
    2. GitHub からソースコードをクローンします。 
      $ git clone https://github.com/issp-center-dev/PHYSBO
    3. setup.py installでインストールします。 
       $ cd physbo
 $ python3 setup.py install --user
    4. 注意: リポジトリのルートディレクトリでimport physbo を行わないでください。その場合、import physboはインストールされたPHYSBOではなく、Cythonコードがコンパイルされていないリポジトリにあるものをインストールしようとします。

アンインストール方法

  • 以下のコマンドを実行します。 
    pip3 uninstall physbo

PHYSBOの基本構造

PHYSBOは以下のような構成になっています(第2階層まで表示)。

各モジュールは以下のような構成で作成されています。

  • blm :Baysean linear modelに関するモジュール
  • gp :Gaussian Processに関するモジュール
  • opt :最適化に関するモジュール
  • search :最適解を探索するためのモジュール
  • predictor.py :predictorの抽象クラス
  • variable.py :physboで用いる変数関連について定義されたクラス
  • misc : その他(探索空間を正規化するためのモジュールなど)

各モジュールの詳細についてはAPIリファレンスを参考にしてください。