For v0.4.3 - Add more versionadded, versionchanged tags - Change v0.5… (#1612)

* For v0.4.3 - Add more versionadded, versionchanged tags - Change v0.5.0 to v0.4.3

* Update ignite/contrib/metrics/regression/canberra_metric.py

Co-authored-by: vfdev <[email protected]>

* Update ignite/contrib/metrics/regression/manhattan_distance.py

Co-authored-by: vfdev <[email protected]>

* Update ignite/contrib/metrics/regression/r2_score.py

Co-authored-by: vfdev <[email protected]>

* Update ignite/handlers/checkpoint.py

Co-authored-by: vfdev <[email protected]>

* address PR comments

Co-authored-by: vfdev <[email protected]>

Author: fco-dv

ignite/contrib/handlers/base_logger.py

@@ -207,6 +207,9 @@ def attach_opt_params_handler(
 
         Returns:
             :class:`~ignite.engine.RemovableEventHandle`, which can be used to remove the handler.
+
+        .. versionchanged:: 0.4.3
+            Added missing return statement.
         """
         return self.attach(engine, self._create_opt_params_handler(*args, **kwargs), event_name=event_name)
 

ignite/contrib/metrics/regression/canberra_metric.py

@@ -22,6 +22,10 @@ class CanberraMetric(_BaseRegression):
     .. _scikit-learn distance metrics:
         https://scikit-learn.org/stable/modules/generated/sklearn.neighbors.DistanceMetric.html
 
+    .. versionchanged:: 0.4.3
+
+        - Fixed implementation: ``abs`` in denominator.
+        - Works with DDP.
     """
 
     def __init__(

ignite/contrib/metrics/regression/manhattan_distance.py

@@ -21,6 +21,10 @@ class ManhattanDistance(_BaseRegression):
 
     __ https://scikit-learn.org/stable/modules/generated/sklearn.neighbors.DistanceMetric.html
 
+    .. versionchanged:: 0.4.3
+
+        - Fixed sklearn compatibility.
+        - Workes with DDP.
     """
 
     def __init__(

ignite/contrib/metrics/regression/r2_score.py

@@ -19,6 +19,9 @@ class R2Score(_BaseRegression):
 
     - ``update`` must receive output of the form ``(y_pred, y)`` or ``{'y_pred': y_pred, 'y': y}``.
     - `y` and `y_pred` must be of same shape `(N, )` or `(N, 1)` and of type `float32`.
+
+    .. versionchanged:: 0.4.3
+        Works with DDP.
     """
 
     def __init__(

ignite/distributed/auto.py

@@ -174,6 +174,9 @@ def auto_model(model: nn.Module, sync_bn: bool = False, **kwargs: Any) -> nn.Mod
 
         - Added Horovod distributed framework.
         - Added ``sync_bn`` argument.
+
+    .. versionchanged:: 0.4.3
+        Added kwargs to ``idist.auto_model``.
     """
     logger = setup_logger(__name__ + ".auto_model")
 

ignite/handlers/checkpoint.py

@@ -248,7 +248,9 @@ def score_function(engine):
             > ["best_model_9_val_acc=0.77.pt", "best_model_10_val_acc=0.78.pt", ]
 
     .. versionchanged:: 0.4.3
-        Added ``greater_or_equal`` parameter.
+
+        - Checkpoint can save model with same filename.
+        - Added ``greater_or_equal`` argument.
     """
 
     Item = NamedTuple("Item", [("priority", int), ("filename", str)])

ignite/metrics/metric.py

@@ -302,6 +302,9 @@ def completed(self, engine: Engine, name: str) -> None:
         Args:
             engine (Engine): the engine to which the metric must be attached
             name (str): the name of the metric used as key in dict `engine.state.metrics`
+
+        .. versionchanged:: 0.4.3
+            Added dict in metrics results.
         """
         result = self.compute()
         if isinstance(result, Mapping):

ignite/metrics/psnr.py

@@ -64,7 +64,7 @@ def get_y_channel(output):
         state = engine.run(data)
         print(f"PSNR: {state.metrics['psrn']}")
 
-    .. versionadded:: 0.5.0
+    .. versionadded:: 0.4.3
     """
 
     def __init__(

ignite/utils.py

@@ -156,6 +156,8 @@ def manual_seed(seed: int) -> None:
     Args:
         seed (int): Random state seed
 
+    .. versionchanged:: 0.4.3
+        Added ``torch.cuda.manual_seed_all(seed)``.
     """
     random.seed(seed)
     torch.manual_seed(seed)