Beobench is a toolbox for benchmarking reinforcement learning (RL) algorithms on building energy optimisation (BEO) problems.
Project description
A toolbox for benchmarking reinforcement learning (RL) algorithms on building energy optimisation (BEO) problems. Beobench tries to make working on RL for BEO easier: it provides simple access to existing libraries defining BEO problems (such as BOPTEST) and provides a large set of pre-configured RL algorithms. Beobench is not a gym library itself - instead it leverages the brilliant work done by many existing gym-type projects and makes their work more easily accessible.
Features
Some of the features are work in progress
Main features
RL algorithm collection: what’s the best RL method for your BEO problem? Building on Ray RLlib, beobench provides a large collection of pre-configured RL algorithm experiments that can be easily applied to your new BEO problem.
Problem collection: beobench provides ready-to-use docker containers for popular BEO gym-type problem libraries. By enforcing a strict OpenAI gym.Env it makes testing your method on different libraries easy.
Additional features
Experiment logging: log experiment results in a reproducible and shareable manner via Weights and Biases.
Hyperparameter tuning: easily tune hyperparameters using the extensive Ray Tune Search API.
Simple installation: beobench can be installed via pip and only requires docker as an additional non-python dependency.
Easily extendable: beobench is designed for the user to add both environments and methods.
Quickstart
Run your first beobench experiment in three steps:
Install docker on your machine (if on Linux, check the additional installation steps)
Install beobench using:
pip install beobench
Finally, start your first experiment using:
python -m beobench.experiment.scheduler
Done, you have just started your first experiment… congrats! Check out the full getting started guide in the documentation for the next steps.
Documentation
License
MIT license
Credits
This package was originally created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.
History
0.2.0 (2022-01-18)
Enable adding custom environments to beobench with docker build context-based syntax
Save experiment results on host machine
Major improvements to documentation
Remove unnecessary wandb arguments in main CLI
0.1.0 (2022-01-10)
First release on PyPI.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for beobench-0.2.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 71dc82794944f2a61e1bc20643a1cc75eac0ff9269bd6ca69d6dfcde93ab88e1 |
|
MD5 | cad95f1e408ec8a6101ad02d431b9fd2 |
|
BLAKE2b-256 | 9fafaa2f6be82afde744c68ed6832d8c08cb8c4ca677358444510197676eb2aa |