Skip to content

Commit 69b94dd

Browse files
Rename "timesteps" to "episodes" in log_interval documentation (#1325)
* change timestamp to episode for logging * update changelog * minor format modif * minor format modif --------- Co-authored-by: Quentin Gallouédec <[email protected]>
1 parent 489b1fd commit 69b94dd

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

docs/misc/changelog.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Documentation:
4545
- Renamed ``load_parameters`` to ``set_parameters`` (@DavyMorgan)
4646
- Clarified documentation about subproc multiprocessing for A2C (@Bonifatius94)
4747
- Fixed typo in ``A2C`` docstring (@AlexPasqua)
48-
48+
- Renamed timesteps to episodes for ``log_interval`` description (@theSquaredError)
4949

5050
Release 1.7.0 (2023-01-10)
5151
--------------------------
@@ -1227,4 +1227,4 @@ And all the contributors:
12271227
@Gregwar @ycheng517 @quantitative-technologies @bcollazo @git-thor @TibiGG @cool-RR @MWeltevrede
12281228
@Melanol @qgallouedec @francescoluciano @jlp-ue @burakdmb @timothe-chaumont @honglu2875 @yuanmingqi
12291229
@anand-bala @hughperkins @sidney-tio @AlexPasqua @dominicgkerr @Akhilez @Rocamonde @tobirohrer @ZikangXiong
1230-
@DavyMorgan @luizapozzobon @Bonifatius94
1230+
@DavyMorgan @luizapozzobon @Bonifatius94 @theSquaredError

stable_baselines3/common/base_class.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -505,7 +505,7 @@ def learn(
505505
506506
:param total_timesteps: The total number of samples (env steps) to train on
507507
:param callback: callback(s) called at every step with state of the algorithm.
508-
:param log_interval: The number of timesteps before logging.
508+
:param log_interval: The number of episodes before logging.
509509
:param tb_log_name: the name of the run for TensorBoard logging
510510
:param reset_num_timesteps: whether or not to reset the current timestep number (used in logging)
511511
:param progress_bar: Display a progress bar using tqdm and rich.

0 commit comments

Comments
 (0)