MatrixProfileTransformer

class MatrixProfileTransformer(window_length=3)

计算时间序列的矩阵剖面。

将单个时间序列数据集作为输入，并返回该时间序列数据集的矩阵剖面。矩阵剖面是一个向量，它存储时间序列中任何子序列与其最近邻之间的 z 标准化欧几里得距离。

有关矩阵剖面的更多信息，请参阅 stumpy 的教程

参数：

window_length整数

属性：

is_fitted

是否已调用 fit 方法。

注意

提供了 stumpy.stump 功能的包装器

示例

>>> from sktime.transformations.series.matrix_profile import     MatrixProfileTransformer
>>> from sktime.datasets import load_airline
>>> y = load_airline()
>>> transformer = MatrixProfileTransformer()  
>>> y_hat = transformer.fit_transform(y)  

方法

check_is_fitted([方法名称])	检查估计器是否已拟合。
clone()	获取具有相同超参数和配置的对象的克隆。
clone_tags(估计器[, tag_names])	从另一个对象克隆标签作为动态覆盖。
create_test_instance([参数集])	使用第一个测试参数集构造类的一个实例。
create_test_instances_and_names([参数集])	创建所有测试实例列表及其名称列表。
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([参数集])	返回 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)

检查估计器是否已拟合。

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

如果不是，则引发 NotFittedError。

参数：

method_name字符串，可选

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

引发：

NotFittedError

如果估计器尚未拟合。

clone()

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

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

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

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

在值上也等同于调用 self.reset，不同之处在于 clone 返回一个新对象，而不是像 reset 那样修改 self。

引发：

如果克隆不符合要求（由于 __init__ 故障），则引发 RuntimeError。

clone_tags(estimator, tag_names=None)

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

每个兼容 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_names字符串或字符串列表，默认为 None

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

返回：

自身

对 self 的引用。

classmethod create_test_instance(parameter_set='default')#

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

参数：

parameter_set字符串，默认为“default”

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

返回：

instance具有默认参数的类实例

classmethod create_test_instances_and_names(parameter_set='default')#

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

参数：

parameter_set字符串，默认为“default”

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

返回：

objscls 实例列表

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

names字符串列表，长度与 objs 相同

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

fit(X, y=None)#

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

状态变化

将状态更改为“已拟合”。

写入自身

• 设置以“_”结尾的拟合模型属性，拟合属性可通过 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 (实例, 时间), 3D np.ndarray (实例, 变量, 时间), list 形式的 Series 类型 pd.DataFrame

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

有关数据格式的更多详细信息，请参阅 mtype 的术语表。有关用法，请参阅转换器教程 examples/03_transformers.ipynb

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

附加数据，例如用于转换的标签。如果 self.get_tag("requires_y") 为 True，则必须在 fit 中传递，不是可选的。有关所需格式，请参阅类文档字符串了解详细信息。

返回：

self估计器的一个已拟合实例

fit_transform(X, y=None)#

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

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

状态变化

将状态更改为“已拟合”。

写入自身：_is_fitted : 标志设置为 True。_X : 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 (实例, 时间), 3D np.ndarray (实例, 变量, 时间), list 形式的 Series 类型 pd.DataFrame

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

有关数据格式的更多详细信息，请参阅 mtype 的术语表。有关用法，请参阅转换器教程 examples/03_transformers.ipynb

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

附加数据，例如用于转换的标签。如果 self.get_tag("requires_y") 为 True，则必须在 fit 中传递，不是可选的。有关所需格式，请参阅类文档字符串了解详细信息。

返回：

X 的转换版本

类型取决于 X 的类型和 scitype:transform-output 标签

X | tf-输出 | 返回类型 |

|----------|————–|------------------------| | Series | Primitives | pd.DataFrame (1-row) | | 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)#

从类获取类标签值，考虑从父类继承的标签层级。

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

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

它从对象返回名称为 tag_name 的标签值，考虑标签覆盖，优先级从高到低如下：

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

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

按继承顺序。

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

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

参数：

tag_name字符串

标签值的名称。

tag_value_default任意类型

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

返回：

标签值

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

classmethod get_class_tags()#

从类获取类标签，考虑从父类继承的标签层级。

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

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

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

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

值是相应的标签值，覆盖顺序如下，优先级从高到低：

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

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

按继承顺序。

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

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

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

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

收集的标签字典

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

get_config()#

获取自身的配置标志。

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

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

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

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

返回：

config_dict字典

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

get_fitted_params(deep=True)#

获取拟合参数。

所需状态

要求状态为“已拟合”。

参数：

deep布尔值，默认为 True

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

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

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

返回：

fitted_params键为字符串的字典

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

• 总是：此对象的所有拟合参数，通过 get_param_names 获取，值是此对象该键的拟合参数值

• 如果 deep=True，也包含组件参数的键/值对，组件参数索引为 [componentname]__[paramname]，componentname 的所有参数以其值显示为 paramname

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

classmethod get_param_defaults()#

获取对象的参数默认值。

返回：

default_dict: 字典[字符串, 任意类型]

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

classmethod get_param_names(sort=True)#

获取对象的参数名称。

参数：

sort布尔值，默认为 True

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

返回：

param_names: 字符串列表

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

get_params(deep=True)#

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

参数：

deep布尔值，默认为 True

