インストール#

Layer 1: Use

動作要件#

依存パッケージの正確なバージョンはpyproject.tomlを参照してください。

pipによるインストールは次のように行います。このインストールでは最小の依存関係のみインストールします。

pip install saealib

すべての依存関係をフルインストールする場合は次のように行います。

pip install "saealib[all]"

オプションの指定についてはこちらを参照してください。

バージョンの指定は次のように行います。

pip install "saealib==X.Y.Z"
# example:
pip install "saealib==0.1.0"

最新のプレリリースバージョンは次のように指定します。

pip install --pre saealib

警告

プレリリースバージョンのAPIは予告なく変更または削除される可能性があります。

一部のパッケージは依存関係を追加することで有効になります。依存関係のインストールは次のようにオプションを指定することで同時にインストールできます。

pip install "saealib[opt1,opt2,...]"
# example:
pip install "saealib[sklearn,parallel]"

すべての依存関係をインストールする場合は次のように指定します。

pip install "saealib[all]"

すべてのオプションは次の表に示す通りです。

オプション	追加される機能
`sklearn`	scikit-learnベースのサロゲートモデル
`xgboost`	XGBoostサロゲートモデル
`lightgbm`	LightGBMサロゲートモデル
`torch`	PyTorchベースのコンポーネント
`pymoo`	`PymooCrossover`/`PymooMutation`/`PymooAlgorithm`/`PymooProblem`アダプタ
`parallel`	joblibによる並列評価
`deap`	DEAPのアルゴリズム・オペレータアダプタ
`viz`	Matplotlibによる結果・履歴のプロット
`tqdm`	実験スイープ向けのtqdmプログレスバー
`rich`	実験スイープ向けのRichプログレスバー
`hdf5`	h5pyによるHDF5形式の試行結果の保存と読み込み
`all`	上記すべてのオプション依存

インストールが完了したら、次のコマンドでバージョンを確認できます。

python -c "import saealib; print(saealib.__version__)"

参考

ソースからの開発用インストールについてはCONTRIBUTING.mdを参照してください。