fix docstrings

thu-ml · Trinkle23897 · Mar 17, 2022 · Mar 5, 2022 · Mar 5, 2022 · Mar 5, 2022
commit f64eb2dad6a7a0d573630680fb1f8b0ecf3c295c
diff --git a/tianshou/trainer/offline.py b/tianshou/trainer/offline.py
@@ -152,7 +152,8 @@ def offline_trainer_generator(
     logger: BaseLogger = LazyLogger(),
     verbose: bool = True,
 ) -> Generator[Tuple[int, Dict[str, Any], Dict[str, Any]], None, None]:
-    """A wrapper for offline trainer procedure.
+    """A generator wrapper for offline trainer procedure.
+
     Returns a generator that yields a 3-tuple (epoch, stats, info) of train results
     on every epoch.
 

diff --git a/tianshou/trainer/offpolicy.py b/tianshou/trainer/offpolicy.py
@@ -214,7 +214,8 @@ def offpolicy_trainer_generator(
     verbose: bool = True,
     test_in_train: bool = True,
 ) -> Generator[Tuple[int, Dict[str, Any], Dict[str, Any]], None, None]:
-    """A wrapper for off-policy trainer procedure.
+    """A generator wrapper for off-policy trainer procedure.
+
     Returns a generator that yields a 3-tuple (epoch, stats, info) of train results
     on every epoch.
 

diff --git a/tianshou/trainer/onpolicy.py b/tianshou/trainer/onpolicy.py
@@ -231,7 +231,8 @@ def onpolicy_trainer_generator(
     verbose: bool = True,
     test_in_train: bool = True,
 ) -> Generator[Tuple[int, Dict[str, Any], Dict[str, Any]], None, None]:
-    """A wrapper for on-policy trainer procedure.
+    """A generator wrapper for on-policy trainer procedure.
+
     Returns a generator that yields a 3-tuple (epoch, stats, info) of train results
     on every epoch.