MiniRocketMultivariateVariable

class MiniRocketMultivariateVariable(num_kernels=10000, max_dilations_per_kernel=32, reference_length='max', pad_value_short_series=None, n_jobs=1, random_state=None)[source]

MINIROCKET (Multivariate, unequal length).

MINImally RandOm Convolutional KErnel Transform. [1]

Multivariate and unequal length

A provisional and naive extension of MINIROCKET to multivariate input with unequal length provided by the authors [2] . For better performance, use the sktime class MiniRocket for univariate input, and MiniRocketMultivariate to equal length multivariate input.

This transformer fits one set of paramereters per individual series, and applies the transform with fitted parameter i to the i-th series in transform. Vanilla use requires same number of series in fit and transform.

To fit and transform series at the same time, without an identification of fit/transform instances, wrap this transformer in FitInTransform, from sktime.transformations.compose.

Parameters:

num_kernelsint, default=10_000: number of random convolutional kernels. This should be a multiple of 84. If it is lower than 84, it will be set to 84. If it is higher than 84 and not a multiple of 84, the number of kernels used to transform the data will rounded down to the next positive multiple of 84.
max_dilations_per_kernelint, default=32: maximum number of dilations per kernel.
reference_lengthint or str, default = 'max': series-length of reference, str defines how to infer from X during ‘fit’. options are 'max', 'mean', 'median', 'min'.
pad_value_short_seriesfloat or None, default=None: if padding series with len<9 to value. if None, not padding is performed.
n_jobsint, default=1: The number of jobs to run in parallel for transform. -1 means using all processors.
random_stateNone or int, default = None

Attributes:

num_kernels_int: The true number of kernels used in the rocket transform. This is num_kernels rounded down to the nearest multiple of 84. It is 84 if num_kernels is less than 84.

Raises:

ValueError: If any multivariate series_length in X is < 9 and pad_value_short_series is set to None

References

[1]

Angus Dempster, Daniel F Schmidt, Geoffrey I Webb MINIROCKET: A Very Fast (Almost) Deterministic Transform for Time Series Classification, 2020, arXiv:2012.08791

[2]

Angus Dempster, Daniel F Schmidt, Geoffrey I Webb https://github.com/angus924/minirocket

Examples

>>> from sktime.transformations.rocket import MiniRocketMultivariateVariable
>>> from sktime.datasets import load_japanese_vowels
>>> # load multivariate and unequal length dataset
>>> X_train, _ = load_japanese_vowels(split="train", return_X_y=True)
>>> X_test, _ = load_japanese_vowels(split="test", return_X_y=True)
>>> pre_clf = MiniRocketMultivariateVariable(
...     pad_value_short_series=0.0
... )
>>> pre_clf.fit(X_train, y=None)
MiniRocketMultivariateVariable(...)
>>> X_transformed = pre_clf.transform(X_test)
>>> X_transformed.shape
(370, 9996)

Methods

`check_is_fitted`([method_name])	Check if the estimator has been fitted.
`clone`()	Obtain a clone of the object with same hyper-parameters and config.
`clone_tags`(estimator[, tag_names])	Clone tags from another object as dynamic override.
`create_test_instance`([parameter_set])	Construct an instance of the class, using first test parameter set.
`create_test_instances_and_names`([parameter_set])	Create list of all test instances and a list of names for them.
`fit`(X[, y])	Fit transformer to X, optionally to y.
`fit_transform`(X[, y])	Fit to data, then transform it.
`get_class_tag`(tag_name[, tag_value_default])	Get class tag value from class, with tag level inheritance from parents.
`get_class_tags`()	Get class tags from class, with tag level inheritance from parent classes.
`get_config`()	Get config flags for self.
`get_fitted_params`([deep])	Get fitted parameters.
`get_param_defaults`()	Get object's parameter defaults.
`get_param_names`([sort])	Get object's parameter names.
`get_params`([deep])	Get a dict of parameters values for this object.
`get_tag`(tag_name[, tag_value_default, ...])	Get tag value from instance, with tag level inheritance and overrides.
`get_tags`()	Get tags from instance, with tag level inheritance and overrides.
`get_test_params`([parameter_set])	Return testing parameter sets for the estimator.
`inverse_transform`(X[, y])	Inverse transform X and return an inverse transformed version.
`is_composite`()	Check if the object is composed of other BaseObjects.
`load_from_path`(serial)	Load object from file location.
`load_from_serial`(serial)	Load object from serialized memory container.
`reset`()	Reset the object to a clean post-init state.
`save`([path, serialization_format])	Save serialized self to bytes-like object or to (.zip) file.
`set_config`(**config_dict)	Set config flags to given values.
`set_params`(**params)	Set the parameters of this object.
`set_random_state`([random_state, deep, ...])	Set random_state pseudo-random seed parameters for self.
`set_tags`(**tag_dict)	Set instance level tag overrides to given values.
`transform`(X[, y])	Transform X and return a transformed version.
`update`(X[, y, update_params])	Update transformer with X, optionally y.