Skip to content

Commit

Permalink
Some docs nit picking (#1435)
Browse files Browse the repository at this point in the history
  • Loading branch information
trsvchn authored Nov 4, 2020
1 parent 75e2042 commit c76f943
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 4 deletions.
4 changes: 2 additions & 2 deletions ignite/contrib/handlers/lr_finder.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 2 additions & 1 deletion ignite/contrib/handlers/tqdm_logger.py
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
3 changes: 2 additions & 1 deletion ignite/contrib/handlers/trains_logger.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
"""
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit c76f943

Please sign in to comment.