Copyright (C) 2016-2021 AutoML Group
Attention: This package is a reimplementation of the original SMAC tool (see reference below). However, the reimplementation slightly differs from the original SMAC. For comparisons against the original SMAC, we refer to a stable release of SMAC (v2) in Java which can be found here.
The documentation can be found here.
Status for master branch:
Status for the development branch
Try SMAC directly in your Browser
SMAC is a tool for algorithm configuration to optimize the parameters of arbitrary algorithms across a set of instances. This also includes hyperparameter optimization of ML algorithms. The main core consists of Bayesian Optimization in combination with an aggressive racing mechanism to efficiently decide which of two configurations performs better.
For a detailed description of its main idea, we refer to
Hutter, F. and Hoos, H. H. and Leyton-Brown, K.
Sequential Model-Based Optimization for General Algorithm Configuration
In: Proceedings of the conference on Learning and Intelligent OptimizatioN (LION 5)
SMAC v3 is written in Python3 and continuously tested with Python 3.7, 3.8 and 3.9. Its Random Forest is written in C++.
Besides the listed requirements (see requirements.txt), the random forest
used in SMAC3 requires SWIG as a build dependency:
apt-get install swig
On Arch Linux (or any distribution with swig4 as default implementation):
pacman -Syu swig3
ln -s /usr/bin/swig-3 /usr/bin/swig
SMAC3 is available on PyPI.
pip install smac
git clone https://github.com/automl/SMAC3.git && cd SMAC3
cat requirements.txt | xargs -n 1 -L 1 pip install
pip install .
If you use Anaconda as your Python environment, you have to install three packages before you can install SMAC:
conda install gxx_linux-64 gcc_linux-64 swig
SMAC3 comes with a set of optional dependencies that can be installed using setuptools extras:
lhd: Latin hypercube designgp: Gaussian process models
These can be installed from PyPI or manually:
# from PyPI
pip install smac[gp]
# manually
pip install .[gp,lhd]
For convenience, there is also an all meta-dependency that installs all optional dependencies:
pip install smac[all]
This program is free software: you can redistribute it and/or modify it under the terms of the 3-clause BSD license (please see the LICENSE file).
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
You should have received a copy of the 3-clause BSD license along with this program (see LICENSE file). If not, see https://opensource.org/licenses/BSD-3-Clause.
The usage of SMAC v3 is mainly the same as provided with SMAC v2.08. It supports the same parameter configuration space syntax (except for extended forbidden constraints) and interface to target algorithms.
Please see an overview of all examples in our documentation.
SMAC3 is developed by the AutoML Groups of the Universities of Hannover and Freiburg.
If you found a bug, please report to https://github.com/automl/SMAC3/issues.
Our guidelines for contributing to this package can be found here