Declair :cake:

Declair is a framework for declaratively defining hyperparameter optimization experiments. It uses Sacred for storing experiment results and supports Hyperopt for optimization.

At its core, Declair provides a YAML/JSON based language for defining parameter spaces for hyperparameter search as well as single experiment runs. These parameter spaces can be easily nested and may include Python objects and outputs of function calls.

Declair is focused on reproducibility and ease of use between machines. By the use of Sacred observers, it ensures that results of experiments are safely stored, together with the source code of all classes and objects used in them, as well as the Declair experiment configuration itself. To make reproduction of experiments easy between machines, it supports environment configuration files which can be used to store variables, like local dataset paths or secret tokens.

It contains various features to make defining experiments ergonomic. These include variable handling as well as configuration inheritance.

Usage

For detailed instructions on how to use Declair, see the documentation.

Installation

You can install Declair via pip.

pip install declair

Running the tests

Go into the root of the repository (i.e. where this README.md is), install pip install pytest and run

python -m pytest

Credits

Declair came about from attempts to recreate DeepSolaris results in PyTorch instead of Keras, with a focus on search experiment definition ergonomics and reproducibility. However, it grew to be a more extensive and general framework than originally planned. Its design based on configuration files was heavily inspired by cbds_common.

It is developed with ❤️ at CBDS.