From 3cd6dcc3071fa701a72c54ebabf12eb89543f84f Mon Sep 17 00:00:00 2001 From: Dominik Jain Date: Thu, 26 Oct 2023 10:55:03 +0200 Subject: [PATCH] BaseTrainer: Remove info on default values from docstrings --- tianshou/trainer/base.py | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/tianshou/trainer/base.py b/tianshou/trainer/base.py index 919ff89..df8b11c 100644 --- a/tianshou/trainer/base.py +++ b/tianshou/trainer/base.py @@ -70,7 +70,7 @@ class BaseTrainer(ABC): return the saved checkpoint path, with the signature ``f(epoch: int, env_step: int, gradient_step: int) -> str``; you can save whatever you want. :param resume_from_log: resume env_step/gradient_step and other metadata - from existing tensorboard log. Default to False. + from existing tensorboard log. :param stop_fn: a function with signature ``f(mean_rewards: float) -> bool``, receives the average undiscounted returns of the testing result, returns a boolean which indicates whether reaching the goal. @@ -81,14 +81,12 @@ class BaseTrainer(ABC): multi-agent RL setting. This function specifies what is the desired metric, e.g., the reward of agent 1 or the average reward over all agents. :param logger: A logger that logs statistics during - training/testing/updating. Default to a logger that doesn't log anything. + training/testing/updating. To not log anything, keep the default logger. :param verbose: whether to print status information to stdout. If set to False, status information will still be logged (provided that logging is enabled via the `logging` module). :param show_progress: whether to display a progress bar when training. - Default to True. :param test_in_train: whether to test in the training phase. - Default to True. """ __doc__: str