CLI documentation

[ernestum]

Description

Add some documentation for the command line interface.

Testing

Documentation only changes.

[RedTachyon]

One thing worth mentioning (discussed yesterday with Adam) is that if an environment is registered upon importing a package, or in a certain file (e.g. inside custom_env.py you call gym.register("CustomEnv-v0")), then in the CLI interface you can train with that environment by providing the package/file name in the env ID (e.g. custom_env:CustomEnv-v0)

Some information about this functionality is in the Gymnasium docs. The same thing worked in gym==0.21.0 as well

[ernestum]

Thanks for letting me know! This will also benefit the rl-baselines3-zoo!

I will add an example with this to the documentation.

Note: depends on huggingface/huggingface_sb3#32 to go upstream because environment names with the package prefix are not properly normalized as of now.

[codecov]

Codecov Report

Merging #743 (32582eb) into master (b452384) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #743   +/-   ##
=======================================
  Coverage   96.33%   96.33%           
=======================================
  Files          93       93           
  Lines        8789     8789           
=======================================
  Hits         8467     8467           
  Misses        322      322           

Impacted Files	Coverage Δ
src/imitation/scripts/ingredients/bc.py	92.59% <ø> (ø)
...rc/imitation/scripts/ingredients/demonstrations.py	80.64% <ø> (ø)
src/imitation/scripts/ingredients/environment.py	88.88% <ø> (ø)
src/imitation/scripts/ingredients/expert.py	90.00% <ø> (ø)
src/imitation/scripts/ingredients/logging.py	87.50% <ø> (ø)
src/imitation/scripts/ingredients/policy.py	84.37% <ø> (ø)
...imitation/scripts/ingredients/policy_evaluation.py	86.95% <ø> (ø)
src/imitation/scripts/ingredients/reward.py	87.83% <ø> (ø)
src/imitation/scripts/ingredients/rl.py	90.24% <ø> (ø)
src/imitation/scripts/ingredients/wb.py	83.33% <ø> (ø)

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

[levmckinney]

Looks really good. A couple of minor suggestions. Ping me for a rereview when you're ready.

[levmckinney]

Can we make these some kind of doc test so that they run during the build phase? I'm worried they will end up getting out of sync with the CI over time.

[ernestum]

You are right with this concern!

Unfortunately this is not so easy to do. See https://stackoverflow.com/questions/71497528/can-i-modify-doctest-to-test-bash-inside-sphinx-doc

We would either have to use python code and run the commands via subprocess or use some alpha-stage python module also does not quite exactly do what we need (we would have to re-write the documentation in Markdown).

Given that the CLI is going to change soon anyway, I would not put in the effort to test it right now. What do you think?

[ernestum]

The python module in question: https://github.com/jamesbehr/docshtest

[levmckinney]

Sounds good lets just make sure to add a task to the issue tracker for the CI overall to update this part of the documentation.

[ernestum]

I added it to the bottom of the description here: #703

[levmckinney]

LGTM

[levmckinney]

Sounds good lets just make sure to add a task to the issue tracker for the CI overall to update this part of the documentation.