missing docs

thu-ml · Mar 17, 2022 · a62cf84 · a62cf84
1 parent 3ce4f6d
commit a62cf84
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 0 deletions.
diff --git a/tianshou/trainer/offline.py b/tianshou/trainer/offline.py
@@ -106,6 +106,8 @@ def offline_trainer(*args, **kwargs) -> Dict[str, Union[float, str]]:  # type: i
     """Wrapper for offline_trainer run method.
 
     It is identical to ``OfflineTrainer(...).run()``.
+
+    :return: See :func:`~tianshou.trainer.gather_info`.
     """
     return OfflineTrainer(*args, **kwargs).run()
 

diff --git a/tianshou/trainer/offpolicy.py b/tianshou/trainer/offpolicy.py
@@ -121,6 +121,8 @@ def offpolicy_trainer(*args, **kwargs) -> Dict[str, Union[float, str]]:  # type:
     """Wrapper for OffPolicyTrainer run method.
 
     It is identical to ``OffpolicyTrainer(...).run()``.
+
+    :return: See :func:`~tianshou.trainer.gather_info`.
     """
     return OffpolicyTrainer(*args, **kwargs).run()
 

diff --git a/tianshou/trainer/onpolicy.py b/tianshou/trainer/onpolicy.py
@@ -138,6 +138,8 @@ def onpolicy_trainer(*args, **kwargs) -> Dict[str, Union[float, str]]:  # type:
     """Wrapper for OnpolicyTrainer run method.
 
     It is identical to ``OnpolicyTrainer(...).run()``.
+
+    :return: See :func:`~tianshou.trainer.gather_info`.
     """
     return OnpolicyTrainer(*args, **kwargs).run()