-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #29 from rdnfn/dev/general
v0.4.0
- Loading branch information
Showing
57 changed files
with
1,631 additions
and
508 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| // For format details, see https://aka.ms/devcontainer.json. For config options, see the README at: | ||
| // https://github.com/microsoft/vscode-dev-containers/tree/v0.205.2/containers/python-3 | ||
| { | ||
| "name": "beobench_devcontainer_remote", | ||
| "build": { | ||
| "dockerfile": "../../Dockerfile", | ||
| "context": "../../..", | ||
| "args": { | ||
| // Update 'VARIANT' to pick a Python version: 3, 3.10, 3.9, 3.8, 3.7, 3.6 | ||
| // Append -bullseye or -buster to pin to an OS version. | ||
| // Use -bullseye variants on local on arm64/Apple Silicon. | ||
| "VARIANT": "3.9", | ||
| // Options | ||
| "NODE_VERSION": "none", | ||
| "NVIDIA_SUPPORT": "True", | ||
| } | ||
| }, | ||
| "workspaceFolder": "/beobench", | ||
| // "workspaceMount": "source=remote-workspace,target=/workspace,type=volume", | ||
| // ADAPT: the mount must be adapted to cloned repo location | ||
| "workspaceMount": "source=/home/rdnfn-docker/main/repos/github/beobench/,target=/beobench/,type=bind,consistency=cached", | ||
| // ADAPT: the mount must be adapted to the gitconfig location on the remote machine | ||
| "mounts": [ | ||
| "source=/home/rdnfn-docker/.gitconfig,target=/root/.gitconfig,type=bind,consistency=cached", | ||
| ], | ||
| "postCreateCommand": "pip install -e .", | ||
| // Set *default* container specific settings.json values on container create. | ||
| "settings": { | ||
| "python.defaultInterpreterPath": "/usr/local/bin/python", | ||
| "python.linting.enabled": true, | ||
| "python.linting.pylintEnabled": true, | ||
| "python.formatting.autopep8Path": "/usr/local/py-utils/bin/autopep8", | ||
| "python.formatting.blackPath": "/usr/local/py-utils/bin/black", | ||
| "python.formatting.yapfPath": "/usr/local/py-utils/bin/yapf", | ||
| "python.linting.banditPath": "/usr/local/py-utils/bin/bandit", | ||
| "python.linting.flake8Path": "/usr/local/py-utils/bin/flake8", | ||
| "python.linting.mypyPath": "/usr/local/py-utils/bin/mypy", | ||
| "python.linting.pycodestylePath": "/usr/local/py-utils/bin/pycodestyle", | ||
| "python.linting.pydocstylePath": "/usr/local/py-utils/bin/pydocstyle", | ||
| "python.linting.pylintPath": "/usr/local/py-utils/bin/pylint", | ||
| "files.trimTrailingWhitespace": true, | ||
| "python.formatting.provider": "black", | ||
| "editor.formatOnSave": true, | ||
| "editor.rulers": [ | ||
| 88 | ||
| ] | ||
| }, | ||
| // Add the IDs of extensions you want installed when the container is created. | ||
| "extensions": [ | ||
| "ms-python.python", | ||
| "ms-python.vscode-pylance", | ||
| "ms-azuretools.vscode-docker", | ||
| "trond-snekvik.simple-rst", | ||
| "lextudio.restructuredtext", | ||
| "njpwerner.autodocstring" | ||
| ], | ||
| // Use 'forwardPorts' to make a list of ports inside the container available locally. | ||
| // "forwardPorts": [], | ||
| // Use 'postCreateCommand' to run commands after the container is created. | ||
| // "postCreateCommand": "pip3 install --user -r requirements.txt", | ||
| // Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root. | ||
| // "remoteUser": "vscode", | ||
| "features": { | ||
| "git": "latest", | ||
| "docker-in-docker": { | ||
| "version": "latest", | ||
| "moby": true | ||
| } | ||
| }, | ||
| "runArgs": [ | ||
| "--shm-size=32gb", | ||
| "--gpus=all", | ||
| ] | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,15 +1,8 @@ | ||
| * beobench version: | ||
| * Python version: | ||
| * Operating System: | ||
|
|
||
| ### Description | ||
| ### Problem | ||
|
|
||
| Describe what you were trying to get done. | ||
| Tell us what happened, what went wrong, and what you expected to happen. | ||
|
|
||
| ### What I Did | ||
| ### Potential Solution | ||
|
|
||
| ``` | ||
| Paste the command(s) you ran and the output. | ||
| If there was a crash, please include the traceback here. | ||
| ``` | ||
| Describe a potential solution to the problem, if you have any. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| [submodule "beobench_contrib"] | ||
| path = beobench_contrib | ||
| url = https://github.com/rdnfn/beobench_contrib.git |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,13 +1,4 @@ | ||
| ======= | ||
| Credits | ||
| ======= | ||
|
|
||
| Development Lead | ||
| ---------------- | ||
|
|
||
| * rdnfn <-> | ||
|
|
||
| Contributors | ||
| ------------ | ||
|
|
||
| None yet. Why not be the first? | ||
| Code Contributors | ||
| ----------------- | ||
| * Arduin Findeis (https://github.com/rdnfn) | ||
| * Scott Jeen (https://github.com/enjeeneer) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,84 +1,3 @@ | ||
| .. image:: https://github.com/rdnfn/beobench/raw/master/docs/_static/beobench_logo.png | ||
| :align: center | ||
| :width: 300 px | ||
| :alt: Beobench | ||
|
|
||
| .. start-in-sphinx-docs | ||
| .. image:: https://img.shields.io/pypi/v/beobench.svg | ||
| :target: https://pypi.python.org/pypi/beobench | ||
|
|
||
| .. image:: https://readthedocs.org/projects/beobench/badge/?version=latest | ||
| :target: https://beobench.readthedocs.io/en/latest/?version=latest | ||
| :alt: Documentation Status | ||
|
|
||
| .. image:: https://img.shields.io/badge/License-MIT-blue.svg | ||
| :target: https://opensource.org/licenses/MIT | ||
| :alt: License | ||
|
|
||
| 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 <https://github.com/ibpsa/project1-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 <https://github.com/ray-project/ray/tree/master/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 <https://docs.ray.io/en/master/tune/index.html>`_. | ||
| - *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. | ||
|
|
||
| .. _Weights and Biases: https://wandb.ai/ | ||
|
|
||
| .. end-in-sphinx-docs | ||
| .. start-quickstart | ||
| Quickstart | ||
| ---------- | ||
|
|
||
| Run your first beobench experiment in three steps: | ||
|
|
||
| 1. `Install docker <https://docs.docker.com/get-docker/>`_ on your machine (if on Linux, check the `additional installation steps <https://beobench.readthedocs.io/en/latest/guides/installation_linux.html>`_) | ||
| 2. Install *beobench* using: | ||
|
|
||
| .. code-block:: console | ||
| pip install beobench | ||
| 3. Finally, start your first experiment using: | ||
|
|
||
| .. code-block:: console | ||
| python -m beobench.experiment.scheduler | ||
| Done, you have just started your first experiment... congrats! Check out the `full getting started guide in the documentation <https://beobench.readthedocs.io/en/latest/guides/getting_started.html>`_ for the next steps. | ||
|
|
||
| .. end-quickstart | ||
| Documentation | ||
| ------------- | ||
| https://beobench.readthedocs.io | ||
|
|
||
| License | ||
| ------- | ||
| MIT license | ||
|
|
||
|
|
||
|
|
||
| Credits | ||
| ------- | ||
|
|
||
| This package was originally created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template. | ||
|
|
||
| .. _Cookiecutter: https://github.com/audreyr/cookiecutter | ||
| .. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage | ||
|
|
||
| For more information go to the `documentation <https://beobench.readthedocs.io/>`_ and the `GitHub code repository <https://github.com/rdnfn/beobench>`_. |
Oops, something went wrong.