TimeSeriesKShape¶
- class TimeSeriesKShape(n_clusters: int = 8, init: str | ndarray = 'random', n_init: int = 10, max_iter: int = 300, tol: float = 0.0001, verbose: bool = False, random_state: int | RandomState | None = None)[source]¶
Kshape algorithm: wrapper of the
tslearn
implementation.- Parameters:
- n_clusters: int, default=8
The number of clusters to form as well as the number of centroids to generate.
- init: str or np.ndarray, default=’random’
Method for initialising cluster centres. Any of the following are valid: [‘random’]. Or a np.ndarray of shape (n_clusters, n_channels, n_timepoints) and gives the initial cluster centres.
- n_init: int, default=10
Number of times the k-means algorithm will be run with different centroid seeds. The final result will be the best output of n_init consecutive runs in terms of inertia.
- max_iter: int, default=30
Maximum number of iterations of the k-means algorithm for a single run.
- tol: float, default=1e-4
Relative tolerance with regards to Frobenius norm of the difference in the cluster centres of two consecutive iterations to declare convergence.
- verbose: bool, default=False
Verbosity mode.
- random_state: int or np.random.RandomState instance or None, default=None
Determines random number generation for centroid initialization.
- Attributes:
- labels_: np.ndarray (1d array of shape (n_cases,))
Labels that is the index each time series belongs to.
- inertia_: float
Sum of squared distances of samples to their closest cluster centre, weighted by the sample weights if provided.
- n_iter_: int
Number of iterations run.
References
[1]John Paparrizos and Luis Gravano. 2016. K-Shape: Efficient and Accurate Clustering of Time Series. SIGMOD Rec. 45, 1 (March 2016), 69–76. https://doi.org/10.1145/2949741.2949758
Examples
>>> from aeon.clustering import TimeSeriesKShape >>> from aeon.datasets import load_basic_motions >>> # Load data >>> X_train, y_train = load_basic_motions(split="TRAIN")[0:10] >>> X_test, y_test = load_basic_motions(split="TEST")[0:10] >>> # Example of KShapes clustering >>> ks = TimeSeriesKShape(n_clusters=3, random_state=1) >>> ks.fit(X_train) TimeSeriesKShape(n_clusters=3, random_state=1) >>> preds = ks.predict(X_test)
Methods
clone
([random_state])Obtain a clone of the object with the same hyperparameters.
fit
(X[, y])Fit time series clusterer to training data.
fit_predict
(X[, y])Compute cluster centers and predict cluster index for each time series.
get_class_tag
(tag_name[, raise_error, ...])Get tag value from estimator class (only class tags).
Get class tags from estimator class and all its parent classes.
get_fitted_params
([deep])Get fitted parameters.
Sklearn metadata routing.
get_params
([deep])Get parameters for this estimator.
get_tag
(tag_name[, raise_error, ...])Get tag value from estimator class.
get_tags
()Get tags from estimator.
predict
(X)Predict the closest cluster each sample in X belongs to.
Predicts labels probabilities for sequences in X.
reset
([keep])Reset the object to a clean post-init state.
set_params
(**params)Set the parameters of this estimator.
set_tags
(**tag_dict)Set dynamic tags to given values.
- clone(random_state=None)[source]¶
Obtain a clone of the object with the same hyperparameters.
A clone is a different object without shared references, in post-init state. This function is equivalent to returning
sklearn.clone
of self. Equal in value totype(self)(**self.get_params(deep=False))
.- Parameters:
- random_stateint, RandomState instance, or None, default=None
Sets the random state of the clone. If None, the random state is not set. If int, random_state is the seed used by the random number generator. If RandomState instance, random_state is the random number generator.
- Returns:
- estimatorobject
Instance of
type(self)
, clone of self (see above)
- fit(X, y=None) BaseCollectionEstimator [source]¶
Fit time series clusterer to training data.
- Parameters:
- X3D np.ndarray (any number of channels, equal length series)
of shape (n_cases, n_channels, n_timepoints)
- or 2D np.array (univariate, equal length series)
of shape (n_cases, n_timepoints)
- or list of numpy arrays (any number of channels, unequal length series)
of shape [n_cases], 2D np.array (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.
- y: ignored, exists for API consistency reasons.
- Returns:
- self:
Fitted estimator.
- fit_predict(X, y=None) ndarray [source]¶
Compute cluster centers and predict cluster index for each time series.
Convenience method; equivalent of calling fit(X) followed by predict(X)
- Parameters:
- Xnp.ndarray (2d or 3d array of shape (n_cases, n_timepoints) or shape
(n_cases, n_channels, n_timepoints)). Time series instances to train clusterer and then have indexes each belong to return.
- y: ignored, exists for API consistency reasons.
- Returns:
- np.ndarray (1d array of shape (n_cases,))
Index of the cluster each time series in X belongs to.
- classmethod get_class_tag(tag_name, raise_error=True, tag_value_default=None)[source]¶
Get tag value from estimator class (only class tags).
- Parameters:
- tag_namestr
Name of tag value.
- raise_errorbool, default=True
Whether a ValueError is raised when the tag is not found.
- tag_value_defaultany type, default=None
Default/fallback value if tag is not found and error is not raised.
- Returns:
- tag_value
Value of the
tag_name
tag in cls. If not found, returns an error ifraise_error
is True, otherwise it returnstag_value_default
.
- Raises:
- ValueError
if
raise_error
is True andtag_name
is not inself.get_tags().keys()
Examples
>>> from aeon.classification import DummyClassifier >>> DummyClassifier.get_class_tag("capability:multivariate") True
- classmethod get_class_tags()[source]¶
Get class tags from estimator class and all its parent classes.
- Returns:
- collected_tagsdict
Dictionary of tag name and tag value pairs. Collected from
_tags
class attribute via nested inheritance. These are not overridden by dynamic tags set byset_tags
or class__init__
calls.
- get_fitted_params(deep=True)[source]¶
Get fitted parameters.
- State required:
Requires state to be “fitted”.
- Parameters:
- deepbool, default=True
If True, will return the fitted parameters for this estimator and contained subobjects that are estimators.
- Returns:
- fitted_paramsdict
Fitted parameter names mapped to their values.
- get_params(deep=True)[source]¶
Get parameters for this estimator.
- Parameters:
- deepbool, default=True
If True, will return the parameters for this estimator and contained subobjects that are estimators.
- Returns:
- paramsdict
Parameter names mapped to their values.
- get_tag(tag_name, raise_error=True, tag_value_default=None)[source]¶
Get tag value from estimator class.
Includes dynamic and overridden tags.
- Parameters:
- tag_namestr
Name of tag to be retrieved.
- raise_errorbool, default=True
Whether a ValueError is raised when the tag is not found.
- tag_value_defaultany type, default=None
Default/fallback value if tag is not found and error is not raised.
- Returns:
- tag_value
Value of the
tag_name
tag in self. If not found, returns an error ifraise_error
is True, otherwise it returnstag_value_default
.
- Raises:
- ValueError
if raise_error is
True
andtag_name
is not inself.get_tags().keys()
Examples
>>> from aeon.classification import DummyClassifier >>> d = DummyClassifier() >>> d.get_tag("capability:multivariate") True
- get_tags()[source]¶
Get tags from estimator.
Includes dynamic and overridden tags.
- Returns:
- collected_tagsdict
Dictionary of tag name and tag value pairs. Collected from
_tags
class attribute via nested inheritance and then any overridden and new tags from__init__
orset_tags
.
- predict(X) ndarray [source]¶
Predict the closest cluster each sample in X belongs to.
- Parameters:
- X3D np.ndarray
Input data, any number of channels, equal length series of shape
( n_cases, n_channels, n_timepoints)
or 2D np.array (univariate, equal length series) of shape(n_cases, n_timepoints)
or list of numpy arrays (any number of channels, unequal length series) of shape[n_cases]
, 2D np.array(n_channels, n_timepoints_i)
, wheren_timepoints_i
is length of seriesi
. Other types are allowed and converted into one of the above.
- Returns:
- np.array
shape ``(n_cases)`, index of the cluster each time series in X. belongs to.
- predict_proba(X) ndarray [source]¶
Predicts labels probabilities for sequences in X.
Default behaviour is to call _predict and set the predicted class probability to 1, other class probabilities to 0. Override if better estimates are obtainable.
- Parameters:
- X3D np.ndarray
Input data, any number of channels, equal length series of shape
( n_cases, n_channels, n_timepoints)
or 2D np.array (univariate, equal length series) of shape(n_cases, n_timepoints)
or list of numpy arrays (any number of channels, unequal length series) of shape[n_cases]
, 2D np.array(n_channels, n_timepoints_i)
, wheren_timepoints_i
is length of seriesi
. Other types are allowed and converted into one of the above.
- Returns:
- y2D array of shape [n_cases, n_classes] - predicted class probabilities
1st dimension indices correspond to instance indices in X 2nd dimension indices correspond to possible labels (integers) (i, j)-th entry is predictive probability that i-th instance is of class j
- reset(keep=None)[source]¶
Reset the object to a clean post-init state.
After a
self.reset()
call, self is equal or similar in value totype(self)(**self.get_params(deep=False))
, assuming no other attributes were kept usingkeep
.- Detailed behaviour:
- removes any object attributes, except:
hyper-parameters (arguments of
__init__
) object attributes containing double-underscores, i.e., the string “__”
runs
__init__
with current values of hyperparameters (result ofget_params
)- Not affected by the reset are:
object attributes containing double-underscores class and object methods, class attributes any attributes specified in the
keep
argument
- Parameters:
- keepNone, str, or list of str, default=None
If None, all attributes are removed except hyperparameters. If str, only the attribute with this name is kept. If list of str, only the attributes with these names are kept.
- Returns:
- selfobject
Reference to self.
- set_params(**params)[source]¶
Set the parameters of this estimator.
The method works on simple estimators as well as on nested objects (such as
Pipeline
). The latter have parameters of the form<component>__<parameter>
so that it’s possible to update each component of a nested object.- Parameters:
- **paramsdict
Estimator parameters.
- Returns:
- selfestimator instance
Estimator instance.