Merge pull request #114 from automl/development

Update to 1.1.0

.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md

@@ -0,0 +1,37 @@
+---
+name: Issue Template
+about: General template issues
+labels: 
+
+---
+
+* {{ cookiecutter.project_name }} version:
+* Python version:
+* Operating System:
+
+
+<!--
+Please file an issue for bug reports (label as `bug`), usage questions (label as `question`), feature requests (label as `feature request`), to notify us about upcoming contributions and any other topic that you think may be important discussing with us.
+-->
+
+#### Description
+<!-- Describe what you were trying to do -->
+
+#### Steps/Code to Reproduce
+<!--
+Please provide us with a minimal code example to reproduce your issue. If the code is too long, feel free to put it in a public gist and link it in the issue: https://gist.github.com
+-->
+
+#### Expected Results
+<!-- Please paste or describe the expected results.-->
+
+#### Actual Results
+<!-- Please paste or specifically describe the actual output or traceback. If you cannot provide a full traceback, please include the kind of error you encounter as well as where it occurs in the code! -->
+
+#### Additional Info
+
+- Did you try upgrading to the most current version? yes/no
+- Are you using a supported operating system (version)? yes/no
+- How did you install this package (e.g. GitHub, pip, etc.)? 
+
+<!-- Thanks for contributing! -->

.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,39 @@
+<!--
+Thanks for contributing a pull request! Please ensure you have taken a look at the contribution guidelines in the CONTRIBUTING.md
+-->
+
+#### Reference Issues/PRs
+<!--
+Example: Fixes #1234. See also #3456.
+Please use keywords (e.g., Fixes) to create link to the issues or pull requests you resolved, so that they will automatically be closed when your pull request is merged. See https://github.com/blog/1506-closing-issues-via-pull-requests
+-->
+
+#### What does this implement/fix? Explain your changes.
+
+<!--
+Good PR descriptions help us immensely in reviewing and testing your PRs. This will make merging much faster and smoother for everyone involved.
+Examples:
+
+**Good:** Added Documentation -- documented the learning rate feature both in the code and the docs. Also added an example.
+**Bad:** Explained learning rates
+
+**Good:** Dask Parallelization Backend -- parallelization is now possible with dask. This meant some restructuring of the runner backend and testing, but shouldn't change usage at all. 
+**Bad:** new parallel feature
+-->
+
+#### Checklist
+
+- Are the tests passing locally? yes/no
+- Is the pre-commit passing locally? yes/no
+- Are all new features documented in code and docs? yes/no
+- Are all examples still running? yes/no
+- Are the requirements up to date? yes/no
+- Did you add yourself to the contributors in the authors file? yes/no
+
+#### Any other comments?
+
+<!--
+We appreciate your effort, but please be aware that we are not working full-time on this project. We welcome any contribution and value your effort, no matter how minor they are. If we are slow to review, either the pull request needs some benchmarking, tinkering, convincing, etc. or more likely the reviewers are simply busy. In either case, we ask for your understanding during the review process.
+
+Thanks for contributing!
+-->

.github/workflows/tests.yaml

@@ -21,10 +21,6 @@ on:
       - main
       - development
 
-  schedule:
-    # Every day at 7AM UTC
-    - cron: '0 07 * * *'
-
 env:
 
   # Arguments used for pytest
@@ -47,32 +43,17 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [windows-latest, macos-latest, ubuntu-latest]
-        python-version: ['3.9', '3.10']
-        kind: ['conda', 'source', 'dist']
-
-        exclude:
-          # Exclude all configurations *-*-dist, but include one later in `include`
-          - kind: 'dist'
-
-          # Exclude windows as bash commands wont work in windows runner
-          - os: windows-latest
-
-          # Exclude macos as there are permission errors using conda as we do
-          - os: macos-latest
+        os: [ubuntu-latest]
+        python-version: ['3.9', '3.10', '3.11']
+        kind: ['conda']
 
         include:
           # Add the tag code-cov to ubuntu-3.7-source
           - os: ubuntu-latest
             python-version: 3.9
-            kind: 'source'
+            kind: 'conda'
             code-cov: true
 
-           # Include one config with dist, ubuntu-3.7-dist
-          - os: ubuntu-latest
-            python-version: 3.9
-            kind: 'dist'
-
     steps:
 
     - name: Checkout
@@ -91,21 +72,7 @@ jobs:
         # Miniconda is available in $CONDA env var
         $CONDA/bin/conda create -n testenv --yes pip wheel gxx_linux-64 gcc_linux-64 python=${{ matrix.python-version }}
         $CONDA/envs/testenv/bin/python3 -m pip install --upgrade pip
-        $CONDA/envs/testenv/bin/pip3 install -e ".[dev,box2d,brax,dm_control,mario]"
-
-    - name: Source install
-      if: matrix.kind == 'source'
-      run: |
-        python -m pip install --upgrade pip
-        pip install -e ".[dev,box2d,brax,dm_control,mario]"
-
-    - name: Dist install
-      if: matrix.kind == 'dist'
-      run: |
-        python -m pip install --upgrade pip
-        python setup.py sdist
-        last_dist=$(ls -t dist/carl-*.tar.gz | head -n 1)
-        pip install $last_dist[dev,box2d,brax,dm_control,mario]
+        $CONDA/envs/testenv/bin/pip3 install -e .[dev,dm_control,mario,brax,box2d]
 
     - name: Tests
       timeout-minutes: 60
