Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat/jumanji support #136

Merged
merged 15 commits into from
Jan 13, 2023
Merged

Feat/jumanji support #136

merged 15 commits into from
Jan 13, 2023

Conversation

felixchalumeau
Copy link
Collaborator

@felixchalumeau felixchalumeau commented Jan 9, 2023

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:

  • utils to score a policy in a Jumanji environment (play_step, rollout, scoring)
  • an example of how to use a Genetic Algorithm or MAP-Elites on Jumanji-Snake
  • a small modification of the MakeFile
  • I had to pin jinja to fix the docs

Checks

  • a clear description of the PR has been added
  • sufficient tests have been written
  • relevant section added to the documentation
  • example notebook added to the repo
  • clean docstrings and comments have been written
  • if any issue/observation has been discovered, a new issue has been opened

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.

@felixchalumeau felixchalumeau marked this pull request as ready for review January 10, 2023 09:49
@codecov-commenter
Copy link

codecov-commenter commented Jan 10, 2023

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%) ⬆️

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

setup.py Outdated Show resolved Hide resolved
qdax/types.py Outdated Show resolved Hide resolved
qdax/tasks/brax_envs.py Outdated Show resolved Hide resolved
@felixchalumeau
Copy link
Collaborator Author

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

@felixchalumeau felixchalumeau merged commit 7cfd5bc into develop Jan 13, 2023
@limbryan limbryan deleted the feat/jumanji-support branch May 12, 2023 21:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants