Skip to content

[ENH] Deprecate PLAID dataset #2928

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions aeon/datasets/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@
"load_italy_power_demand",
"load_japanese_vowels",
"load_pickup_gesture_wiimoteZ",
"load_plaid",
"load_longley",
"load_lynx",
"load_shampoo_sales",
Expand Down Expand Up @@ -76,7 +75,6 @@
load_osuleaf,
load_PBS_dataset,
load_pickup_gesture_wiimoteZ,
load_plaid,
load_shampoo_sales,
load_solar,
load_unit_test,
Expand Down
44 changes: 0 additions & 44 deletions aeon/datasets/_single_problem_loaders.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
__maintainer__ = []
__all__ = [
"load_airline",
"load_plaid",
"load_arrow_head",
"load_gunpoint",
"load_osuleaf",
Expand All @@ -28,7 +27,6 @@

import numpy as np
import pandas as pd
from deprecated.sphinx import deprecated

from aeon.datasets import load_from_tsf_file
from aeon.datasets._data_loaders import _load_saved_dataset, _load_tsc_dataset
Expand Down Expand Up @@ -379,48 +377,6 @@ def load_pickup_gesture_wiimoteZ(split=None):
return _load_tsc_dataset("PickupGestureWiimoteZ", split, return_type="np-list")


# TODO: remove in v1.3.0
@deprecated(
version="1.2.0",
reason="load_plaid and the PLAID dataset will be removed in version 1.3. It has "
"been replaced by a smaller unequal length univariate problem "
"PickupGestureWiimoteZ.",
category=FutureWarning,
)
def load_plaid(split=None):
"""Load the PLAID univariate time series classification problem.

Example of a univariate problem with unequal length time series.

Parameters
----------
split: None or one of "TRAIN", "TEST", default=None
Whether to load the train or test instances of the problem. By default it
loads both train and test instances into a single array.

Returns
-------
X: list of 2D np.ndarray, one for each series.
y: 1D numpy array of length len(X). The class labels for each time series
instance in X.

Notes
-----
Dimensionality: univariate
Series length: variable
Train cases: 537
Test cases: 537
Number of classes: 2
Details: https://timeseriesclassification.com/description.php?Dataset=PLAID

Examples
--------
>>> from aeon.datasets import load_plaid
>>> X, y = load_plaid()
"""
return _load_tsc_dataset("PLAID", split, return_type="np-list")


def load_japanese_vowels(split=None):
"""Load the JapaneseVowels time series classification problem.

Expand Down
Loading