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

Update the README files #817

Merged
merged 2 commits into from
Nov 28, 2023
Merged

Update the README files #817

merged 2 commits into from
Nov 28, 2023

Conversation

ernestum
Copy link
Collaborator

@ernestum ernestum commented Nov 6, 2023

Description

This PR updates the README files so they

  1. stop instructing to install the outdated MuJoCo 1.5
  2. link to the benchmark results in the release artifacts

Testing

Documentation-only changes.

Copy link
Contributor

@dan-pandori dan-pandori left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@@ -29,7 +29,6 @@ You can find [the documentation here](https://imitation.readthedocs.io/en/latest
- Python 3.8+
- (Optional) OpenGL (to render Gym environments)
- (Optional) FFmpeg (to encode videos of renders)
- (Optional) MuJoCo (follow instructions to install [mujoco_py v1.5 here](https://github.com/openai/mujoco-py/tree/498b451a03fb61e5bdfcb6956d8d7c881b1098b5#install-mujoco))
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just to doublecheck, this is unnecessary since this is now entirely handled by this line in setup.py, right?
https://github.com/HumanCompatibleAI/imitation/blob/de589d46ee81e1c83635d3b4865884abf8960f44/setup.py#L223C1-L223C1

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes!

@ernestum ernestum merged commit 1af5e4d into master Nov 28, 2023
15 checks passed
@ernestum ernestum deleted the doc_update branch November 28, 2023 12:36
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.

None yet

2 participants