adaptive-intelligent-robotics / QDax

Accelerated Quality-Diversity
https://qdax.readthedocs.io/en/latest/
MIT License
258 stars 42 forks source link

Feat/jumanji support #136

Closed felixchalumeau closed 1 year ago

felixchalumeau commented 1 year ago

Related issues: #83

This PR aims at easing the use of Jumanji environments in QDax. Jumanji is an open-source Jax package for games and combinatorial optimization problems written as MDPs.

This PR introduces:

Checks

Future improvements

The way the dependencies are handled in readthedocs is quite annoying at the moment, because the installation of qdax overwrites the requirements. We need to udpate our readthedocs file to fix this.

codecov-commenter commented 1 year ago

Codecov Report

Merging #136 (e561918) into develop (8fd641b) will increase coverage by 0.10%. The diff coverage is 98.96%.

@@             Coverage Diff             @@
##           develop     #136      +/-   ##
===========================================
+ Coverage    92.31%   92.41%   +0.10%     
===========================================
  Files          103      105       +2     
  Lines         5816     5910      +94     
===========================================
+ Hits          5369     5462      +93     
- Misses         447      448       +1     
Impacted Files Coverage Δ
tests/default_tasks_test/jumanji_envs_test.py 98.14% <98.14%> (ø)
qdax/tasks/brax_envs.py 96.66% <100.00%> (ø)
qdax/tasks/jumanji_envs.py 100.00% <100.00%> (ø)
qdax/types.py 96.66% <100.00%> (+0.37%) :arrow_up:

:mega: We’re building smart automated test selection to slash your CI/CD build times. Learn more

felixchalumeau commented 1 year ago

Thanks @Lookatator for the comments. I agree with them. I'll update accordingly.