Skip to content

Commit ddcce01

Browse files
authored
removes styling of function descriptions as requested in #1256 (#1399)
* removes styling of function descriptions as requested in #1256 * reverts modifications to the example files
1 parent 5bd0374 commit ddcce01

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

ignite/contrib/engines/common.py

+8
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ def setup_common_training_handlers(
4949
**kwargs: Any
5050
):
5151
"""Helper method to setup trainer with common handlers (it also supports distributed configuration):
52+
5253
- :class:`~ignite.handlers.TerminateOnNan`
5354
- handler to setup learning rate scheduling
5455
- :class:`~ignite.handlers.ModelCheckpoint`
@@ -312,6 +313,7 @@ def setup_tb_logging(
312313
**kwargs: Any
313314
):
314315
"""Method to setup TensorBoard logging on trainer and a list of evaluators. Logged metrics are:
316+
315317
- Training metrics, e.g. running average loss values
316318
- Learning rate(s)
317319
- Evaluation metrics
@@ -343,6 +345,7 @@ def setup_visdom_logging(
343345
**kwargs: Any
344346
):
345347
"""Method to setup Visdom logging on trainer and a list of evaluators. Logged metrics are:
348+
346349
- Training metrics, e.g. running average loss values
347350
- Learning rate(s)
348351
- Evaluation metrics
@@ -373,6 +376,7 @@ def setup_mlflow_logging(
373376
**kwargs: Any
374377
):
375378
"""Method to setup MLflow logging on trainer and a list of evaluators. Logged metrics are:
379+
376380
- Training metrics, e.g. running average loss values
377381
- Learning rate(s)
378382
- Evaluation metrics
@@ -403,6 +407,7 @@ def setup_neptune_logging(
403407
**kwargs: Any
404408
):
405409
"""Method to setup Neptune logging on trainer and a list of evaluators. Logged metrics are:
410+
406411
- Training metrics, e.g. running average loss values
407412
- Learning rate(s)
408413
- Evaluation metrics
@@ -433,6 +438,7 @@ def setup_wandb_logging(
433438
**kwargs: Any
434439
):
435440
"""Method to setup WandB logging on trainer and a list of evaluators. Logged metrics are:
441+
436442
- Training metrics, e.g. running average loss values
437443
- Learning rate(s)
438444
- Evaluation metrics
@@ -463,6 +469,7 @@ def setup_plx_logging(
463469
**kwargs: Any
464470
):
465471
"""Method to setup Polyaxon logging on trainer and a list of evaluators. Logged metrics are:
472+
466473
- Training metrics, e.g. running average loss values
467474
- Learning rate(s)
468475
- Evaluation metrics
@@ -493,6 +500,7 @@ def setup_trains_logging(
493500
**kwargs: Any
494501
):
495502
"""Method to setup Trains logging on trainer and a list of evaluators. Logged metrics are:
503+
496504
- Training metrics, e.g. running average loss values
497505
- Learning rate(s)
498506
- Evaluation metrics

0 commit comments

Comments
 (0)