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 (多变量，不等长)。

MINImally RandOm Convolutional KErnel Transform (最小随机卷积核变换)。 [1]

多变量和不等长

作者 [2] 提供了一个临时且朴素的 MINIROCKET 扩展，用于处理不等长多变量输入。为了获得更好的性能，对于单变量输入请使用 sktime 的 MiniRocket 类，对于等长多变量输入请使用 MiniRocketMultivariate。

此变换器为每个单独序列拟合一组参数，并在变换时将拟合参数应用于第 i 个序列。常规用法要求拟合和变换中的序列数量相同。

若要同时拟合和变换序列，无需识别拟合/变换实例，请将此变换器包装在 FitInTransform 中，该类来自 sktime.transformations.compose。

参数：:
num_kernelsint, 默认为 10_000

随机卷积核的数量。应为 84 的倍数。如果小于 84，将设置为 84。如果大于 84 且不是 84 的倍数，则用于变换数据的核数量将向下取整到最接近的 84 的正倍数。

max_dilations_per_kernelint, 默认为 32

每个核的最大膨胀数。

reference_lengthint 或 str, 默认为 'max'

参考序列长度，str 定义了如何在 'fit' 期间从 X 推断长度。选项包括 'max', 'mean', 'median', 'min'。

pad_value_short_seriesfloat 或 None, 默认为 None

如果填充长度小于 9 的序列到某个值。如果为 None，则不执行填充。

n_jobsint, 默认为 1

对于 transform，并行运行的作业数。-1 表示使用所有处理器。

random_stateNone 或 int, 默认为 None
属性：:
num_kernels_int

实际用于 Rocket 变换的核数量。这是 num_kernels 向下取整到最接近的 84 的倍数。如果 num_kernels 小于 84，则为 84。

引发异常：:
ValueError

如果 X 中任何多变量序列长度小于 9 且 pad_value_short_series 设置为 None。

另请参阅

MultiRocket, MiniRocket, MiniRocketMultivariate, Rocket

参考文献

[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 angus924/minirocket

示例

>>> from sktime.transformations.panel.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)

方法

check_is_fitted([method_name])

检查评估器是否已拟合。

clone()

获取具有相同超参数和配置的对象的克隆。

clone_tags(estimator[, tag_names])

从另一个对象克隆标签作为动态覆盖。

create_test_instance([parameter_set])

使用第一个测试参数集构建类的实例。

create_test_instances_and_names([parameter_set])

创建所有测试实例列表及其名称列表。

fit(X[, y])

将变换器拟合到 X，可选地拟合到 y。

fit_transform(X[, y])

拟合数据，然后对其进行变换。

get_class_tag(tag_name[, tag_value_default])

从类中获取类标签值，包含来自父类的标签级别继承。

get_class_tags()

从类中获取类标签，包含来自父类的标签级别继承。

get_config()

获取自身的配置标志。

get_fitted_params([deep])

获取已拟合参数。

get_param_defaults()

获取对象的默认参数。

get_param_names([sort])

获取对象的参数名称。

get_params([deep])

获取此对象的参数值字典。

get_tag(tag_name[, tag_value_default, ...])

从实例获取标签值，包含标签级别继承和覆盖。

get_tags()

从实例获取标签，包含标签级别继承和覆盖。

get_test_params([parameter_set])

返回 skbase 对象的测试参数设置。

inverse_transform(X[, y])

对 X 进行逆变换并返回逆变换后的版本。

is_composite()

检查对象是否由其他 BaseObjects 组成。

load_from_path(serial)

从文件位置加载对象。

load_from_serial(serial)

从序列化内存容器加载对象。

reset()

将对象重置为干净的初始化后状态。

save([path, serialization_format])

将序列化后的自身保存为字节类对象或 (.zip) 文件。

set_config(**config_dict)

将配置标志设置为给定值。

set_params(**params)

设置此对象的参数。

set_random_state([random_state, deep, ...])

为自身设置 random_state 伪随机种子参数。

set_tags(**tag_dict)

将实例级别标签覆盖设置为给定值。

transform(X[, y])

变换 X 并返回变换后的版本。

update(X[, y, update_params])

使用 X 更新变换器，可选地使用 y。
check_is_fitted(method_name=None)[source]#

检查评估器是否已拟合。

检查 _is_fitted 属性是否存在且为 True。is_fitted 属性应在调用对象的 fit 方法时设置为 True。

如果不是，则引发 NotFittedError。

参数：:
method_namestr, optional

调用此方法的函数名称。如果提供，错误消息将包含此信息。

引发异常：:
NotFittedError

如果评估器尚未拟合。

clone()[source]#

获取具有相同超参数和配置的对象的克隆。

克隆是一个不同的对象，没有共享引用，处于初始化后状态。此函数等同于返回 sklearn.clone 的 self。

等同于构造 type(self) 的新实例，参数与 self 相同，即 type(self)(**self.get_params(deep=False))。

如果 self 上设置了配置，克隆也将具有与原始对象相同的配置，等同于调用 cloned_self.set_config(**self.get_config())。

其值也等同于调用 self.reset，不同之处在于 clone 返回新对象，而 reset 会改变 self。

引发异常：:
如果克隆不符合规范，由有缺陷的 __init__ 引起。
clone_tags(estimator, tag_names=None)[source]#

从另一个对象克隆标签作为动态覆盖。

每个 scikit-base 兼容对象都包含一个标签字典。标签可用于存储对象的元数据，或控制对象的行为。

标签是特定于实例 self 的键值对，是静态标志，在对象构建后不会改变。

clone_tags 从另一个对象 estimator 设置动态标签覆盖。

clone_tags 方法应仅在对象的 __init__ 方法中，在构建期间或通过 __init__ 构建后直接调用。

动态标签被设置为 estimator 中指定在 tag_names 中的标签值。

tag_names 的默认值将 estimator 中的所有标签写入 self。

当前标签值可通过 get_tags 或 get_tag 进行检查。

参数：:
estimator一个 :class:BaseObject 或派生类的实例。
tag_namesstr 或 str 列表，默认为 None

要克隆的标签名称。默认值 (None) 克隆 estimator 中的所有标签。

返回：:
self

对 self 的引用。

classmethod create_test_instance(parameter_set='default')[source]#

使用第一个测试参数集构建类的实例。

参数：:
parameter_setstr, 默认为“default”

要返回的测试参数集名称，用于测试。如果某个值未定义特殊参数，将返回 “default” 集。

返回：:
instance具有默认参数的类实例
classmethod create_test_instances_and_names(parameter_set='default')[source]#

创建所有测试实例列表及其名称列表。

参数：:
parameter_setstr, 默认为“default”

要返回的测试参数集名称，用于测试。如果某个值未定义特殊参数，将返回 “default” 集。

返回：:
objscls 实例列表

第 i 个实例是 cls(**cls.get_test_params()[i])

namesstr 列表，长度与 objs 相同

第 i 个元素是在测试中 objs 中第 i 个实例的名称。如果多于一个实例，命名约定为 {cls.__name__}-{i}，否则为 {cls.__name__}

fit(X, y=None)[source]#

将变换器拟合到 X，可选地拟合到 y。

状态改变

将状态改为“已拟合”。

写入 self

  • 设置以“_”结尾的拟合模型属性，拟合属性可通过 get_fitted_params 检查。

  • 将 self.is_fitted 标志设置为 True。

  • 如果 self.get_tag("remember_data") 为 True，则将 X 记住为 self._X，强制转换为 self.get_tag("X_inner_mtype")。

参数：:
Xsktime 兼容数据容器格式的时间序列数据，用于拟合变换器。

用于拟合变换的数据。

sktime 中的个体数据格式称为 mtype 规范，每种 mtype 实现一个抽象 scitype。

  • Series scitype = 个体时间序列。pd.DataFrame, pd.Series, 或 np.ndarray (1D 或 2D)

  • Panel scitype = 时间序列集合。pd.DataFrame 具有 2 级行 MultiIndex (instance, time)，3D np.ndarray (instance, variable, time)，Series 类型的 pd.DataFrame list

  • Hierarchical scitype = 层级时间序列集合。pd.DataFrame 具有 3 级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)

关于数据格式的更多细节，请参阅关于 mtype 的词汇表。关于用法，请参阅变换器教程 examples/03_transformers.ipynb

y可选，sktime 兼容数据格式的数据，默认为 None

额外数据，例如用于变换的标签。如果 self.get_tag("requires_y") 为 True，则必须在 fit 中传递，不可选。所需格式，请参阅类文档字符串获取详细信息。

返回：:
self拟合后的评估器实例
fit_transform(X, y=None)[source]#

拟合数据，然后对其进行变换。

将变换器拟合到 X 和 y，并返回 X 的变换版本。

