SignatureTransformer

class SignatureTransformer(augmentation_list=('basepoint', 'addtime'), window_name='dyadic', window_depth=3, window_length=None, window_step=None, rescaling=None, sig_tfm='signature', depth=4, backend='esig')

签名方法的转换类。

遵循论文中提出的方法论

“多元时间序列的广义签名方法”

参数:

augmentation_list: 字符串列表或元组，可能的字符串包括

[‘leadlag’, ‘ir’, ‘addtime’, ‘cumsum’, ‘basepoint’] 在计算签名之前应用于数据的增强。增强的顺序是它们应用的顺序。默认值：(‘basepoint’, ‘addtime’)

window_name: 字符串，以下之一：``[‘global’, ‘sliding’, ‘expanding’, ‘dyadic’]``

默认值：‘dyadic’ 用于签名转换的窗口类型。

window_depth: 整数，默认值=3

分段窗口的深度。除非 window_name 为 'dyadic'，否则忽略。

window_length: None (默认值) 或 整数

滑动/扩展窗口的长度。（除非 window_name 为 ['sliding, 'expanding'] 之一，否则忽略。

window_step: None (默认值) 或 整数

滑动/扩展窗口的步长。除非 window_name 为 ['sliding, 'expanding'] 之一，否则忽略。

rescaling: None (默认值) 或 字符串，“pre” 或 “post”，

None: 不应用缩放。“pre”: 缩放路径，最后一个签名项应约为 O(1)。“post”: 通过将深度 d 的项乘以 d! 来缩放输出签名。

目的是使每一项都变为 ~O(1)。

sig_tfm: 字符串，以下之一：``[‘signature’, ‘logsignature’]``。默认值：``’signature’``

要使用的签名转换类型，普通签名或对数签名。

depth: 整数，默认值=4

签名截断深度。

backend: 字符串，以下之一：``’esig’`` (默认值)，或 ``’iisignature’``。

用于签名计算的后端。

属性:

signature_method: sklearn.Pipeline，一个 sklearn pipeline 对象，包含

提取签名特征的所有步骤。

方法

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)	将实例级别的标签覆盖设置为给定值。
setup_feature_pipeline()	将签名方法设置为 sklearn pipeline。
transform(X[, y])	转换 X 并返回转换后的版本。
update(X[, y, update_params])	用 X 更新转换器，可选地用 y。

setup_feature_pipeline()

将签名方法设置为 sklearn pipeline。

classmethod get_test_params(parameter_set='default')

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

参数:

parameter_set字符串, 默认值=”default”

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

返回:

params字典 或 字典列表, 默认值 = {}

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

check_is_fitted(method_name=None)

检查估计器是否已拟合。

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

如果不是，则引发 NotFittedError。

参数:

method_name字符串, 可选

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

引发:

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`BaseObject` 或派生类的实例

tag_names字符串或字符串列表，默认为 None

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

返回:

self

对 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。

状态变更

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

写入 self

• 设置以“_”结尾的已拟合模型属性，已拟合属性可通过 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 scitype = 个体时间序列。pd.DataFrame、pd.Series 或 np.ndarray（1D 或 2D）

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

• Hierarchical scitype = 分层时间序列集合。具有 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 的转换版本。

状态变更

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

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

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

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

参数:

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

用于拟合转换和要转换的数据。

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

• Series scitype = 个体时间序列。pd.DataFrame、pd.Series 或 np.ndarray（1D 或 2D）

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

• Hierarchical scitype = 分层时间序列集合。具有 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 实例）。示例：Panel 中的所有时间序列都被单独去趋势

• 如果 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任何类型

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

返回:

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 类属性收集，然后从 _config_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: dict[str, Any]

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

classmethod get_param_names(sort=True)

获取对象的参数名称。

参数:

sort布尔值，默认为 True

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

返回:

param_names: list[str]

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

get_params(deep=True)

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

参数:

deep布尔值，默认为 True

是否返回组件的参数。

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

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

返回:

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 scitype = 个体时间序列。pd.DataFrame、pd.Series 或 np.ndarray（1D 或 2D）

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

• Hierarchical scitype = 分层时间序列集合。具有 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)` 输出的第 1 个元素

返回:

反序列化后的 self，结果为 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))`` 后获得的对象相同。

返回:

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”，则会在当前工作目录 (cwd) 创建一个 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 时是仅列出与默认值不同的 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 在并行化后关闭。

    shutting down after parallelization.

  • “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>。如果引用明确（例如，没有两个组件参数具有名称 <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_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

控制随机整数生成的伪随机数生成器。传入整数可在多次函数调用中获得可复现的输出。

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 scitype = 个体时间序列。pd.DataFrame、pd.Series 或 np.ndarray（1D 或 2D）

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

• Hierarchical scitype = 分层时间序列集合。具有 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 实例）。示例：Panel 中的所有时间序列都被单独去趋势

• 如果 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 中的内容

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

• self.is_fitted，必须为 True

写入 self

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

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

参数:

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

用于更新转换的数据

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

• Series scitype = 个体时间序列。pd.DataFrame、pd.Series 或 np.ndarray（1D 或 2D）

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

• Hierarchical scitype = 分层时间序列集合。具有 3 级或更多级行 MultiIndex（hierarchy_1，...，hierarchy_n，time）的 pd.DataFrame

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

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

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

返回:

self拟合后的估计器实例