From aed234f88b923c3c687d0c9efe001464cafa1878 Mon Sep 17 00:00:00 2001 From: FrAnCOisCokELaER Date: Thu, 4 Feb 2021 19:42:08 +0100 Subject: [PATCH 1/6] For v0.4.3 - Add more versionadded, versionchanged tags - Change v0.5.0 to v0.4.3 --- ignite/__init__.py | 2 +- ignite/contrib/handlers/base_logger.py | 3 +++ ignite/contrib/metrics/regression/canberra_metric.py | 4 ++++ ignite/contrib/metrics/regression/manhattan_distance.py | 4 ++++ ignite/contrib/metrics/regression/r2_score.py | 3 +++ ignite/distributed/auto.py | 3 +++ ignite/distributed/comp_models/horovod.py | 3 +++ ignite/handlers/checkpoint.py | 4 +++- ignite/metrics/metric.py | 3 +++ ignite/metrics/psnr.py | 2 +- ignite/utils.py | 2 ++ 11 files changed, 30 insertions(+), 3 deletions(-) diff --git a/ignite/__init__.py b/ignite/__init__.py index 0185adce1238..530b4c7c7ab4 100644 --- a/ignite/__init__.py +++ b/ignite/__init__.py @@ -6,4 +6,4 @@ import ignite.metrics import ignite.utils -__version__ = "0.5.0" +__version__ = "0.4.3" 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..cc3c076b0719 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 + + - Use ``abs`` in denominator. + - Work with ddp. """ def __init__( diff --git a/ignite/contrib/metrics/regression/manhattan_distance.py b/ignite/contrib/metrics/regression/manhattan_distance.py index 1abf3cffa17c..8fc5ad9362d4 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 + + - Fix formula and compare to sklearn. + - Work with ddp. """ def __init__( diff --git a/ignite/contrib/metrics/regression/r2_score.py b/ignite/contrib/metrics/regression/r2_score.py index d7f735d5b696..58912063f8c7 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 + Work 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/distributed/comp_models/horovod.py b/ignite/distributed/comp_models/horovod.py index d77464d1dacd..173f05eafc78 100644 --- a/ignite/distributed/comp_models/horovod.py +++ b/ignite/distributed/comp_models/horovod.py @@ -27,6 +27,9 @@ class _HorovodDistModel(ComputationModel): """Private class for `Horovod `_ distributed computation model. + + .. versionchanged:: 0.4.3 + Improved Horovod initializer. """ name = "horovod-dist" diff --git a/ignite/handlers/checkpoint.py b/ignite/handlers/checkpoint.py index 016bf9433075..2ba644119f95 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`` parameter. """ 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) From e62a8ba59e6fa9a73b91440c358f5b922cc8bb0b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fran=C3=A7ois=20COKELAER?= Date: Fri, 5 Feb 2021 17:10:24 +0100 Subject: [PATCH 2/6] Update ignite/contrib/metrics/regression/canberra_metric.py Co-authored-by: vfdev --- ignite/contrib/metrics/regression/canberra_metric.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/ignite/contrib/metrics/regression/canberra_metric.py b/ignite/contrib/metrics/regression/canberra_metric.py index cc3c076b0719..5bb3cb8cca67 100644 --- a/ignite/contrib/metrics/regression/canberra_metric.py +++ b/ignite/contrib/metrics/regression/canberra_metric.py @@ -24,8 +24,8 @@ class CanberraMetric(_BaseRegression): .. versionchanged:: 0.4.3 - - Use ``abs`` in denominator. - - Work with ddp. + - Fixed implementation: ``abs`` in denominator. + - Works with DDP. """ def __init__( From 124b5724d6d20655f59101de1174d92e3a4919fd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fran=C3=A7ois=20COKELAER?= Date: Fri, 5 Feb 2021 17:10:40 +0100 Subject: [PATCH 3/6] Update ignite/contrib/metrics/regression/manhattan_distance.py Co-authored-by: vfdev --- ignite/contrib/metrics/regression/manhattan_distance.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/ignite/contrib/metrics/regression/manhattan_distance.py b/ignite/contrib/metrics/regression/manhattan_distance.py index 8fc5ad9362d4..9d884196f17b 100644 --- a/ignite/contrib/metrics/regression/manhattan_distance.py +++ b/ignite/contrib/metrics/regression/manhattan_distance.py @@ -23,8 +23,8 @@ class ManhattanDistance(_BaseRegression): .. versionchanged:: 0.4.3 - - Fix formula and compare to sklearn. - - Work with ddp. + - Fixed sklearn compatibility. + - Workes with DDP. """ def __init__( From d3ed382d1be641cab83d27094cc6fac3910585df Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fran=C3=A7ois=20COKELAER?= Date: Fri, 5 Feb 2021 17:10:48 +0100 Subject: [PATCH 4/6] Update ignite/contrib/metrics/regression/r2_score.py Co-authored-by: vfdev --- ignite/contrib/metrics/regression/r2_score.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ignite/contrib/metrics/regression/r2_score.py b/ignite/contrib/metrics/regression/r2_score.py index 58912063f8c7..f48adf22e33d 100644 --- a/ignite/contrib/metrics/regression/r2_score.py +++ b/ignite/contrib/metrics/regression/r2_score.py @@ -21,7 +21,7 @@ class R2Score(_BaseRegression): - `y` and `y_pred` must be of same shape `(N, )` or `(N, 1)` and of type `float32`. .. versionchanged:: 0.4.3 - Work with ddp. + Works with DDP. """ def __init__( From 311e6cc41778c893f4734853a937619dd3a58e7e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fran=C3=A7ois=20COKELAER?= Date: Fri, 5 Feb 2021 17:11:02 +0100 Subject: [PATCH 5/6] Update ignite/handlers/checkpoint.py Co-authored-by: vfdev --- ignite/handlers/checkpoint.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ignite/handlers/checkpoint.py b/ignite/handlers/checkpoint.py index 2ba644119f95..41a567eecd56 100644 --- a/ignite/handlers/checkpoint.py +++ b/ignite/handlers/checkpoint.py @@ -250,7 +250,7 @@ def score_function(engine): .. versionchanged:: 0.4.3 - Checkpoint can save model with same filename. - - Added ``greater_or_equal`` parameter. + - Added ``greater_or_equal`` argument. """ Item = NamedTuple("Item", [("priority", int), ("filename", str)]) From c588fbfc015ef44ce578f56569fb18d6d435b72b Mon Sep 17 00:00:00 2001 From: FrAnCOisCokELaER Date: Fri, 5 Feb 2021 17:14:29 +0100 Subject: [PATCH 6/6] address PR comments --- ignite/__init__.py | 2 +- ignite/distributed/comp_models/horovod.py | 3 --- 2 files changed, 1 insertion(+), 4 deletions(-) diff --git a/ignite/__init__.py b/ignite/__init__.py index 530b4c7c7ab4..0185adce1238 100644 --- a/ignite/__init__.py +++ b/ignite/__init__.py @@ -6,4 +6,4 @@ import ignite.metrics import ignite.utils -__version__ = "0.4.3" +__version__ = "0.5.0" diff --git a/ignite/distributed/comp_models/horovod.py b/ignite/distributed/comp_models/horovod.py index 173f05eafc78..d77464d1dacd 100644 --- a/ignite/distributed/comp_models/horovod.py +++ b/ignite/distributed/comp_models/horovod.py @@ -27,9 +27,6 @@ class _HorovodDistModel(ComputationModel): """Private class for `Horovod `_ distributed computation model. - - .. versionchanged:: 0.4.3 - Improved Horovod initializer. """ name = "horovod-dist"