diff --git a/ignite/contrib/handlers/base_logger.py b/ignite/contrib/handlers/base_logger.py index c3776835449d..6fd9949b274d 100644 --- a/ignite/contrib/handlers/base_logger.py +++ b/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) diff --git a/ignite/contrib/metrics/regression/canberra_metric.py b/ignite/contrib/metrics/regression/canberra_metric.py index 9f995370ed4b..5bb3cb8cca67 100644 --- a/ignite/contrib/metrics/regression/canberra_metric.py +++ b/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__( diff --git a/ignite/contrib/metrics/regression/manhattan_distance.py b/ignite/contrib/metrics/regression/manhattan_distance.py index 1abf3cffa17c..9d884196f17b 100644 --- a/ignite/contrib/metrics/regression/manhattan_distance.py +++ b/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__( diff --git a/ignite/contrib/metrics/regression/r2_score.py b/ignite/contrib/metrics/regression/r2_score.py index d7f735d5b696..f48adf22e33d 100644 --- a/ignite/contrib/metrics/regression/r2_score.py +++ b/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__( diff --git a/ignite/distributed/auto.py b/ignite/distributed/auto.py index 6cef0ed5bae5..9764e38db6f7 100644 --- a/ignite/distributed/auto.py +++ b/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") diff --git a/ignite/handlers/checkpoint.py b/ignite/handlers/checkpoint.py index 016bf9433075..41a567eecd56 100644 --- a/ignite/handlers/checkpoint.py +++ b/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)]) diff --git a/ignite/metrics/metric.py b/ignite/metrics/metric.py index 4b602092ef4c..053d7d0224ba 100644 --- a/ignite/metrics/metric.py +++ b/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): diff --git a/ignite/metrics/psnr.py b/ignite/metrics/psnr.py index 64f5cd195c94..8c00dba78725 100644 --- a/ignite/metrics/psnr.py +++ b/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__( diff --git a/ignite/utils.py b/ignite/utils.py index 91a9b8f4982c..fcee45a166d2 100644 --- a/ignite/utils.py +++ b/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)