hongshaorou/Tianshou
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Docstrings, skip hidden files in autogen_rst

Browse Source
This commit is contained in:
Michael Panchenko 2024-05-05 23:31:20 +02:00
parent f059b65103
commit 6a5b3c837a
3 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/autogen_rst.py
View File

@ -74,7 +74,9 @@ def make_rst(src_root, rst_root, clean=False, overwrite=False, package_prefix=""
subdir_refs = [ subdir_refs = [
f"{f}/index" f"{f}/index"
for f in files_in_dir 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( package_index_rst_path = os.path.join(
rst_root, rst_root,

1
tianshou/data/collector.py
View File

@ -286,6 +286,7 @@ class BaseCollector(ABC):
(The collector needs the initial obs and info to function properly.) (The collector needs the initial obs and info to function properly.)
:param gym_reset_kwargs: extra keyword arguments to pass into the environment's :param gym_reset_kwargs: extra keyword arguments to pass into the environment's
reset function. Only used if reset_before_collect is True. reset function. Only used if reset_before_collect is True.
.. note:: .. note::
One and only one collection number specification is permitted, either One and only one collection number specification is permitted, either

2
tianshou/trainer/base.py
View File

@ -417,7 +417,7 @@ class BaseTrainer(ABC):
"""Perform one training iteration. """Perform one training iteration.
A training iteration includes collecting data (for online RL), determining whether to stop training, 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. :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`. If training is to be stopped, no gradient steps will be performed and the training stats will be `None`.