From eb71e545ba5025cb0e6fa253345bc5af6306c4e2 Mon Sep 17 00:00:00 2001 From: Taras Savchyn Date: Wed, 4 Nov 2020 15:11:46 +0200 Subject: [PATCH] Some docs nit picking --- ignite/contrib/handlers/lr_finder.py | 4 ++-- ignite/contrib/handlers/tqdm_logger.py | 3 ++- ignite/contrib/handlers/trains_logger.py | 3 ++- 3 files changed, 6 insertions(+), 4 deletions(-) diff --git a/ignite/contrib/handlers/lr_finder.py b/ignite/contrib/handlers/lr_finder.py index 4dd58c3b4f0f..149a32e60cdf 100644 --- a/ignite/contrib/handlers/lr_finder.py +++ b/ignite/contrib/handlers/lr_finder.py @@ -289,8 +289,8 @@ def attach( diverge_th (float, optional): Used for stopping the search when `current loss > diverge_th * best_loss`. Default, 5.0. - Notes: - lr_finder cannot be attached to more than one trainer at a time + Note: + lr_finder cannot be attached to more than one trainer at a time. Returns: trainer_with_lr_finder: trainer used for finding the lr diff --git a/ignite/contrib/handlers/tqdm_logger.py b/ignite/contrib/handlers/tqdm_logger.py index 979986079a06..9e7db89f666f 100644 --- a/ignite/contrib/handlers/tqdm_logger.py +++ b/ignite/contrib/handlers/tqdm_logger.py @@ -177,7 +177,8 @@ def attach( closing_event_name: event's name on which the progress bar is closed. Valid events are from :class:`~ignite.engine.events.Events`. - Note: accepted output value types are numbers, 0d and 1d torch tensors and strings + Note: + Accepted output value types are numbers, 0d and 1d torch tensors and strings. """ desc = self.tqdm_kwargs.get("desc", None) diff --git a/ignite/contrib/handlers/trains_logger.py b/ignite/contrib/handlers/trains_logger.py index 6c8c2f885b57..49bc510542f9 100644 --- a/ignite/contrib/handlers/trains_logger.py +++ b/ignite/contrib/handlers/trains_logger.py @@ -173,9 +173,11 @@ def set_bypass_mode(cls, bypass: bool) -> None: def bypass_mode(cls) -> bool: """ Returns the bypass mode state. + Note: `GITHUB_ACTIONS` env will automatically set bypass_mode to ``True`` unless overridden specifically with ``TrainsLogger.set_bypass_mode(False)``. + Return: If True, all outside communication is skipped. """ @@ -276,7 +278,6 @@ def global_step_transform(*args, **kwargs): :meth:`~ignite.contrib.handlers.trains_logger.global_step_from_engine`. Note: - Example of `global_step_transform`: .. code-block:: python