Skip to content

Commit

Permalink
[DEP] Move HampelFilter to legacy (#1830)
Browse files Browse the repository at this point in the history
* Move HampelFilter

* remove example
  • Loading branch information
TonyBagnall authored Jul 26, 2024
1 parent 2b07bfc commit a498178
Show file tree
Hide file tree
Showing 3 changed files with 1 addition and 24 deletions.
2 changes: 1 addition & 1 deletion aeon/forecasting/compose/tests/test_pipeline.py
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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 = {
Expand Down
8 changes: 0 additions & 8 deletions docs/api_reference/transformations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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::
Expand Down

0 comments on commit a498178

Please sign in to comment.