Repository: pytorch/ignite

Issue:
Missing links in the doc
## 🐛 Bug description

Missing links in the docs : https://pytorch.org/ignite/contrib/engines.html#module-ignite.contrib.engines.common for methods:
- add_early_stopping_by_val_score -> EarlyStopping
- gen_save_best_models_by_val_score -> Checkpoint
- save_best_model_by_val_score -> Checkpoint






Discussion:
@vfdev-5  Please assign this issue to. I am working on this.
@sroy8091 sure! 
I found that below all logger setup functions return type also doesn't have hyperlinks, should I add those also?
@vfdev-5 
Yes, please

Resolving patch:
diff --git a/ignite/contrib/engines/common.py b/ignite/contrib/engines/common.py
--- a/ignite/contrib/engines/common.py
+++ b/ignite/contrib/engines/common.py
@@ -316,7 +316,7 @@ def setup_tb_logging(output_path, trainer, optimizers=None, evaluators=None, log
         **kwargs: optional keyword args to be passed to construct the logger.
 
     Returns:
-        TensorboardLogger
+        :class:`~ignite.contrib.handlers.tensorboard_logger.TensorboardLogger`
     """
     logger = TensorboardLogger(log_dir=output_path, **kwargs)
     _setup_logging(logger, trainer, optimizers, evaluators, log_every_iters)
@@ -340,7 +340,7 @@ def setup_visdom_logging(trainer, optimizers=None, evaluators=None, log_every_it
         **kwargs: optional keyword args to be passed to construct the logger.
 
     Returns:
-        VisdomLogger
+        :class:`~ignite.contrib.handlers.visdom_logger.VisdomLogger`
     """
     logger = VisdomLogger(**kwargs)
     _setup_logging(logger, trainer, optimizers, evaluators, log_every_iters)
@@ -364,7 +364,7 @@ def setup_mlflow_logging(trainer, optimizers=None, evaluators=None, log_every_it
         **kwargs: optional keyword args to be passed to construct the logger.
 
     Returns:
-        MLflowLogger
+        :class:`~ignite.contrib.handlers.mlflow_logger.MLflowLogger`
     """
     logger = MLflowLogger(**kwargs)
     _setup_logging(logger, trainer, optimizers, evaluators, log_every_iters)
@@ -388,7 +388,7 @@ def setup_neptune_logging(trainer, optimizers=None, evaluators=None, log_every_i
         **kwargs: optional keyword args to be passed to construct the logger.
 
     Returns:
-        NeptuneLogger
+        :class:`~ignite.contrib.handlers.neptune_logger.NeptuneLogger`
     """
     logger = NeptuneLogger(**kwargs)
     _setup_logging(logger, trainer, optimizers, evaluators, log_every_iters)
@@ -412,7 +412,7 @@ def setup_wandb_logging(trainer, optimizers=None, evaluators=None, log_every_ite
         **kwargs: optional keyword args to be passed to construct the logger.
 
     Returns:
-        WandBLogger
+        :class:`~ignite.contrib.handlers.wandb_logger.WandBLogger`
     """
     logger = WandBLogger(**kwargs)
     _setup_logging(logger, trainer, optimizers, evaluators, log_every_iters)
@@ -436,7 +436,7 @@ def setup_plx_logging(trainer, optimizers=None, evaluators=None, log_every_iters
         **kwargs: optional keyword args to be passed to construct the logger.
 
     Returns:
-        PolyaxonLogger
+        :class:`~ignite.contrib.handlers.polyaxon_logger.PolyaxonLogger`
     """
     logger = PolyaxonLogger(**kwargs)
     _setup_logging(logger, trainer, optimizers, evaluators, log_every_iters)
@@ -460,7 +460,7 @@ def setup_trains_logging(trainer, optimizers=None, evaluators=None, log_every_it
         **kwargs: optional keyword args to be passed to construct the logger.
 
     Returns:
-        TrainsLogger
+        :class:`~ignite.contrib.handlers.trains_logger.TrainsLogger`
     """
     logger = TrainsLogger(**kwargs)
     _setup_logging(logger, trainer, optimizers, evaluators, log_every_iters)
@@ -501,7 +501,7 @@ def gen_save_best_models_by_val_score(
         **kwargs: optional keyword args to be passed to construct :class:`~ignite.handlers.checkpoint.Checkpoint`.
 
     Returns:
-        A :class:`~ignite.handlers.checkpoint.Checkpoint` handler.
+        A :class:`~ignite.handlers.Checkpoint` handler.
     """
     global_step_transform = None
     if trainer is not None:
@@ -547,7 +547,7 @@ def save_best_model_by_val_score(
         **kwargs: optional keyword args to be passed to construct :class:`~ignite.handlers.checkpoint.Checkpoint`.
 
     Returns:
-        A :class:`~ignite.handlers.checkpoint.Checkpoint` handler.
+        A :class:`~ignite.handlers.Checkpoint` handler.
     """
     return gen_save_best_models_by_val_score(
         save_handler=DiskSaver(dirname=output_path, require_empty=False),
@@ -573,7 +573,7 @@ def add_early_stopping_by_val_score(patience, evaluator, trainer, metric_name):
             `evaluator.state.metrics`.
 
     Returns:
-        A :class:`~ignite.handlers.early_stopping.EarlyStopping` handler.
+        A :class:`~ignite.handlers.EarlyStopping` handler.
     """
     es_handler = EarlyStopping(patience=patience, score_function=get_default_score_fn(metric_name), trainer=trainer)
     evaluator.add_event_handler(Events.COMPLETED, es_handler)


Test patch: