Skip to content

Commit

Permalink
Update the README files (#817)
Browse files Browse the repository at this point in the history
* Remove MuJoCo 1.5 from the prerequisites because we switched to 2.0+ long ago.

* Add a link to benchmark results to the benchmark README.md
  • Loading branch information
ernestum authored Nov 28, 2023
1 parent de589d4 commit 1af5e4d
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 1 deletion.
1 change: 0 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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))

### Installing PyPI release

Expand Down
2 changes: 2 additions & 0 deletions benchmarking/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ The imitation library is benchmarked by running the algorithms BC, DAgger, AIRL
on five different environments from the
[seals environment suite](https://github.com/HumanCompatibleAI/seals)
each with 10 different random seeds.
You will find the benchmark results in the release artifacts, e.g. for the v1.0 release
[here](https://github.com/HumanCompatibleAI/imitation/releases/download/v1.0.0/benchmark_runs.zip).


## Running a Single Benchmark
Expand Down

0 comments on commit 1af5e4d

Please sign in to comment.