状态改变

将状态改为“已拟合”。

写入 self: _is_fitted: 标志设置为 True。_X: X 的强制副本，如果 remember_data 标签为 True

在可能的情况下，通过引用强制转换为内部类型或 update_data 兼容类型。

模型属性（以“_”结尾）：取决于评估器

参数：:
Xsktime 兼容数据容器格式的时间序列数据，用于拟合变换器。

用于拟合变换的数据，以及要变换的数据。

sktime 中的个体数据格式称为 mtype 规范，每种 mtype 实现一个抽象 scitype。

  • Series scitype = 个体时间序列。pd.DataFrame, pd.Series, 或 np.ndarray (1D 或 2D)

  • Panel scitype = 时间序列集合。pd.DataFrame 具有 2 级行 MultiIndex (instance, time)，3D np.ndarray (instance, variable, time)，Series 类型的 pd.DataFrame list

  • Hierarchical scitype = 层级时间序列集合。pd.DataFrame 具有 3 级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)

关于数据格式的更多细节，请参阅关于 mtype 的词汇表。关于用法，请参阅变换器教程 examples/03_transformers.ipynb

y可选，sktime 兼容数据格式的数据，默认为 None

额外数据，例如用于变换的标签。如果 self.get_tag("requires_y") 为 True，则必须在 fit 中传递，不可选。所需格式，请参阅类文档字符串获取详细信息。

返回：:
X 的变换版本
类型取决于 X 的类型和 scitype:transform-output 标签
X | 变换输出|----------|————–|------------------------| | 序列 | 基本类型 | pd.DataFrame (1 行) | | 面板 | 基本类型 | pd.DataFrame | | 序列 | 序列 | 序列 | | 面板 | 序列 | 面板 | | 序列 | 面板 | 面板 |

|----------|————–|------------------------| | Series | Primitives | pd.DataFrame (1 行) | | Panel | Primitives | pd.DataFrame | | Series | Series | Series | | Panel | Series | Panel | | Series | Panel | Panel |

返回中的实例对应于 X 中的实例
表中未列出的组合目前不受支持
详细解释，带示例

  • 如果 X 是 Series (例如，pd.DataFrame)

且 transform-output 是 Series，则返回值为相同 mtype 的单个 Series。示例：对单个序列进行去趋势处理。

  • 如果 X 是 Panel (例如，pd-multiindex) 且 transform-output

是 Series，则返回值为具有与 X 相同实例数量的 Panel (变换器应用于每个输入 Series 实例)。示例：面板中的所有序列都被单独去趋势处理。

  • 如果 X 是 Series 或 Panel 且 transform-output 是

Primitives，则返回值为具有与 X 中实例数量相同行数的 pd.DataFrame。示例：返回值的第 i 行包含第 i 个序列的均值和方差。

  • 如果 X 是 Series 且 transform-output 是 Panel，

则返回值为 pd-multiindex 类型的 Panel 对象。示例：输出的第 i 个实例是 X 上运行的第 i 个窗口。

classmethod get_class_tag(tag_name, tag_value_default=None)[source]#

从类中获取类标签值，包含来自父类的标签级别继承。

每个 scikit-base 兼容对象都包含一个标签字典，用于存储对象的元数据。

get_class_tag 方法是一个类方法，它检索标签值时仅考虑类级别的标签值和覆盖。

它从对象中返回名称为 tag_name 的标签值，考虑标签覆盖，优先级按降序排列如下：

  1. 类中的 _tags 属性中设置的标签。

  2. 父类的 _tags 属性中设置的标签，

按继承顺序排列。

不考虑在实例上通过 set_tags 或 clone_tags 设置的动态标签覆盖。

若要检索可能包含实例覆盖的标签值，请改用 get_tag 方法。

参数：:
tag_namestr

标签值的名称。

tag_value_defaultany type, optional; 默认为 None

如果未找到标签，则使用默认/回退值。

返回：:
tag_value

self 中 tag_name 标签的值。如果未找到，则返回 tag_value_default。

classmethod get_class_tags()[source]#

从类中获取类标签，包含来自父类的标签级别继承。

每个 scikit-base 兼容对象都包含一个标签字典。标签可用于存储对象的元数据，或控制对象的行为。

标签是特定于实例 self 的键值对，是静态标志，在对象构建后不会改变。

get_class_tags 方法是一个类方法，它检索标签值时仅考虑类级别的标签值和覆盖。

