Refactor QDax, add Policy Gradient Assisted MAP Elites, add CI and doc (

adaptive-intelligent-robotics#6)

add pre-commits, add envs and wrappers, update packages version, add notebook example, improve docstrings, add PGA-ME-Emitter, restructure, add pgame in notebook, save/load example, add tests, CI, and fix euclidean centroids, add tests for map elites and pgame, Enable github action cache, update gitignore, change rngkey flow, update names, update dockerfile for multistage style with micromamba, add csv logger, add documentation, add badges, Create LICENSE, fix sampling in repertoire + fix bad key management, remove final kernel init that was unadapted to map elites and pgame, fix of isoline dd.

Co-authored-by: bryan <bwl116@ic.ac.uk>
Co-authored-by: thomas <t.pierrot@instadeep.com>
Co-authored-by: Remi DEBETTE <r.debette@instadeep.com>
Co-authored-by: Thomas Pierrot <32740767+ranzenTom@users.noreply.github.com>
Co-authored-by: Luca Grillotti

.dockerignore

@@ -0,0 +1,173 @@
+# added elements
+
+# Singularity generated files
+*.simg
+*.sif
+*.swp
+tmp.def
+
+
+# Figures and Videos
+*.pth
+*.png
+*.svg
+*.pdf
+*.mp4
+*.gif
+
+# IDE configuration file
+.idea/
+
+# Hydra outputs
+hydra_outputs/
+
+
+# Usual python .gitignore
+
+# 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/
+
+# 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
+
+# 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/
+
+
+.dockerignore
+.gitignore
+.pre-commit-config.yaml
+Makefile
+mypy.ini
+README.md
+dev.Dockerfile

.github/workflows/ci.yaml

@@ -0,0 +1,106 @@
+name: ci
+
+on: push
+
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ github.repository_owner }}/qdax
+
+jobs:
+  style:
+    needs: [build]
+    runs-on: ubuntu-latest
+    container:
+      image: ghcr.io/${{ github.repository_owner }}/qdax/test:${{ github.ref_name }}
+      credentials:
+        username: ${{ github.actor }}
+        password: ${{ secrets.GITHUB_TOKEN }}
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Run pre-commits
+        run: |
+          pre-commit run --all-files isort
+          pre-commit run --all-files black
+          pre-commit run --all-files nbstripout
+          pre-commit run --all-files debug-statements
+          pre-commit run --all-files check-ast
+          pre-commit run --all-files check-merge-conflict
+
+  tests:
+    needs: [build]
+    runs-on: ubuntu-latest
+    container:
+      image: ghcr.io/${{ github.repository_owner }}/qdax/test:${{ github.ref_name }}
+      credentials:
+        username: ${{ github.actor }}
+        password: ${{ secrets.GITHUB_TOKEN }}
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Run pytests
+        run: |
+          pytest -vv tests
+
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Set up Docker Buildx
+        id: buildx
+        uses: docker/setup-buildx-action@v2
+        with:
+          install: true
+
+      - name: Log in to the Container registry
+        uses: docker/login-action@v2
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@v4
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+
+#      - name: Build and push Docker image
+#        uses: docker/build-push-action@v3
+#        with:
+#          context: .
+#          file: dev.Dockerfile
+#          push: true
+#          tags: ${{ steps.meta.outputs.tags }}
+#          labels: ${{ steps.meta.outputs.labels }}
+#          cache-from: type=gha
+#          cache-to: type=gha,mode=max
+
+      - name: Build and push test Docker image
+        uses: docker/build-push-action@v3
+        with:
+          context: .
+          file: dev.Dockerfile
+          push: true
+          target: test-image
+          tags: "${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}/test:${{github.ref_name}}"
+          labels: ${{ steps.meta.outputs.labels }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max
+
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Build docs
+        run: |
+          pip install -r docs/requirements.txt
+          mkdocs build --verbose