SignatureMoments

class SignatureMoments(degree=2, use_index=True, normalize_prod=False)

用于多元时间序列的签名矩变换器。

计算单变量和多元时间序列的时间有序签名矩。

流水线处理 Differencer() * SignatureMoments() 可用于获取离散路径签名。

对于阶数 d，transform 输出的列是对应于字母表 {[0], ..., [str(n_channels - 1)]} 上长度为 d 的字符串，其中 n_channels 是时间序列中的变量数量，字符 i 表示第 i 个变量。

如果 use_index=True，时间索引将作为附加维度包含在内，并由字符 [n_channels] 表示。

对于具有 n_channels 个变量的时间序列 \(X\)，字符串 \(s = i_1 i_2 ... i_d\) 的签名矩是乘积的算术平均值

\[X_{i_1}(t_1) X_{i_2}(t_2) ... X_{i_d}(t_d)\]

其中 \(t_1 < t_2 < ... < t_d\) 是时间索引。

如果 normalize_prod=True，签名矩将计算为几何平均值的算术平均值，即

\[(X_{i_1}(t_1) X_{i_2}(t_2) ... X_{i_d}(t_d))^{1/d}\]

这确保了所有签名矩与输入数据具有相同的单位。

参数:

degree: int, default=2

要包含的基于字符串的签名元素的最大长度。阶数最大为 3。

use_index: bool, default=True

是否将时间索引作为附加维度包含在内。

normalize_prod: bool, default=False

如果为 True，则使用几何平均值代替乘积来计算签名矩，公式见上文。如果为 False，则使用乘积。

属性:

is_fitted

是否已调用 fit。

示例

>>> from sktime.transformations.series.signature import SignatureMoments
>>> from sktime.datasets import load_airline
>>> y = load_airline()
>>> transformer = SignatureMoments(degree=2, use_index=True)
>>> Xt = transformer.fit_transform(y)

方法

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])	返回估计器的测试参数设置。
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）更新变换器。

classmethod get_test_params(parameter_set='default')

返回估计器的测试参数设置。

参数:

parameter_setstr, default=”default”

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

返回:

paramsdict 或 list of dict, default = {}

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

check_is_fitted(method_name=None)

检查估计器是否已拟合。

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

如果不是，则引发 NotFittedError。

参数:

method_namestr, optional

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

抛出:

NotFittedError

如果估计器尚未拟合。

clone()

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

克隆是一个没有共享引用、处于初始化后状态的不同对象。此函数等效于返回 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__ 导致克隆不合规，则会引发 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_namesstr 或 list of str, default = None

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

返回:

self

对 self 的引用。

classmethod create_test_instance(parameter_set='default')

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

参数:

parameter_setstr, default=”default”

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

返回:

instance使用默认参数的类实例

classmethod create_test_instances_and_names(parameter_set='default')

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

参数:

parameter_setstr, default=”default”

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

返回:

objslist of instances of cls

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

nameslist of str, 与 objs 等长

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

fit(X, y=None)

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

状态变化

将状态更改为“fitted”。

写入自身

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

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

• 如果self.get_tag("remember_data")为True，则将X记忆为self._X，并强制转换为self.get_tag("X_inner_mtype")指定的类型。

参数:

X`sktime`兼容数据容器格式的时间序列

用于拟合转换的数据。

`sktime`中的单个数据格式是所谓的mtype规范，每个mtype实现一个抽象的scitype。

• `Series`科学类型 = 单个时间序列。pd.DataFrame、pd.Series 或 np.ndarray (1D 或 2D)

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

• `Hierarchical`科学类型 = 分层时间序列集合。具有3层或更多层行MultiIndex (hierarchy_1, ..., hierarchy_n, time)的pd.DataFrame

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

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

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

返回:

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

fit_transform(X, y=None)

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

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

状态变化

将状态更改为“fitted”。

写入self：_is_fitted：标记设置为True。_X：X，X的强制复制，如果remember_data标记为True

如果可能，通过引用强制转换为内部类型或update_data兼容类型

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

参数:

X`sktime`兼容数据容器格式的时间序列

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

`sktime`中的单个数据格式是所谓的mtype规范，每个mtype实现一个抽象的scitype。

• `Series`科学类型 = 单个时间序列。pd.DataFrame、pd.Series 或 np.ndarray (1D 或 2D)

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