它返回一个字典，其中键是类或其任何父类中设置的任何 _tags 属性的键。

值是相应的标签值，覆盖优先级按降序排列如下：

  1. 类中的 _tags 属性中设置的标签。

  2. 父类的 _tags 属性中设置的标签，

按继承顺序排列。

实例可以根据超参数覆盖这些标签。

若要检索可能包含实例覆盖的标签，请改用 get_tags 方法。

不考虑在实例上通过 set_tags 或 clone_tags 设置的动态标签覆盖。

若要包含来自动态标签的覆盖，请使用 get_tags。

collected_tagsdict

标签名称: 标签值对的字典。从 _tags 类属性通过嵌套继承收集。不被通过 set_tags 或 clone_tags 设置的动态标签覆盖。

get_config()[source]#

获取自身的配置标志。

配置是 self 的键值对，通常用作控制行为的临时标志。

get_config 返回动态配置，动态配置会覆盖默认配置。

默认配置设置在类或其父类的 _config 类属性中，并通过 set_config 设置的动态配置进行覆盖。

配置在 clone 或 reset 调用下保留。

返回：:
config_dictdict

配置名称: 配置值对的字典。从 _config 类属性通过嵌套继承收集，然后应用 _onfig_dynamic 对象属性中的任何覆盖和新标签。

get_fitted_params(deep=True)[source]#

获取已拟合参数。

所需状态

需要状态为“已拟合”。

参数：:
deepbool, 默认为 True

是否返回组件的拟合参数。

  • 如果为 True，将返回此对象的参数名称: 值字典，包括可拟合组件（= BaseEstimator 值的参数）的拟合参数。

  • 如果为 False，将返回此对象的参数名称: 值字典，但不包括组件的拟合参数。

返回：:
fitted_paramsdict with str-valued keys

拟合参数的字典，paramname: paramvalue 键值对包含

  • 始终：此对象的所有拟合参数，通过 get_param_names。值是该键的此对象的拟合参数值。

  • 如果 deep=True，还包含组件参数的键/值对。组件的参数索引为 [componentname]__[paramname]。componentname 的所有参数作为 paramname 及其值出现。

  • 如果 deep=True，还包含任意级别的组件递归，例如 [componentname]__[componentcomponentname]__[paramname] 等。

classmethod get_param_defaults()[source]#

获取对象的默认参数。

返回：:
default_dict: dict[str, Any]

键是 cls 中在 __init__ 中定义了默认值的所有参数。值是默认值，如 __init__ 中定义的。

classmethod get_param_names(sort=True)[source]#

获取对象的参数名称。

参数：:
sortbool, 默认为 True

是否按字母顺序排序返回参数名称 (True)，或按它们在类 __init__ 中出现的顺序返回 (False)。

返回：:
param_names: list[str]

cls 的参数名称列表。如果 sort=False，则按它们在类 __init__ 中出现的相同顺序排列。如果 sort=True，则按字母顺序排列。

get_params(deep=True)[source]#

获取此对象的参数值字典。

参数：:
deepbool, 默认为 True

是否返回组件的参数。

  • 如果为 True，将返回此对象的参数名称: 值 dict，包括组件（= BaseObject 值的参数）的参数。

  • 如果为 False，将返回此对象的参数名称: 值 dict，但不包括组件的参数。

返回：:
paramsdict with str-valued keys

参数字典，paramname: paramvalue 键值对包含

  • 始终：此对象的所有参数，通过 get_param_names。值是该键的此对象的参数值。值始终与构建时传递的值相同。

  • 如果 deep=True，还包含组件参数的键/值对。组件的参数索引为 [componentname]__[paramname]。componentname 的所有参数作为 paramname 及其值出现。

  • 如果 deep=True，还包含任意级别的组件递归，例如 [componentname]__[componentcomponentname]__[paramname] 等。

get_tag(tag_name, tag_value_default=None, raise_error=True)[source]#

从实例获取标签值，包含标签级别继承和覆盖。

每个 scikit-base 兼容对象都包含一个标签字典。标签可用于存储对象的元数据，或控制对象的行为。

标签是特定于实例 self 的键值对，是静态标志，在对象构建后不会改变。

get_tag 方法从实例中检索名称为 tag_name 的单个标签值，考虑标签覆盖，优先级按降序排列如下：

  1. 在实例构建时通过 set_tags 或 clone_tags 设置在实例上的标签，

在实例构建时。

  1. 类中的 _tags 属性中设置的标签。

  2. 父类的 _tags 属性中设置的标签，

按继承顺序排列。

参数：:
tag_namestr

要检索的标签名称。

tag_value_defaultany type, optional; 默认为 None

如果未找到标签，则使用默认/回退值。

raise_errorbool

当未找到标签时是否引发 ValueError。

返回：:
tag_valueAny

self 中 tag_name 标签的值。如果未找到，如果 raise_error 为 True 则引发错误，否则返回 tag_value_default。

引发异常：:
ValueError，如果 raise_error 为 True。

如果 tag_name 不在 self.get_tags().keys() 中，则引发 ValueError。

get_tags()[source]#

从实例获取标签，包含标签级别继承和覆盖。

每个 scikit-base 兼容对象都包含一个标签字典。标签可用于存储对象的元数据，或控制对象的行为。

标签是特定于实例 self 的键值对，是静态标志，在对象构建后不会改变。

get_tags 方法返回一个标签字典，其中键是类或其任何父类中设置的任何 _tags 属性的键，或者通过 set_tags 或 clone_tags 设置的标签的键。

值是相应的标签值，覆盖优先级按降序排列如下：

  1. 在实例构建时通过 set_tags 或 clone_tags 设置在实例上的标签，

在实例构建时。

  1. 类中的 _tags 属性中设置的标签。

  2. 父类的 _tags 属性中设置的标签，

按继承顺序排列。

返回：:
collected_tagsdict

标签名称: 标签值对的字典。从 _tags 类属性通过嵌套继承收集，然后应用 _tags_dynamic 对象属性中的任何覆盖和新标签。

classmethod get_test_params(parameter_set='default')[source]#

返回 skbase 对象的测试参数设置。

get_test_params 是一个统一的接口点，用于存储测试目的的参数设置。此函数也用于 create_test_instance 和 create_test_instances_and_names 来构造测试实例。

get_test_params 应该返回一个 dict，或一个 dict 的 list。

每个 dict 是一个用于测试的参数配置，可用于构造一个“有趣的”测试实例。对于 get_test_params 返回中的所有字典 params，调用 cls(**params) 应该是有效的。

The get_test_params need not return fixed lists of dictionaries, it can also return dynamic or stochastic parameter settings.

参数：:
parameter_setstr, 默认为“default”

要返回的测试参数集名称，用于测试。如果某个值未定义特殊参数，将返回 “default” 集。

返回：:
paramsdict or list of dict, default = {}

用于创建类测试实例的参数。每个字典是构造一个“有趣的”测试实例的参数，例如 MyClass(**params) 或 MyClass(**params[i]) 创建一个有效的测试实例。create_test_instance 使用 params 中的第一个（或唯一）字典。

inverse_transform(X, y=None)[source]#

对 X 进行逆变换并返回逆变换后的版本。

目前假设只有带有以下标签的转换器

“scitype:transform-input”=”Series”, “scitype:transform-output”=”Series”,

具有 inverse_transform 方法。

所需状态

需要状态为“已拟合”。

访问 self 中的属性

  • 拟合模型属性以“_”结尾。

  • self.is_fitted，必须为 True

参数：:
Xsktime 兼容数据容器格式的时间序列数据，用于拟合变换器。

用于拟合变换的数据。

sktime 中的个体数据格式称为 mtype 规范，每种 mtype 实现一个抽象 scitype。

  • Series scitype = 个体时间序列。pd.DataFrame, pd.Series, 或 np.ndarray (1D 或 2D)

  • Panel scitype = 时间序列集合。pd.DataFrame 具有 2 级行 MultiIndex (instance, time)，3D np.ndarray (instance, variable, time)，Series 类型的 pd.DataFrame list

  • Hierarchical scitype = 层级时间序列集合。pd.DataFrame 具有 3 级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)

关于数据格式的更多细节，请参阅关于 mtype 的词汇表。关于用法，请参阅变换器教程 examples/03_transformers.ipynb

y可选，sktime 兼容数据格式的数据，默认为 None

附加数据，例如用于转换的标签。某些转换器需要此数据，详情请参阅类文档字符串。

返回：:
X 的逆转换版本

与 X 类型相同，并符合 mtype 格式规范

is_composite()[source]#

检查对象是否由其他 BaseObjects 组成。

复合对象是包含其他对象作为参数的对象。在实例上调用，因为这可能因实例而异。