是否返回组件的参数。

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

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

返回：

params键为字符串的字典

参数字典，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)#

从实例获取标签值，考虑标签层级继承和覆盖。

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

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

get_tag 方法从实例检索名称为 tag_name 的单个标签值，考虑标签覆盖，优先级从高到低如下：

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

在实例构造时。

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

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

按继承顺序。

参数：

tag_name字符串

要检索的标签名称

tag_value_default任意类型，可选；默认为 None

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

raise_error布尔值

未找到标签时是否引发 ValueError

返回：

tag_value任意类型

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

引发：

ValueError，如果 raise_error 为 True。

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

get_tags()#

从实例获取标签，考虑标签层级继承和覆盖。

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

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

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

值是相应的标签值，覆盖顺序如下，优先级从高到低：

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

在实例构造时。

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

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

按继承顺序。

返回：

收集的标签字典

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

classmethod get_test_params(parameter_set='default')#

返回 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) 应是有效的。

get_test_params 不必返回固定列表的字典，它也可以返回动态或随机的参数设置。

参数：

parameter_set字符串，默认为“default”

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

返回：

params字典或字典列表，默认为 {}

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

inverse_transform(X, y=None)#

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

目前假定只有带有标签的转换器

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

具有 inverse_transform 方法。

所需状态

要求状态为“已拟合”。

访问自身属性

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

• 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 (实例, 时间), 3D np.ndarray (实例, 变量, 时间), list 形式的 Series 类型 pd.DataFrame

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

有关数据格式的更多详细信息，请参阅 mtype 的术语表。有关用法，请参阅转换器教程 examples/03_transformers.ipynb

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

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

返回：

X 的逆转换版本

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

is_composite()#

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

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

返回：

组合布尔值

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

property is_fitted#

是否已调用 fit 方法。

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

返回：

布尔值

估计器是否已 fit。

classmethod load_from_path(serial)#

从文件位置加载对象。

参数：

serialZipFile(path).open(“object) 的结果

返回：

反序列化的自身，其输出位于 path，来自 cls.save(path)

classmethod load_from_serial(serial)#

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

参数：

serialcls.save(None) 输出的第一个元素

返回：

反序列化的自身，其输出为 serial，来自 cls.save(None)

reset()#

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

结果是将 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))`` 后获得的对象相等。

返回：

自身

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

save(path=None, serialization_format='pickle')#

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

行为：如果 path 为 None，则返回内存中的序列化自身；如果 path 是文件位置，则将自身以 zip 文件形式存储在该位置

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

参数：

pathNone 或文件位置（字符串或 Path 对象）

如果为 None，自身保存到内存对象；如果是文件位置，自身保存到该文件位置。例如，如果

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

• path=”/home/stored/estimator” 则将创建一个 zip 文件 estimator.zip，该文件将

存储在 /home/stored/ 中。

serialization_format: 字符串，默认为“pickle”

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

返回：

如果 path 为 None - 内存中的序列化自身

如果 path 是文件位置 - 指向文件的 ZipFile

set_config(**config_dict)#

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

参数：

config_dict字典

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

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

jupyter 内核如何显示自身的实例

• “diagram” = html 框图表示

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

print_changed_only布尔值，默认为 True

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

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对自身的引用。

注意

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

set_params(**params)

设置此对象的参数。

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

参数：

**params字典

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

返回：

self对自身的引用（设置参数后）

set_random_state(random_state=None, deep=True, self_policy='copy')

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

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

适用于 self 中的 random_state 参数（取决于 self_policy）以及仅当 deep=True 时才适用于其余组件对象。

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

参数：

random_state整数，RandomState 实例或 None，默认为 None

用于控制随机整数生成的伪随机数生成器。传递整数可确保跨多个函数调用的可重现输出。

deep布尔值，默认为 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对自身的引用

set_tags(**tag_dict)

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

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

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

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

set_tags 方法只能在对象的 __init__ 方法中、构建期间或通过 __init__ 构建后立即调用。

可以通过 get_tags 或 get_tag 查看当前标签值。

参数：

**tag_dict字典

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

返回：

自身

对自身的引用。

transform(X, y=None)

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

所需状态

要求状态为“已拟合”。

访问自身属性

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

• 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 (实例, 时间), 3D np.ndarray (实例, 变量, 时间), list 形式的 Series 类型 pd.DataFrame

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

有关数据格式的更多详细信息，请参阅 mtype 的术语表。有关用法，请参阅转换器教程 examples/03_transformers.ipynb

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

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

返回：

X 的转换版本

类型取决于 X 的类型和 scitype:transform-output 标签

	转换
X	-输出	返回类型
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)

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

所需状态

要求状态为“已拟合”。

访问自身属性

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

• self.is_fitted，必须为 True

写入自身

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

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

参数：

Xsktime 兼容数据容器格式的时间序列

用于更新转换的数据

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

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

• Panel scitype = 时间序列集合。pd.DataFrame 具有 2 级行 MultiIndex (实例, 时间), 3D np.ndarray (实例, 变量, 时间), list 形式的 Series 类型 pd.DataFrame

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

有关数据格式的更多详细信息，请参阅 mtype 的术语表。有关用法，请参阅转换器教程 examples/03_transformers.ipynb

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

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

返回：

self估计器的一个已拟合实例