ShapeletTransformPyts

类 ShapeletTransformPyts(n_shapelets='auto', criterion='mutual_info', window_sizes='auto', window_steps=None, remove_similar=True, sort=False, verbose=0, random_state=None, n_jobs=None)

Shapelet 变换，来自 pyts 库。

直接接口到 pyts.transformation.ShapeletTransform。

Shapelet 变换算法从时间序列数据集中提取 shapelets，并返回 shapelets 与时间序列之间的距离。Shapelet 被定义为时间序列的子集，即连续时间点的一组值。一个 shapelet 与时间序列之间的距离定义为该 shapelet 与从该时间序列中提取的所有相同长度的 shapelets 之间距离的最小值。选择最具判别力的 shapelets。提供了两种判别标准：互信息和 F 分数。

参数：

n_shapeletsint 或 ‘auto’（默认 = ‘auto’）

要保留的 shapelets 数量。如果设置为 ‘auto’，则考虑 n_timestamps // 2 个 shapelets，其中 n_timestamps 是数据集中的时间点数量。请注意，如果在搜索过程中提取的 shapelets 少于 n_shapelets，则 shapelets 数量可能会更少。

criterion‘mutual_info’ 或 ‘anova’（默认 = ‘mutual_info’）

用于执行 shapelets 选择的标准。‘mutual_info’ 使用互信息，而 ‘anova’ 使用 ANOVA F 值。

window_sizesarray-like 或 ‘auto’（默认 = ‘auto’）

滑动窗口的大小。如果设置为 ‘auto’，则窗口大小的范围会自动确定。否则，所有元素必须是整数或浮点数。在后一种情况下，每个元素代表每个时间序列大小的百分比，并且必须介于 0 和 1 之间；滑动窗口的大小将计算为 np.ceil(window_sizes * n_timestamps)。

window_stepsNone 或 array-like（默认 = None）

滑动窗口的步长。如果为 None，则每个 window_step 都等于 1。否则，所有元素必须是整数或浮点数。在后一种情况下，每个元素代表每个时间序列大小的百分比，并且必须介于 0 和 1 之间；滑动窗口的步长将计算为 np.ceil(window_steps * n_timestamps)。如果 window_sizes='auto'，则必须为 None。

remove_similarbool（默认 = True）

如果为 True，则移除自相似的 shapelets，仅保留得分最高的非自相似 shapelets。如果两个 shapelets 来自同一时间序列且至少有一个重叠索引，则认为它们是自相似的。

sortbool（默认 = False）

如果为 True，则 shapelets 根据其相关得分按降序排序。如果为 False，则顺序未定义。

verboseint（默认 = 0）

拟合时的详细程度：如果非零，则打印进度消息。高于 50 时，输出发送到标准输出。消息频率随详细程度的增加而增加。

random_stateint, RandomState 实例 或 None（默认 = None）

如果为 int，则 random_state 是随机数生成器使用的种子；如果为 RandomState 实例，则 random_state 是随机数生成器；如果为 None，则随机数生成器是 np.random 使用的 RandomState 实例。仅当 window_sizes='auto' 时用于对数据集进行子采样以找到最佳范围，或者当 criterion=='mutual_info' 时用于向数据添加少量噪声。

n_jobsNone 或 int（默认 = None）

为 fit 并行运行的任务数量。如果为 -1，则任务数量设置为核心数量。

属性：

shapelets_数组，形状 = (n_shapelets,)

包含所选 shapelets 的数组。

indices_数组，形状 = (n_shapelets, 3)

训练集中对应 shapelets 的索引。第一列包含样本的索引。第二列包含 shapelets 的起始索引（包含）。第三列包含 shapelets 的结束索引（不包含）。

scores_数组，形状 = (n_shapelets,)

与 shapelets 相关的得分。得分越高，判别力越强。如果 criterion='mutual_info'，则报告互信息得分。如果 criterion='anova'，则报告 F 分数。

window_range_None 或 元组

如果 window_sizes='auto'，则为窗口大小的范围。否则为 None。

参考文献

[1]

J. Lines, L. M. Davis, J. Hills and A. Bagnall, “A Shapelet Transform for Time Series Classification”. Data Mining and Knowledge Discovery, 289-297 (2012)。

示例

