Skip to content

Commit d532362

Browse files
solismortisaraffin
andauthored
Adds info on split tensorboard graphs (#989)
* Add info on split tensorboard graphs. * Change wording to make it look better. * Update changelog.rst * Rephrase and add link to issue Co-authored-by: Antonin Raffin <[email protected]>
1 parent b1cc159 commit d532362

File tree

3 files changed

+11
-0
lines changed

3 files changed

+11
-0
lines changed

docs/_static/img/split_graph.png

21 KB
Loading

docs/guide/tensorboard.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,20 @@ You can also define custom logging name when training (by default it is the algo
2626
model.learn(total_timesteps=10_000, tb_log_name="first_run")
2727
# Pass reset_num_timesteps=False to continue the training curve in tensorboard
2828
# By default, it will create a new curve
29+
# Keep tb_log_name constant to have continuous curve (see note below)
2930
model.learn(total_timesteps=10_000, tb_log_name="second_run", reset_num_timesteps=False)
3031
model.learn(total_timesteps=10_000, tb_log_name="third_run", reset_num_timesteps=False)
3132
3233
34+
.. note::
35+
If you specify different ``tb_log_name`` in subsequent runs, you will have split graphs, like in the figure below.
36+
If you want them to be continuous, you must keep the same ``tb_log_name`` (see `issue #975 <https://github.com/DLR-RM/stable-baselines3/issues/975#issuecomment-1198992211>`_).
37+
And, if you still managed to get your graphs split by other means, just put tensorboard log files into the same folder.
38+
39+
.. image:: ../_static/img/split_graph.png
40+
:width: 330
41+
:alt: split_graph
42+
3343
Once the learn function is called, you can monitor the RL agent during or after the training, with the following bash command:
3444

3545
.. code-block:: bash

docs/misc/changelog.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ Others:
2929
Documentation:
3030
^^^^^^^^^^^^^^
3131
- Fix typo in docstring "nature" -> "Nature" (@Melanol)
32+
- Add info on split tensorboard logs into (@Melanol)
3233

3334

3435
Release 1.6.0 (2022-07-11)

0 commit comments

Comments
 (0)