Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Some docs nit picking #1435

Merged
merged 1 commit into from
Nov 4, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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