返回：:
composite：布尔值

对象是否有任何参数，其值为 BaseObject 的后代实例。

property is_fitted[source]#

是否已调用 fit。

检查对象的 _is_fitted` 属性，该属性应在对象构造期间初始化为 ``False，并在调用对象的 fit 方法时设置为 True。

返回：:
布尔值

估计器是否已进行 fit。

classmethod load_from_path(serial)[source]#

从文件位置加载对象。

参数：:
serialZipFile(path).open(“object) 的结果
返回：:
反序列化的 self，结果在 path 处，来自 cls.save(path) 的输出
classmethod load_from_serial(serial)[source]#

从序列化内存容器加载对象。

参数：:
serialcls.save(None) 输出的第1个元素
返回：:
反序列化的 self，结果为 serial，来自 cls.save(None) 的输出
reset()[source]#

将对象重置为干净的初始化后状态。

将 self 设置为其构造函数调用后直接处于的状态，保留相同的超参数。通过 set_config 设置的配置值也保留。

reset 调用会删除任何对象属性，除了

  • 超参数 = __init__ 的参数，写入到 self 中，例如 self.paramname，其中 paramname 是 __init__ 的一个参数

  • 包含双下划线字符串“__”的对象属性。例如，名为“__myattr”的属性会保留。

  • 配置属性，配置保持不变。也就是说，在 reset 前后调用 get_config 的结果相等。

类和对象方法，以及类属性也不受影响。

等同于 clone，但 reset 会修改 self，而不是返回一个新对象。

在调用 self.reset() 后，self 的值和状态与构造函数调用 ``type(self)(**self.get_params(deep=False))`` 后获得的对象相同。

返回：:
self

类实例重置到干净的初始化后状态，但保留当前的超参数值。

save(path=None, serialization_format='pickle')[source]#

将序列化后的自身保存为字节类对象或 (.zip) 文件。

行为：如果 path 为 None，则返回一个内存中的序列化 self；如果 path 是文件位置，则将 self 存储在该位置作为 zip 文件

保存的文件是 zip 文件，包含以下内容：_metadata - 包含 self 的类，即 type(self)；_obj - 序列化的 self。此类使用默认序列化方式 (pickle)。

参数：:
pathNone 或文件位置 (str 或 Path)

如果为 None，self 将保存到内存对象；如果是文件位置，self 将保存到该文件位置。如果

  • path=”estimator” 则会在当前工作目录 (cwd) 创建一个 zip 文件 estimator.zip。

  • path=”/home/stored/estimator” 则会创建一个 zip 文件 estimator.zip 并

存储在 /home/stored/ 中。

serialization_format：字符串，默认 = “pickle”

用于序列化的模块。可用选项有“pickle”和“cloudpickle”。请注意，非默认格式可能需要安装其他软依赖项。

返回：:
如果 path 为 None - 内存中的序列化 self
如果 path 为文件位置 - 引用该文件的 ZipFile 对象
set_config(**config_dict)[source]#

将配置标志设置为给定值。

参数：:
config_dictdict

配置名称 : 配置值对的字典。有效的配置、值及其含义如下所列

display字符串，“diagram”（默认），或“text”

jupyter 内核如何显示 self 的实例

  • “diagram” = html 方框图表示

  • “text” = 字符串打印输出

print_changed_only布尔值，默认=True

打印 self 时是否只列出与默认值不同的参数（False），还是列出所有参数名称和值（False）。不进行嵌套，即只影响 self，而不影响组件估计器。

warnings字符串，“on”（默认），或“off”

是否触发警告，仅影响来自 sktime 的警告

  • “on” = 将触发来自 sktime 的警告

  • “off” = 将不会触发来自 sktime 的警告

backend:parallel字符串，可选，默认=”None”

广播/向量化时用于并行处理的后端，以下选项之一：

  • “None”：按顺序执行循环，简单的列表推导式

  • “loky”、“multiprocessing”和“threading”：使用 joblib.Parallel

  • “joblib”：自定义和第三方 joblib 后端，例如 spark

  • “dask”：使用 dask，需要环境中安装 dask 包

  • “ray”：使用 ray，需要环境中安装 ray 包

backend:parallel:params字典，可选，默认={}（不传递参数）

作为配置传递给并行化后端的附加参数。有效键取决于 backend:parallel 的值

  • “None”：无附加参数，忽略 backend_params

  • “loky”、“multiprocessing”和“threading”：默认 joblib 后端。此处可以传递 joblib.Parallel 的任何有效键，例如 n_jobs，但 backend 除外，它直接由 backend 控制。如果未传递 n_jobs，它将默认为 -1，其他参数将默认为 joblib 的默认值。

  • “joblib”：自定义和第三方 joblib 后端，例如 spark。此处可以传递 joblib.Parallel 的任何有效键，例如 n_jobs。backend 必须作为 backend_params 的一个键在此处传递。如果未传递 n_jobs，它将默认为 -1，其他参数将默认为 joblib 的默认值。

  • “dask”：可以传递 dask.compute 的任何有效键，例如 scheduler

  • “ray”：可以传递以下键

    • “ray_remote_args”：ray.init 的有效键字典

    • “shutdown_ray”：布尔值，默认=True；False 防止 ray 在

      并行化后关闭。

    • “logger_name”：字符串，默认=”ray”；要使用的日志记录器的名称。

    • “mute_warnings”：布尔值，默认=False；如果为 True，则抑制警告

input_conversion字符串，选项之一：“on”（默认）、“off”或有效的 mtype 字符串

控制输入检查和转换，适用于 _fit、_transform、_inverse_transform、_update

  • "on" - 执行输入检查和转换

  • "off" - 在将数据传递给内部方法之前，不执行输入检查和转换

  • 有效的 mtype 字符串 - 输入假定为指定的 mtype，执行转换但不进行检查

output_conversion字符串，选项之一：“on”、“off”、有效的 mtype 字符串

控制 _transform、_inverse_transform 的输出转换

  • "on" - 如果 input_conversion 为“on”，则执行输出转换

  • "off" - 直接返回 _transform、_inverse_transform 的输出

  • 有效的 mtype 字符串 - 输出转换为指定的 mtype

返回：:
self对 self 的引用。

说明

更改对象状态，将 config_dict 中的配置复制到 self._config_dynamic。

set_params(**params)[source]#

设置此对象的参数。

该方法适用于简单的 skbase 对象以及复合对象。参数键字符串 <component>__<parameter> 可用于复合对象（即包含其他对象的对象），以访问组件 <component> 中的 <parameter>。如果引用明确（例如，没有两个组件参数具有相同的名称 <parameter>），也可以使用不带 <component>__ 的字符串 <parameter>。

参数：:
**params字典

BaseObject 参数，键必须是 <component>__<parameter> 字符串。__ 后缀可以作为完整字符串的别名，如果它们在 get_params 键中是唯一的。

返回：:
self对 self 的引用（参数设置后）
set_random_state(random_state=None, deep=True, self_policy='copy')[source]#

为自身设置 random_state 伪随机种子参数。

通过 self.get_params 查找名为 random_state 的参数，并将其设置为通过 set_params 从 random_state 派生的整数。这些整数通过 sample_dependent_seed 的链式哈希采样，保证了种子随机生成器的伪随机独立性。

根据 self_policy，应用于 self 中的 random_state 参数，并且当且仅当 deep=True 时应用于剩余的组件对象。

注意：即使 self 没有 random_state 参数，或者没有组件具有 random_state 参数，也会调用 set_params。因此，set_random_state 将重置任何 scikit-base 对象，即使那些没有 random_state 参数的对象。

参数：:
random_state整数、RandomState 实例或 None，默认=None

伪随机数生成器，用于控制随机整数的生成。传递整数以便在多次函数调用中获得可重复的输出。

deepbool, 默认为 True

是否在 skbase 对象值参数（即组件估计器）中设置随机状态。

  • 如果为 False，将仅设置 self 的 random_state 参数（如果存在）。

  • 如果为 True，将同时设置组件对象中的 random_state 参数。

self_policy字符串，选项之一：{“copy”, “keep”, “new”}，默认=”copy”

  • “copy”：self.random_state 设置为输入的 random_state

  • “keep”：self.random_state 保持原样

  • “new”：self.random_state 设置为一个新的随机状态，

从输入的 random_state 派生，通常与输入的不同

返回：:
self对 self 的引用
set_tags(**tag_dict)[source]#

将实例级别标签覆盖设置为给定值。

每个 scikit-base 兼容对象都包含一个标签字典，用于存储对象的元数据。

标签是特定于实例 self 的键值对，它们是构造对象后不会更改的静态标志。它们可用于元数据检查或控制对象的行为。

set_tags 将动态标签覆盖设置为 tag_dict 中指定的值，其中键是标签名称，字典值是要设置的标签值。

set_tags 方法应该只在对象的 __init__ 方法中（构造期间）或直接在 __init__ 之后调用。

当前标签值可通过 get_tags 或 get_tag 进行检查。

参数：:
**tag_dict字典

标签名称: 标签值对的字典。

返回：:
Self

对 self 的引用。

transform(X, y=None)[source]#

变换 X 并返回变换后的版本。

所需状态

需要状态为“已拟合”。

访问 self 中的属性

  • 拟合模型属性以“_”结尾。

  • self.is_fitted，必须为 True

参数：:
Xsktime 兼容数据容器格式的时间序列数据，用于拟合变换器。

要转换的数据。

sktime 中的个体数据格式称为 mtype 规范，每种 mtype 实现一个抽象 scitype。

  • Series scitype = 个体时间序列。pd.DataFrame, pd.Series, 或 np.ndarray (1D 或 2D)

  • Panel scitype = 时间序列集合。pd.DataFrame 具有 2 级行 MultiIndex (instance, time)，3D np.ndarray (instance, variable, time)，Series 类型的 pd.DataFrame list

  • Hierarchical scitype = 层级时间序列集合。pd.DataFrame 具有 3 级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)

关于数据格式的更多细节，请参阅关于 mtype 的词汇表。关于用法，请参阅变换器教程 examples/03_transformers.ipynb

y可选，sktime 兼容数据格式的数据，默认为 None

附加数据，例如用于转换的标签。某些转换器需要此数据，详情请参阅类文档字符串。

返回：:
X 的变换版本
类型取决于 X 的类型和 scitype:transform-output 标签

transform 方法的返回值类型

输入 X 的 scitype

transform 的输出 scitype

返回类型

Series

Primitives

pd.DataFrame (1行)

Panel

Primitives

pd.DataFrame

Series

Series

Series

Panel

Series

Panel

Series

Panel

Panel
返回中的实例对应于 X 中的实例
表中未列出的组合目前不受支持
详细解释，带示例

  • 如果 X 是 Series (例如，pd.DataFrame)

且 transform-output 是 Series，则返回值为相同 mtype 的单个 Series。示例：对单个序列进行去趋势处理。

  • 如果 X 是 Panel (例如，pd-multiindex) 且 transform-output

是 Series，则返回值为具有与 X 相同实例数量的 Panel (变换器应用于每个输入 Series 实例)。示例：面板中的所有序列都被单独去趋势处理。

  • 如果 X 是 Series 或 Panel 且 transform-output 是

Primitives，则返回值为具有与 X 中实例数量相同行数的 pd.DataFrame。示例：返回值的第 i 行包含第 i 个序列的均值和方差。

  • 如果 X 是 Series 且 transform-output 是 Panel，

则返回值为 pd-multiindex 类型的 Panel 对象。示例：输出的第 i 个实例是 X 上运行的第 i 个窗口。

update(X, y=None, update_params=True)[source]#

使用 X 更新变换器，可选地使用 y。

所需状态

需要状态为“已拟合”。

访问 self 中的属性

  • 拟合模型属性以“_”结尾。

  • self.is_fitted，必须为 True

写入 self

  • 拟合模型属性以“_”结尾。

  • 如果 remember_data 标签为 True，则通过 update_data 将 X 中的值更新并写入 self._X。

参数：:
Xsktime 兼容数据容器格式的时间序列数据，用于拟合变换器。

用于更新转换的数据

sktime 中的个体数据格式称为 mtype 规范，每种 mtype 实现一个抽象 scitype。

  • Series scitype = 个体时间序列。pd.DataFrame, pd.Series, 或 np.ndarray (1D 或 2D)

  • Panel scitype = 时间序列集合。pd.DataFrame 具有 2 级行 MultiIndex (instance, time)，3D np.ndarray (instance, variable, time)，Series 类型的 pd.DataFrame list

  • Hierarchical scitype = 层级时间序列集合。pd.DataFrame 具有 3 级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)

关于数据格式的更多细节，请参阅关于 mtype 的词汇表。关于用法，请参阅变换器教程 examples/03_transformers.ipynb

y可选，sktime 兼容数据格式的数据，默认为 None

附加数据，例如用于转换的标签。某些转换器需要此数据，详情请参阅类文档字符串。

返回：:
self拟合后的评估器实例