@@ -123,10 +90,3 @@ jobs:
         else
           $PYTHON -m pytest ${{ env.pytest-args }} --ignore=test/local_only test
         fi
-
-    - name: Upload coverage
-      if: matrix.code-cov && always()
-      uses: codecov/codecov-action@v2
-      with:
-        fail_ci_if_error: true
-        verbose: true

CITATION.cff

@@ -0,0 +1,69 @@
+cff-version: 1.2.0
+message: "If you use this software, please cite our paper:"
+
+url: "https://automl.github.io/CARL/"
+repository-code: "https://github.com/automl/CARL"
+title: "CARL - Context Adaptive Reinforcement Learning"
+
+authors:
+  - family-names: "Benjamins"
+    given-names: "Carolin"
+    affiliation: "Leibniz University Hannover, Germany"
+  - family-names: "Eimer"
+    given-names: "Theresa"
+    affiliation: "Leibniz University Hannover, Germany"
+  - family-names: "Schubert"
+    given-names: "Frederik"
+    affiliation: "Leibniz University Hannover, Germany"
+  - family-names: "Mohan"
+    given-names: "Aditya"
+    affiliation: "Leibniz University Hannover, Germany"
+  - family-names: "Döhler"
+    given-names: "Sebastian"
+    affiliation: "Leibniz University Hannover, Germany"
+  - family-names: "Biedenkapp"
+    given-names: "André"
+    affiliation: "Albert-Ludwigs University Freiburg, Germany"
+  - family-names: "Rosenhahn"
+    given-names: "Bodo"
+    affiliation: "Leibniz University Hannover, Germany"
+  - family-names: "Hutter"
+    given-names: "Frank"
+    affiliation: "Albert-Ludwigs University Freiburg, Germany"
+  - family-names: "Lindauer"
+    given-names: "Marius"
+    affiliation: "Leibniz University Hannover, Germany"
+
+preferred-citation:
+  type: "article"
+  title: "Contextualize Me - The Case for Context in Reinforcement Learning"
+  year: 2023
+  journal: "Transactions on Machine Learning Research"
+  authors:
+    - family-names: "Benjamins"
+      given-names: "Carolin"
+      affiliation: "Leibniz University Hannover, Germany"
+    - family-names: "Eimer"
+      given-names: "Theresa"
+      affiliation: "Leibniz University Hannover, Germany"
+    - family-names: "Schubert"
+      given-names: "Frederik"
+      affiliation: "Leibniz University Hannover, Germany"
+    - family-names: "Mohan"
+      given-names: "Aditya"
+      affiliation: "Leibniz University Hannover, Germany"
+    - family-names: "Döhler"
+      given-names: "Sebastian"
+      affiliation: "Leibniz University Hannover, Germany"
+    - family-names: "Biedenkapp"
+      given-names: "André"
+      affiliation: "Albert-Ludwigs University Freiburg, Germany"
+    - family-names: "Rosenhahn"
+      given-names: "Bodo"
+      affiliation: "Leibniz University Hannover, Germany"
+    - family-names: "Hutter"
+      given-names: "Frank"
+      affiliation: "Albert-Ludwigs University Freiburg, Germany"
+    - family-names: "Lindauer"
+      given-names: "Marius"
+      affiliation: "Leibniz University Hannover, Germany"

Makefile

@@ -40,6 +40,9 @@ install-dev:
 	$(PIP) install -e ".[dev, docs]"
 	pre-commit install
 
+install:
+	$(PIP) install -e .
+
 check-black:
 	$(BLACK)  carl test --check || :
 
@@ -63,15 +66,18 @@ pre-commit:
 	$(PRECOMMIT) run --all-files
 
 format-black:
-	$(BLACK) carl test
+	$(BLACK) carl test examples
 
 format-isort:
 	$(ISORT) carl test
 
 format: format-black format-isort
 
 test:
-	$(PYTEST) test
+	$(PYTEST) --disable-warnings test
+
+cov-report:
+	coverage html -d coverage_html
 
 clean-doc:
 	$(MAKE) -C ${DOCDIR} clean

README.md

@@ -1,6 +1,11 @@
 <img align="left" width="80" src="./docs/source/figures/CARL_logo.png" alt="CARL">
 
 # – The Benchmark Library
+[![PyPI Version](https://img.shields.io/pypi/v/carl-bench.svg)](https://pypi.python.org/pypi/carl-bench)
+[![Test](https://github.com/automl/carl/actions/workflows/tests.yaml/badge.svg)](https://github.com/automl/carl/actions/workflows/tests.yaml)
+[![Doc Status](https://github.com/automl/carl/actions/workflows/docs.yaml/badge.svg)](https://github.com/automl/carl/actions/workflows/docs.yaml)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+
 CARL (context adaptive RL) provides highly configurable contextual extensions
 to several well-known RL environments.
 It's designed to test your agent's generalization capabilities