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]>
DLR-RM · Feb 10, 2023 · 69b94dd · 69b94dd
1 parent 489b1fd
commit 69b94dd
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/docs/misc/changelog.rst b/docs/misc/changelog.rst
@@ -45,7 +45,7 @@ Documentation:
 - Renamed ``load_parameters`` to ``set_parameters`` (@DavyMorgan)
 - Clarified documentation about subproc multiprocessing for A2C (@Bonifatius94)
 - Fixed typo in ``A2C`` docstring (@AlexPasqua)
-
+- Renamed timesteps to episodes for ``log_interval`` description (@theSquaredError)
 
 Release 1.7.0 (2023-01-10)
 --------------------------
@@ -1227,4 +1227,4 @@ And all the contributors:
 @Gregwar @ycheng517 @quantitative-technologies @bcollazo @git-thor @TibiGG @cool-RR @MWeltevrede
 @Melanol @qgallouedec @francescoluciano @jlp-ue @burakdmb @timothe-chaumont @honglu2875 @yuanmingqi
 @anand-bala @hughperkins @sidney-tio @AlexPasqua @dominicgkerr @Akhilez @Rocamonde @tobirohrer @ZikangXiong
-@DavyMorgan @luizapozzobon @Bonifatius94
+@DavyMorgan @luizapozzobon @Bonifatius94 @theSquaredError
diff --git a/stable_baselines3/common/base_class.py b/stable_baselines3/common/base_class.py
@@ -505,7 +505,7 @@ def learn(
 
         :param total_timesteps: The total number of samples (env steps) to train on
         :param callback: callback(s) called at every step with state of the algorithm.
-        :param log_interval: The number of timesteps before logging.
+        :param log_interval: The number of episodes before logging.
         :param tb_log_name: the name of the run for TensorBoard logging
         :param reset_num_timesteps: whether or not to reset the current timestep number (used in logging)
         :param progress_bar: Display a progress bar using tqdm and rich.