Skip to content
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.

Sign up for GitHub

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

Clarify documentation regarding unequal length series limitation #2572

Closed
wants to merge 1 commit into from
Closed

Clarify documentation regarding unequal length series limitation #2572

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 16 additions & 0 deletions aeon/transformations/collection/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,10 @@ def fit(self, X, y=None):
``(n_channels, n_timepoints_i)``, where ``n_timepoints_i`` is length of
series ``i``. Other types are allowed and converted into one of the above.

**Note:** While a list of numpy arrays for unequal length series is accepted
as input, it cannot be processed and will raise a `ValueError`.
Ensure all time series have the same length before using the transformer.

Different estimators have different capabilities to handle different
types of input. If ``self.get_tag("capability:multivariate")`` is False,
they cannot handle multivariate series. If ``self.get_tag(
Expand Down Expand Up @@ -123,6 +127,10 @@ def transform(self, X, y=None):
``(n_channels, n_timepoints_i)``, where ``n_timepoints_i`` is length of
series ``i``. Other types are allowed and converted into one of the above.

**Note:** While a list of numpy arrays for unequal length series is accepted
as input, it cannot be processed and will raise a `ValueError`.
Ensure all time series have the same length before using the transformer.

Different estimators have different capabilities to handle different
types of input. If ``self.get_tag("capability:multivariate")`` is False,
they cannot handle multivariate series. If ``self.get_tag(
Expand Down Expand Up @@ -177,6 +185,10 @@ def fit_transform(self, X, y=None):
n_channels, n_timepoints_i)``, where ``n_timepoints_i`` is length of
series ``i``. Other types are allowed and converted into one of the above.

**Note:** While a list of numpy arrays for unequal length series is accepted
as input, it cannot be processed and will raise a `ValueError`.
Ensure all time series have the same length before using the transformer.

Different estimators have different capabilities to handle different
types of input. If ``self.get_tag("capability:multivariate")`` is False,
they cannot handle multivariate series. If ``self.get_tag(
Expand Down Expand Up @@ -227,6 +239,10 @@ def inverse_transform(self, X, y=None):
``(n_channels, n_timepoints_i)``, where ``n_timepoints_i`` is length of
series ``i``. Other types are allowed and converted into one of the above.

**Note:** While a list of numpy arrays for unequal length series is accepted
as input, it cannot be processed and will raise a `ValueError`.
Ensure all time series have the same length before using the transformer.

Different estimators have different capabilities to handle different
types of input. If ``self.get_tag("capability:multivariate")`` is False,
they cannot handle multivariate series. If ``self.get_tag(
Expand Down