From 6a5b3c837ad16bbb7efbfbbf3c9b7e2115278db0 Mon Sep 17 00:00:00 2001 From: Michael Panchenko Date: Sun, 5 May 2024 23:31:20 +0200 Subject: [PATCH] Docstrings, skip hidden files in autogen_rst --- docs/autogen_rst.py | 4 +++- tianshou/data/collector.py | 1 + tianshou/trainer/base.py | 2 +- 3 files changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/autogen_rst.py b/docs/autogen_rst.py index d3d4f08..b1a8b18 100644 --- a/docs/autogen_rst.py +++ b/docs/autogen_rst.py @@ -74,7 +74,9 @@ def make_rst(src_root, rst_root, clean=False, overwrite=False, package_prefix="" subdir_refs = [ f"{f}/index" for f in files_in_dir - if os.path.isdir(os.path.join(src_root, f)) and not f.startswith("_") + if os.path.isdir(os.path.join(src_root, f)) + and not f.startswith("_") + and not f.startswith(".") ] package_index_rst_path = os.path.join( rst_root, diff --git a/tianshou/data/collector.py b/tianshou/data/collector.py index d2ca217..5bce6c0 100644 --- a/tianshou/data/collector.py +++ b/tianshou/data/collector.py @@ -286,6 +286,7 @@ class BaseCollector(ABC): (The collector needs the initial obs and info to function properly.) :param gym_reset_kwargs: extra keyword arguments to pass into the environment's reset function. Only used if reset_before_collect is True. + .. note:: One and only one collection number specification is permitted, either diff --git a/tianshou/trainer/base.py b/tianshou/trainer/base.py index 3ad80c8..b738df5 100644 --- a/tianshou/trainer/base.py +++ b/tianshou/trainer/base.py @@ -417,7 +417,7 @@ class BaseTrainer(ABC): """Perform one training iteration. A training iteration includes collecting data (for online RL), determining whether to stop training, - and peforming a policy update if the training iteration should continue. + and performing a policy update if the training iteration should continue. :return: the iteration's collect stats, training stats, and a flag indicating whether to stop training. If training is to be stopped, no gradient steps will be performed and the training stats will be `None`.