Version 0.3 (#20)

## General
- Updated tools.
- Cleaned up (removed docker files).

## Installation
- Checks if redis-server is installed. Otherwise, aborts to start the server.
- Added swig to anaconda environment.
- Increased version of numpy and matplotlib.
- Improved requirements. Fixed only crucical things.

## Run
- Added model support.

## Plugins
- Added button to receive raw data.
- Added new plugin: Pareto Front.
- Added new plugin: Budget Correlation.
- Changed `load_outputs` and `load_mlp_outputs` to class method. Moreover, if
`activate_run_selection` is true, only the the run and runs information in `outputs` is passed.
- Cost Over Time displays maximized objectives correctly now.
- Pre-selecting highest budget and hyperparameters (#18).
- Replaced normalized costs with all costs in configurations.

## Examples
- Added MLP recorder example.
- Added MLP logs for better example visualization.

## Bugfixes
- Fixed path bug for SMAC and BOHB.
- Included `start.sh`.
- pytest no longer needed in main code.
- Included logging.yml (before it was loggin.yml).
- Recorder works again.

## Docs
- Added documentation with most basic information.

Author: renesass

.flake8

@@ -6,7 +6,5 @@ extend-exclude =
     .venv
     build
 extend-ignore =
-    # No whitespace before ':' in [x : y]
-    E203
-    # No lambdas — too strict
-    E731
+    E203  # No whitespace before ':' in [x : y]
+    E731  # No lambdas — too strict

.github/workflows/docs.yml

@@ -0,0 +1,69 @@
+name: docs
+
+on:
+  # Trigger manually
+  workflow_dispatch:
+
+  # Trigger on any push to the master
+  push:
+    branches:
+      - main
+
+  # Trigger on any push to a PR that targets master
+  pull_request:
+    branches:
+      - main
+
+env:
+  name: DeepCAVE
+
+jobs:
+  build-and-deploy:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+
+    - name: Setup Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.8
+
+    - name: Install dependencies
+      run: |
+        pip install -e ".[dev]"
+
+    - name: Make docs
+      run: |
+        make docs
+
+    - name: Make Examples
+      run: |
+        make examples
+
+    - name: Pull latest gh-pages
+      if: (contains(github.ref, 'main'))
+      run: |
+        cd ..
+        git clone https://github.com/automl/${{ env.name }}.git --branch gh-pages --single-branch gh-pages
+
+    - name: Copy new docs into gh-pages
+      if: (contains(github.ref, 'development') || contains(github.ref, 'main'))
+      run: |
+        branch_name=${GITHUB_REF##*/}
+        cd ../gh-pages
+        rm -rf $branch_name
+        cp -r ../${{ env.name }}/docs/build/html $branch_name
+
+    - name: Push to gh-pages
+      if: (contains(github.ref, 'main'))
+      run: |
+        last_commit=$(git log --pretty=format:"%an: %s")
+        cd ../gh-pages
+        branch_name=${GITHUB_REF##*/}
+        git add $branch_name/
+        git config --global user.name 'Github Actions'
+        git config --global user.email '[email protected]'
+        git remote set-url origin https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}
+        git commit -am "$last_commit"
+        git push

.github/workflows/pre-commit.yml

@@ -0,0 +1,39 @@
+name: pre-commit
+
+on:
+  # Manually triggerable in github
+  workflow_dispatch:
+
+  # When a push occurs on either of these branches
+  push:
+    branches:
+      - main
+      - development
+
+  # When a push occurs on a PR that targets these branches
+  pull_request:
+    branches:
+      - main
+      - development
+
+jobs:
+  run-all-files:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        submodules: recursive
+
+    - name: Setup Python 3.8
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.8
+
+    - name: Install pre-commit
+      run: |
+        pip install pre-commit
+        pre-commit install
+    - name: Run pre-commit
+      run: |
+        pre-commit run --all-files

.github/workflows/pytest.yml

@@ -10,14 +10,17 @@ jobs:
         run: |
           # $CONDA is an environment variable pointing to the root of the miniconda directory
           echo $CONDA/bin >> $GITHUB_PATH
-      - name: Setup Python 3.9
+
+      - name: Setup Python 3.8
         uses: actions/setup-python@v2
         with:
-          python-version: 3.9
+          python-version: 3.8
+
       - name: Install dependencies
         run: |
           conda env update --file environment.yml --name base
           pip install .
           pip install .[dev]
+          
       - name: Run pytest 
         run: pytest tests

.gitignore

@@ -1,23 +1,170 @@
-build/*
-*cache*
-!*cache.py
-!*caches.py
-__pycache__
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+docs/api
+docs/examples
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
+.vscode
+
+# Additional
+.DS_Store
 *.rdb
-examples/logs/SMAC
-examples/logs/BOHB
+*.pth
+
+# SMAC
 smac3-output*
-.DS_Store
-__init__.pyc
-examples/logs*
-examples/*
-!examples/logs/DeepCAVE
-!examples/record
-examples/record/_*.py
-*.sh
-!run.sh
-.vscode
-*.egg-info
-docs/apidoc
-docs/html
-docs/pages/examples
+
+# DeepCAVE 
+cache
+examples/others
+examples/record/_*
+datasets
+lightning_logs