Skip to main content

Package for declarative hyperparameter search experiments.

Project description

Declair :cake:

pipeline status coverage report

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.


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


You can install Declair via pip.

pip install declair

Running the tests

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

python -m pytest


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.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

declair-0.1.5.tar.gz (42.2 kB view hashes)

Uploaded Source

Built Distribution

declair-0.1.5-py3-none-any.whl (54.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page