Skip to content

Commit a319d44

Browse files
authored
Corrects execution command in RL training tutorial docs (isaac-sim#311)
# 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
1 parent bff476a commit a319d44

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

docs/source/tutorials/03_envs/run_rl_training.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -141,9 +141,9 @@ Once the training is complete, you can visualize the trained agent by executing
141141
.. code:: bash
142142
143143
# execute from the root directory of the repository
144-
./orbit.sh -p source/standalone/workflows/sb3/play.py --task Isaac-Cartpole-v0 --num_envs 32
144+
./orbit.sh -p source/standalone/workflows/sb3/play.py --task Isaac-Cartpole-v0 --num_envs 32 --use_last_checkpoint
145145
146-
By default, the above command will load the latest checkpoint from the ``logs/sb3/Isaac-Cartpole-v0``
146+
The above command will load the latest checkpoint from the ``logs/sb3/Isaac-Cartpole-v0``
147147
directory. You can also specify a specific checkpoint by passing the ``--checkpoint`` flag.
148148

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

0 commit comments

Comments
 (0)