>>> from sktime.transformations.panel.shapelet_transform import (
...     ShapeletTransformPyts
... )
>>> from sktime.datasets import load_unit_test
>>> X_train, y_train = load_unit_test(split="train") 
>>> stp = ShapeletTransformPyts() 
>>> stp.fit(X_train,y_train) 
>>> stp.transform(X_train) 

方法

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()	检查对象是否由其他 BaseObject 组成。
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。

类方法 get_test_params(parameter_set='default')

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

参数：

parameter_setstr，默认值=”default”

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

返回：

paramsdict 或 list of dict，默认值 = {}

用于创建类的测试实例的参数。每个 dict 都是构造一个“有趣”测试实例的参数，即 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，可选

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

引发：

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，默认值 = None

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

返回：

self

对 self 的引用。

类方法 create_test_instance(parameter_set='default')

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

参数：

parameter_setstr，默认值=”default”

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

返回：

instance具有默认参数的类实例

类方法 create_test_instances_and_names(parameter_set='default')

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

参数：

parameter_setstr，默认值=”default”

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

返回：

objscls 实例列表

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

namesstr 列表，与 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")。

参数：

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)

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

将变换器拟合到 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 | 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 个窗口。

类方法 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_namestr

标签值的名称。

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

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

返回：

tag_value

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

类方法 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)

获取已拟合的参数。

所需状态

需要状态为“已拟合”。

参数：

deepbool，默认值=True

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

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

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

返回：

fitted_paramsstr 值键的字典

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

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

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

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

类方法 get_param_defaults()

获取对象的参数默认值。

返回：

default_dict: dict[str, Any]

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

类方法 get_param_names(sort=True)

获取对象的参数名称。

参数：

sortbool，默认值=True

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

返回：

param_names: list[str]

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

get_params(deep=True)

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

参数：

deepbool，默认值=True

是否返回组件的参数。

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

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

返回：

paramsstr 值键的字典

参数字典，包含 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_namestr

要检索的标签名称

tag_value_default任意类型，可选；默认值=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()

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

每个兼容 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。

参数：

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()

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

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

返回：

composite: bool

对象是否有任何参数，其值是 BaseObject 的子孙实例。

属性 is_fitted

是否已调用 fit 方法。

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

返回：

bool

评估器是否已 fit。

classmethod load_from_path(serial)

从文件位置加载对象。

参数：

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

返回：

反序列化 self，其结果为 path 处的输出，由 cls.save(path) 生成

classmethod load_from_serial(serial)

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

参数：

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

返回：

反序列化 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

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

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

将序列化的对象保存到类字节对象或 (.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: str, 默认值 = “pickle”

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

返回：

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

如果 path 是文件位置 - 引用该文件的 ZipFile 对象

set_config(**config_dict)

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

参数：

config_dict字典

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

displaystr，“diagram”（默认）或“text”

jupyter kernel 如何显示 self 的实例

• “diagram” = HTML 框图表示

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

print_changed_onlybool，默认值为 True

打印 self 时，是只列出与默认值不同的参数 (True)，还是列出所有参数名称和值 (False)。不进行嵌套，即仅影响 self，不影响组件评估器。

warningsstr，“on”（默认）或“off”

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

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

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

backend:parallelstr，可选，默认值为“None”

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

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

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

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

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

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

backend:parallel:paramsdict，可选，默认值为 {}（不传递参数）

作为配置传递给并行化后端的附加参数。有效键取决于 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”：bool，默认值为 True；False 防止 ray 在

    并行化后关闭。

  • “logger_name”：str，默认值为“ray”；要使用的日志记录器名称。

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

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

控制 _fit、_transform、_inverse_transform、_update 的输入检查和转换

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

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

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

output_conversionstr，“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> 名称），也可以直接使用字符串 <parameter>，不带 <component>__ 前缀。

参数：

**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_stateint、RandomState 实例或 None，默认值为 None

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

deepbool，默认值=True

是否在 skbase 对象值的参数中设置随机状态，即组件评估器。

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

• 如果为 True，则也会在组件对象中设置 random_state 参数。

self_policystr，{“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。

参数：

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 标签。

	输入 X 的转换输出格式
输入 X	-输出	返回值类型
Series	原始类型	pd.DataFrame (1行)
Panel	原始类型	pd.DataFrame
Series	Series	Series
Panel	Series	Panel
Series	Panel	Panel

| 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 中的值更新。

参数：

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评估器的已拟合实例