• `Hierarchical`科学类型 = 分层时间序列集合。具有3层或更多层行MultiIndex (hierarchy_1, ..., hierarchy_n, time)的pd.DataFrame

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

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

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

返回:

X的转换版本

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

| X | tf-output | 返回类型 |

| 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，则返回是pd.DataFrame，其行数与X中的实例数相同。示例：返回的第 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任意类型

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

返回:

tag_value

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。

collected_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属性中设置的标签，

按继承顺序。

返回:

collected_tags字典

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

inverse_transform(X, y=None)

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

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

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

具有inverse_transform方法。

所需状态

需要状态为“已拟合”。

在self中访问

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

• self.is_fitted，必须为True

参数:

X`sktime`兼容数据容器格式的时间序列

用于拟合转换的数据。

`sktime`中的单个数据格式是所谓的mtype规范，每个mtype实现一个抽象的scitype。

• `Series`科学类型 = 单个时间序列。pd.DataFrame、pd.Series 或 np.ndarray (1D 或 2D)

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

• `Hierarchical`科学类型 = 分层时间序列集合。具有3层或更多层行MultiIndex (hierarchy_1, ..., hierarchy_n, time)的pd.DataFrame

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

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

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

返回:

X的逆转换版本

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

is_composite()

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

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

返回:

composite: 布尔值

对象是否具有任何参数，其值是BaseObject的派生类实例。

property is_fitted

是否已调用 fit。

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

返回:

布尔值

估计器是否已fit。

classmethod load_from_path(serial)

从文件位置加载对象。

参数:

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

返回:

反序列化的self，结果输出到path，是cls.save(path)的输出

classmethod load_from_serial(serial)

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

参数:

serial`cls.save(None)`输出的第一个元素

返回:

反序列化的self，结果输出为serial，是cls.save(None)的输出

reset()

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

结果是将self设置为构造函数调用后直接所处的状态，具有相同的超参数。通过set_config设置的配置值也会被保留。

reset调用会删除所有对象属性，除了

• 超参数 = 写入到self的__init__参数，例如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')

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

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

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

参数:

pathNone 或 文件位置 (字符串或Path)

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

• path=”estimator”，则会在当前工作目录创建zip文件estimator.zip。

• path=”/home/stored/estimator”，则会在

存储在/home/stored/中，zip文件名为estimator.zip。

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

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

返回:

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

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

set_config(**config_dict)

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

参数:

config_dict字典

配置名称：配置值对的字典。下面列出了有效的配置、值及其含义

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)

设置此对象的参数。

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

参数:

**params字典

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

返回:

self对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对self的引用

set_tags(**tag_dict)

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

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

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

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

set_tags方法只能在对象的__init__方法中调用，即在构造期间，或在通过__init__构造后直接调用。

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

参数:

**tag_dict字典

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

返回:

Self

对self的引用。

transform(X, y=None)

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

所需状态

需要状态为“已拟合”。

在self中访问

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

• self.is_fitted，必须为True

参数:

X`sktime`兼容数据容器格式的时间序列

要转换的数据。

`sktime`中的单个数据格式是所谓的mtype规范，每个mtype实现一个抽象的scitype。

• `Series`科学类型 = 单个时间序列。pd.DataFrame、pd.Series 或 np.ndarray (1D 或 2D)

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

• `Hierarchical`科学类型 = 分层时间序列集合。具有3层或更多层行MultiIndex (hierarchy_1, ..., hierarchy_n, time)的pd.DataFrame

有关数据格式的更多详细信息，请参阅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，则返回是pd.DataFrame，其行数与X中的实例数相同。示例：返回的第 i 行包含第 i 个序列的均值和方差

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

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

update(X, y=None, update_params=True)

使用 X（可选使用 y）更新变换器。

所需状态

需要状态为“已拟合”。

在self中访问

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

• self.is_fitted，必须为True

写入自身

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

• 如果remember_data标记为True，则通过update_data将X中的值更新到self._X。

参数:

X`sktime`兼容数据容器格式的时间序列

用于更新转换的数据

`sktime`中的单个数据格式是所谓的mtype规范，每个mtype实现一个抽象的scitype。

• `Series`科学类型 = 单个时间序列。pd.DataFrame、pd.Series 或 np.ndarray (1D 或 2D)

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

• `Hierarchical`科学类型 = 分层时间序列集合。具有3层或更多层行MultiIndex (hierarchy_1, ..., hierarchy_n, time)的pd.DataFrame

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

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

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

返回:

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