Skip to content

Commit

Permalink
fix(readme): update the paper to cite (#161)
Browse files Browse the repository at this point in the history
* fix(readme): update the paper to cite

* Fix python version and dependencies for CI
  • Loading branch information
felixchalumeau authored Nov 28, 2023
1 parent b44969f commit aaa3ece
Show file tree
Hide file tree
Showing 8 changed files with 30 additions and 28 deletions.
4 changes: 2 additions & 2 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ repos:
rev: 22.3.0
hooks:
- id: black
language_version: python3.8
args: ["--target-version", "py38"]
language_version: python3.9
args: ["--target-version", "py39"]
- repo: https://github.com/PyCQA/flake8
rev: 3.8.4
hooks:
Expand Down
2 changes: 1 addition & 1 deletion .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ version: 2
build:
os: ubuntu-20.04
tools:
python: "3.8"
python: "3.9"
apt_packages:
- swig

Expand Down
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -164,11 +164,13 @@ Issues and contributions are welcome. Please refer to the [contribution guide](h
## Citing QDax
If you use QDax in your research and want to cite it in your work, please use:
```
@article{lim2022accelerated,
title={Accelerated Quality-Diversity for Robotics through Massive Parallelism},
author={Lim, Bryan and Allard, Maxime and Grillotti, Luca and Cully, Antoine},
journal={arXiv preprint arXiv:2202.01258},
year={2022}
@misc{chalumeau2023qdax,
title={QDax: A Library for Quality-Diversity and Population-based Algorithms with Hardware Acceleration},
author={Felix Chalumeau and Bryan Lim and Raphael Boige and Maxime Allard and Luca Grillotti and Manon Flageat and Valentin Macé and Arthur Flajolet and Thomas Pierrot and Antoine Cully},
year={2023},
eprint={2308.03665},
archivePrefix={arXiv},
primaryClass={cs.AI}
}
```

Expand Down
12 changes: 6 additions & 6 deletions dev.Dockerfile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
FROM mambaorg/micromamba:0.22.0 as conda
FROM mambaorg/micromamba:1.5.1 as conda

# Speed up the build, and avoid unnecessary writes to disk
ENV LANG=C.UTF-8 LC_ALL=C.UTF-8 PYTHONDONTWRITEBYTECODE=1 PYTHONUNBUFFERED=1 CONDA_DIR=/opt/conda
Expand All @@ -16,7 +16,7 @@ RUN micromamba create -y --file /tmp/environment.yaml \


FROM python as test-image
ENV PATH=/opt/conda/envs/qdaxpy38/bin/:$PATH APP_FOLDER=/app
ENV PATH=/opt/conda/envs/qdaxpy39/bin/:$PATH APP_FOLDER=/app
ENV PYTHONPATH=$APP_FOLDER:$PYTHONPATH

COPY --from=conda /opt/conda/envs/. /opt/conda/envs/
Expand All @@ -25,8 +25,8 @@ COPY requirements-dev.txt ./
RUN pip install -r requirements-dev.txt


FROM nvidia/cuda:11.4.1-cudnn8-devel-ubuntu20.04 as cuda-image
ENV PATH=/opt/conda/envs/qdaxpy38/bin/:$PATH APP_FOLDER=/app
FROM nvidia/cuda:11.5.2-cudnn8-devel-ubuntu20.04 as cuda-image
ENV PATH=/opt/conda/envs/qdaxpy39/bin/:$PATH APP_FOLDER=/app
ENV PYTHONPATH=$APP_FOLDER:$PYTHONPATH


Expand All @@ -40,7 +40,7 @@ ENV LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/usr/local/cuda-11.0/targets/x86_64-linux/l

ENV TZ=Europe/Paris
RUN ln -snf /usr/share/zoneinfo/$TZ /etc/localtime && echo $TZ > /etc/timezone
RUN pip --no-cache-dir install jaxlib==0.3.15+cuda11.cudnn82 \
RUN pip --no-cache-dir install jaxlib==0.4.16+cuda11.cudnn86 \
-f https://storage.googleapis.com/jax-releases/jax_cuda_releases.html \
&& rm -rf /tmp/*

Expand Down Expand Up @@ -70,7 +70,7 @@ RUN apt-get update && \
libosmesa6-dev \
patchelf \
python3-opengl \
python3-dev=3.8* \
python3-dev=3.9* \
python3-pip \
screen \
sudo \
Expand Down
2 changes: 1 addition & 1 deletion docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ git clone [email protected]:adaptive-intelligent-robotics/QDax.git

2. Activate the environment and manually install the package qdax
```zsh
conda activate qdaxpy38
conda activate qdaxpy39
pip install -e .
```

Expand Down
4 changes: 2 additions & 2 deletions environment.yaml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
name: qdaxpy38
name: qdaxpy39
channels:
- defaults
- conda-forge
dependencies:
- python=3.8
- python=3.9
- pip>=20.3.3
- conda>=4.9.2
- pip:
Expand Down
20 changes: 10 additions & 10 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
absl-py==1.0.0
brax==0.0.15
chex==0.1.5
dm-haiku==0.0.5
flax==0.6.0
gym==0.23.1
brax==0.1.2
chex==0.1.83
dm-haiku==0.0.10
flax==0.7.4
gym==0.26.2
ipython
jax==0.3.17
jaxlib==0.3.15
jax==0.4.16
jaxlib==0.4.16
jumanji==0.1.3
jupyter
numpy==1.22.3
optax==0.1.4
numpy==1.24.1
optax==0.1.7
protobuf==3.19.4
scikit-learn==1.0.2
scipy==1.8.0
seaborn==0.11.2
tensorflow-probability==0.15.0
tensorflow-probability==0.19.0
typing-extensions==4.3.0
2 changes: 1 addition & 1 deletion tool.Dockerfile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
FROM python:3.8.13-slim
FROM python:3.9.18-slim

ENV LANG=C.UTF-8 LC_ALL=C.UTF-8 PYTHONDONTWRITEBYTECODE=1 PYTHONUNBUFFERED=1
ENV PIPENV_VENV_IN_PROJECT=true PIP_NO_CACHE_DIR=false PIP_DISABLE_PIP_VERSION_CHECK=1
Expand Down

0 comments on commit aaa3ece

Please sign in to comment.