From a498178124602c4c8e7c2c179e36c797166dbff8 Mon Sep 17 00:00:00 2001 From: Tony Bagnall Date: Fri, 26 Jul 2024 19:51:39 +0200 Subject: [PATCH] [DEP] Move HampelFilter to legacy (#1830) * Move HampelFilter * remove example --- aeon/forecasting/compose/tests/test_pipeline.py | 2 +- .../{ => _legacy}/outlier_detection.py | 15 --------------- docs/api_reference/transformations.rst | 8 -------- 3 files changed, 1 insertion(+), 24 deletions(-) rename aeon/transformations/{ => _legacy}/outlier_detection.py (93%) diff --git a/aeon/forecasting/compose/tests/test_pipeline.py b/aeon/forecasting/compose/tests/test_pipeline.py index 4b4f4324d0..d0bc059a4c 100644 --- a/aeon/forecasting/compose/tests/test_pipeline.py +++ b/aeon/forecasting/compose/tests/test_pipeline.py @@ -19,10 +19,10 @@ from aeon.testing.mock_estimators import MockForecaster, MockTransformer from aeon.testing.utils.estimator_checks import _assert_array_almost_equal from aeon.transformations._legacy.adapt import TabularToSeriesAdaptor +from aeon.transformations._legacy.outlier_detection import HampelFilter from aeon.transformations.detrend import Detrender from aeon.transformations.hierarchical.aggregate import Aggregator from aeon.transformations.impute import Imputer -from aeon.transformations.outlier_detection import HampelFilter from aeon.utils.index_functions import get_window from aeon.utils.validation._dependencies import _check_soft_dependencies diff --git a/aeon/transformations/outlier_detection.py b/aeon/transformations/_legacy/outlier_detection.py similarity index 93% rename from aeon/transformations/outlier_detection.py rename to aeon/transformations/_legacy/outlier_detection.py index 81c8e8b40a..26b9826aa0 100644 --- a/aeon/transformations/outlier_detection.py +++ b/aeon/transformations/_legacy/outlier_detection.py @@ -7,18 +7,11 @@ import numpy as np import pandas as pd -from deprecated.sphinx import deprecated from aeon.forecasting.model_selection import SlidingWindowSplitter from aeon.transformations.base import BaseTransformer -# TODO: remove in v0.11.0 -@deprecated( - version="0.10.0", - reason="HampelFilter will be removed in version 0.11.0.", - category=FutureWarning, -) class HampelFilter(BaseTransformer): """Use HampelFilter to detect outliers based on a sliding window. @@ -46,14 +39,6 @@ class HampelFilter(BaseTransformer): ---------- .. [1] Hampel F. R., "The influence curve and its role in robust estimation", Journal of the American Statistical Association, 69, 382–393, 1974 - - Examples - -------- - >>> from aeon.transformations.outlier_detection import HampelFilter - >>> from aeon.datasets import load_airline - >>> y = load_airline() - >>> transformer = HampelFilter(window_length=10) - >>> y_hat = transformer.fit_transform(y) """ _tags = { diff --git a/docs/api_reference/transformations.rst b/docs/api_reference/transformations.rst index 9983038266..286c5d203e 100644 --- a/docs/api_reference/transformations.rst +++ b/docs/api_reference/transformations.rst @@ -375,14 +375,6 @@ Bootstrap transformations Outlier detection, changepoint detection ---------------------------------------- -.. currentmodule:: aeon.transformations.outlier_detection - -.. autosummary:: - :toctree: auto_generated/ - :template: class.rst - - HampelFilter - .. currentmodule:: aeon.transformations.series._clasp .. autosummary::