Skip to content

Commit c76f943

Browse files
authored
Some docs nit picking (#1435)
1 parent 75e2042 commit c76f943

File tree

3 files changed

+6
-4
lines changed

3 files changed

+6
-4
lines changed

ignite/contrib/handlers/lr_finder.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -289,8 +289,8 @@ def attach(
289289
diverge_th (float, optional): Used for stopping the search when `current loss > diverge_th * best_loss`.
290290
Default, 5.0.
291291
292-
Notes:
293-
lr_finder cannot be attached to more than one trainer at a time
292+
Note:
293+
lr_finder cannot be attached to more than one trainer at a time.
294294
295295
Returns:
296296
trainer_with_lr_finder: trainer used for finding the lr

ignite/contrib/handlers/tqdm_logger.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,8 @@ def attach(
177177
closing_event_name: event's name on which the progress bar is closed. Valid events are from
178178
:class:`~ignite.engine.events.Events`.
179179
180-
Note: accepted output value types are numbers, 0d and 1d torch tensors and strings
180+
Note:
181+
Accepted output value types are numbers, 0d and 1d torch tensors and strings.
181182
182183
"""
183184
desc = self.tqdm_kwargs.get("desc", None)

ignite/contrib/handlers/trains_logger.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -173,9 +173,11 @@ def set_bypass_mode(cls, bypass: bool) -> None:
173173
def bypass_mode(cls) -> bool:
174174
"""
175175
Returns the bypass mode state.
176+
176177
Note:
177178
`GITHUB_ACTIONS` env will automatically set bypass_mode to ``True``
178179
unless overridden specifically with ``TrainsLogger.set_bypass_mode(False)``.
180+
179181
Return:
180182
If True, all outside communication is skipped.
181183
"""
@@ -276,7 +278,6 @@ def global_step_transform(*args, **kwargs):
276278
:meth:`~ignite.contrib.handlers.trains_logger.global_step_from_engine`.
277279
278280
Note:
279-
280281
Example of `global_step_transform`:
281282
282283
.. code-block:: python

0 commit comments

Comments
 (0)