Skip to content

Commit

Permalink
Corrects execution command in RL training tutorial docs (#311)
Browse files Browse the repository at this point in the history
# Description

Currently, the command to play a trained RL model is lacking the flag
that will make it use the latest checkpoint, despite that behavior
being described as expected in the surrounding text. This MR adds the flag.

It also removes a statement that 'by default' the above command will
load the latest checkpoint, because it could be potentially confusing as
that behavior is only 'by default' when you use the flag.

## Type of change

- Bug fix (non-breaking change which fixes an issue)

## Checklist

- [x] I have run the [`pre-commit` checks](https://pre-commit.com/) with
`./orbit.sh --format`
- [ ] I have made corresponding changes to the documentation
- [x] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my
feature works
- [ ] I have updated the changelog and the corresponding version in the
extension's `config/extension.toml` file
- [x] I have added my name to the `CONTRIBUTORS.md` or my name already
exists there
  • Loading branch information
hhansen-bdai authored Dec 20, 2023
1 parent bff476a commit a319d44
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/source/tutorials/03_envs/run_rl_training.rst
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,9 @@ Once the training is complete, you can visualize the trained agent by executing
.. code:: bash
# execute from the root directory of the repository
./orbit.sh -p source/standalone/workflows/sb3/play.py --task Isaac-Cartpole-v0 --num_envs 32
./orbit.sh -p source/standalone/workflows/sb3/play.py --task Isaac-Cartpole-v0 --num_envs 32 --use_last_checkpoint
By default, the above command will load the latest checkpoint from the ``logs/sb3/Isaac-Cartpole-v0``
The above command will load the latest checkpoint from the ``logs/sb3/Isaac-Cartpole-v0``
directory. You can also specify a specific checkpoint by passing the ``--checkpoint`` flag.

.. _Stable-Baselines3: https://stable-baselines3.readthedocs.io/en/master/
Expand Down

0 comments on commit a319d44

Please sign in to comment.