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

Improve docstrings

Browse Source
This commit is contained in:
Dominik Jain 2023-10-18 22:07:40 +02:00
parent 193be9a265
commit bbfad01a9f
3 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
tianshou/highlevel/experiment.py
View File

@ -187,7 +187,7 @@ class Experiment(ToStringMixin):
) -> ExperimentResult: ) -> ExperimentResult:
""":param experiment_name: the experiment name, which corresponds to the directory (within the logging """:param experiment_name: the experiment name, which corresponds to the directory (within the logging
directory) where all results associated with the experiment will be saved. directory) where all results associated with the experiment will be saved.
The name may contain path separators (os.path.sep, used by os.path.join), in which case The name may contain path separators (i.e. `os.path.sep`, as used by `os.path.join`), in which case
a nested directory structure will be created. a nested directory structure will be created.
If None, use a name containing the current date and time. If None, use a name containing the current date and time.
:param logger_run_id: Run identifier to use for logger initialization/resumption (applies when :param logger_run_id: Run identifier to use for logger initialization/resumption (applies when

2
tianshou/highlevel/logger.py
View File

@ -20,7 +20,7 @@ class LoggerFactory(ToStringMixin, ABC):
config_dict: dict, config_dict: dict,
) -> TLogger: ) -> TLogger:
""":param log_dir: path to the directory in which log data is to be stored """:param log_dir: path to the directory in which log data is to be stored
:param experiment_name: the name of the job, which may contain os.path.sep :param experiment_name: the name of the job, which may contain `os.path.sep`
:param run_id: a unique name, which, depending on the logging framework, may be used to identify the logger :param run_id: a unique name, which, depending on the logging framework, may be used to identify the logger
:param config_dict: a dictionary with data that is to be logged :param config_dict: a dictionary with data that is to be logged
:return: the logger :return: the logger

2
tianshou/highlevel/params/lr_scheduler.py
View File

@ -9,7 +9,7 @@ from tianshou.utils.string import ToStringMixin
class LRSchedulerFactory(ToStringMixin, ABC): class LRSchedulerFactory(ToStringMixin, ABC):
"""Factory for the createion of a learning rate scheduler.""" """Factory for the creation of a learning rate scheduler."""
@abstractmethod @abstractmethod
def create_scheduler(self, optim: torch.optim.Optimizer) -> LRScheduler: def create_scheduler(self, optim: torch.optim.Optimizer) -> LRScheduler: