WindowSegmenter

class WindowSegmenter(clusterer=None, window_size=1, overlap=False, step_size=1, return_segments=True)

基于窗口的时间序列聚类分割。

在此方法中，我们使用滑动窗口获取重叠和非重叠子序列。之后，我们运行自己选择的聚类算法来分割时间序列。

重叠片段的标签通过多数投票进行聚合，以获得最终标签。

参数：

clusterersktime 聚类器，BaseClusterer 实例

用于分割的聚类算法实例。

window_size整数

滑动窗口的大小

overlap布尔值，默认为 False

如果为 True，则使用重叠窗口。

step_size整数，默认为 1

滑动窗口的步长。

return_segments布尔值，默认为 True

如果为 True，则返回带标签的片段。如果为 False，则返回每个时间点的标签。

属性：

is_fitted

是否已调用 fit 方法。

方法

change_points_to_segments(y_sparse[, start, end])	将一系列变点索引转换为片段。
check_is_fitted([method_name])	检查估计器是否已拟合。
clone()	获取具有相同超参数和配置的对象的克隆。
clone_tags(estimator[, tag_names])	将其他对象的标签克隆为动态覆盖。
create_test_instance([parameter_set])	使用第一个测试参数集构造类的实例。
create_test_instances_and_names([parameter_set])	创建所有测试实例列表及其名称列表。
dense_to_sparse(y_dense)	将检测器的密集输出转换为稀疏格式。
fit(X[, y])	拟合训练数据。
fit_predict(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])	返回估计器的测试参数设置。
is_composite()	检查对象是否由其他 BaseObjects 组成。
load_from_path(serial)	从文件位置加载对象。
load_from_serial(serial)	从序列化内存容器加载对象。
predict(X)	在测试/部署数据上创建标签。
predict_points(X)	在测试/部署数据上预测变点/异常。
predict_scores(X)	返回测试/部署数据上预测标签的分数。
predict_segments(X)	在测试/部署数据上预测片段。
reset()	将对象重置到初始化后的干净状态。
save([path, serialization_format])	将序列化的自身保存到类字节对象或 (.zip) 文件。
segments_to_change_points(y_sparse)	将片段转换为变点。
set_config(**config_dict)	将配置标志设置为给定值。
set_params(**params)	设置此对象的参数。
set_random_state([random_state, deep, ...])	为自身设置 random_state 伪随机种子参数。
set_tags(**tag_dict)	将实例级别标签覆盖设置为给定值。
sparse_to_dense(y_sparse, index)	将检测器的稀疏输出转换为密集格式。
transform(X)	在测试/部署数据上创建标签。
transform_scores(X)	返回测试/部署数据上预测标签的分数。
update(X[, y])	使用新数据和可选的真实标签更新模型。
update_predict(X[, y])	使用新数据更新模型并为其创建标签。

static change_points_to_segments(y_sparse, start=None, end=None)

将一系列变点索引转换为片段。

参数：

y_sparsepd.Series (整数类型)，按升序排序

包含变点 iloc 索引的 series。

start可选，默认为 0

第一个片段的起始点。必须在第一个变点之前，即 < y_sparse[0]。

end可选，默认为 y_sparse[-1] + 1

最后一个片段的结束点。必须在最后一个变点之后，即 > y_sparse[-1]。

返回：

pd.Series

一个以区间索引表示片段起止点的 series。series 的值是片段的标签。

示例

>>> import pandas as pd
>>> from sktime.detection.base import BaseDetector
>>> change_points = pd.Series([1, 2, 5])
>>> BaseDetector.change_points_to_segments(change_points, 0, 7)
[0, 1)    0
[1, 2)    1
[2, 5)    2
[5, 7)    3
dtype: int64

check_is_fitted(method_name=None)

检查估计器是否已拟合。

检查估计器是否已拟合。is_fitted 属性应在调用对象的 fit 方法时设置为 True。

如果未拟合，则引发 NotFittedError 异常。

参数：

method_name字符串，可选

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

引发：

NotFittedError

如果估计器尚未拟合。

clone()

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

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

等同于构造一个新的 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 查看。

参数：

estimatorBaseObject 或派生类的实例

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

static dense_to_sparse(y_dense)

将检测器的密集输出转换为稀疏格式。

参数：

y_densepd.Series

• 如果 y_sparse 只包含 1 和 0，则 1 表示变点或异常。

• 如果 y_sparse 只包含大于 0 的整数，则它是一个片段数组。

返回：

pd.Series

• 如果 y_sparse 是一个变点/异常 series，将返回一个包含变点/异常索引的 pandas series。

• 如果 y_sparse 是一个片段 series，将返回一个具有区间数据类型索引的 series。series 的值将是片段的标签。

fit(X, y=None)

拟合训练数据。

参数：

Xpd.DataFrame, pd.Series 或 np.ndarray

用于拟合模型的训练数据（时间序列）。

y具有 RangeIndex 的 pd.DataFrame，可选。

训练中已知的事件，位于 X 中，如果检测器是监督的。

y 的每一行是一个已知事件。可以有以下列

• "ilocs" - 总是存在。值编码事件发生的地点/时间，通过对 X 索引的 iloc 引用，或 X 索引的范围，如下所示。

• "label" - 如果任务（通过标签）是带有标签的监督或半监督分割，或片段聚类。

"ilocs" 列和 "labels" 列中条目的含义描述了给定行中的事件，如下所示：

• 如果 task 是 "anomaly_detection" 或 "change_point_detection"，则 "ilocs" 包含事件发生的 iloc 索引。

• 如果 task 是 "segmentation"，则 "ilocs" 包含基于 iloc 的片段的左闭区间，解释为事件发生的索引范围。

"labels" 列中的标签（如果存在）表示事件的类型。

返回：

self

对自身的引用。

注意

创建拟合模型，更新以“_”结尾的属性。将 _is_fitted 标志设置为 True。

fit_predict(X, y=None)

拟合数据，然后进行预测。

使用给定的检测参数将模型拟合到 X 和 Y，并返回模型生成的检测标签。

参数：

Xpd.DataFrame, pd.Series 或 np.ndarray

待变换的数据

y具有 RangeIndex 的 pd.DataFrame，可选。

训练中已知的事件，位于 X 中，如果检测器是监督的。

y 的每一行是一个已知事件。可以有以下列

• "ilocs" - 总是存在。值编码事件发生的地点/时间，通过对 X 索引的 iloc 引用，或 X 索引的范围，如下所示。

• "label" - 如果任务（通过标签）是带有标签的监督或半监督分割，或片段聚类。

"ilocs" 列和 "labels" 列中条目的含义描述了给定行中的事件，如下所示：

• 如果 task 是 "anomaly_detection" 或 "change_point_detection"，则 "ilocs" 包含事件发生的 iloc 索引。

• 如果 task 是 "segmentation"，则 "ilocs" 包含基于 iloc 的片段的左闭区间，解释为事件发生的索引范围。

"labels" 列中的标签（如果存在）表示事件的类型。

返回：

y具有 RangeIndex 的 pd.DataFrame

检测到或预测的事件。

y 的每一行是一个检测到或预测的事件。可以有以下列

• "ilocs" - 总是存在。值编码事件发生的地点/时间，通过对 X 索引的 iloc 引用，或 X 索引的范围，如下所示。

• "label" - 如果任务（通过标签）是带有标签的监督或半监督分割，或片段聚类。

"ilocs" 列和 "labels" 列中条目的含义描述了给定行中的事件，如下所示：

• 如果 task 是 "anomaly_detection" 或 "change_point_detection"，则 "ilocs" 包含事件发生的 iloc 索引。

• 如果 task 是 "segmentation"，则 "ilocs" 包含基于 iloc 的片段的左闭区间，解释为事件发生的索引范围。

"labels" 列中的标签（如果存在）表示事件的类型。

fit_transform(X, y=None)

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

使用给定的检测参数将模型拟合到 X 和 Y，并返回模型生成的检测标签。

参数：

Xpd.DataFrame, pd.Series 或 np.ndarray

待变换的数据

ypd.Series 或 np.ndarray，可选（默认为 None）

待预测数据的目标值。

返回：

y与 X 具有相同索引的 pd.DataFrame

序列 X 的标签。

• 如果 task 是 "anomaly_detection"，则值为整数标签。值为 0 表示 X 在同一时间索引处没有异常。其他值表示异常。大多数检测器将返回 0 或 1，但如果它们可以检测不同类型的异常，则可能会返回更多值。指示 X 在同一索引处是否为异常，0 表示否，1 表示是。

• 如果 task 是 "changepoint_detection"，则值为整数标签，表示变点之间的片段标签。可能的标签是从 0 开始的整数。

• 如果 task 是“segmentation”，则值为片段的整数标签。可能的标签是从 0 开始的整数。

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: 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 对象属性中的任何覆盖和新标签。

classmethod get_test_params(parameter_set='default')

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

参数：

parameter_set字符串，默认为“default”

要返回的测试参数集的名称，用于测试。如果某个值没有定义特殊参数，则将返回“default”集。目前没有为注解器保留的值。

返回：

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

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)

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

参数：

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

返回：

反序列化 self，结果为输出 serial，由 cls.save(None) 生成

predict(X)

在测试/部署数据上创建标签。

此方法返回特定于检测任务的类似列表的类型，例如，分割任务的片段，异常检测任务的异常。

编码因 task 和 learning_type（标签）而异，详见下文。

要获取在不同任务中类型一致的返回值，请参见 predict_points 和 predict_segments。

参数：

Xpd.DataFrame, pd.Series 或 np.ndarray

进行检测的时间序列，将被分配标签或分数。

返回：

y具有 RangeIndex 的 pd.DataFrame

检测到或预测的事件。

y 的每一行是一个检测到或预测的事件。可以有以下列

• "ilocs" - 总是存在。值编码事件发生的地点/时间，通过对 X 索引的 iloc 引用，或 X 索引的范围，如下所示。

• "label" - 如果任务（通过标签）是带有标签的监督或半监督分割，或片段聚类。

"ilocs" 列和 "labels" 列中条目的含义描述了给定行中的事件，如下所示：

• 如果 task 是 "anomaly_detection" 或 "change_point_detection"，则 "ilocs" 包含事件发生的 iloc 索引。

• 如果 task 是 "segmentation"，则 "ilocs" 包含基于 iloc 的片段的左闭区间，解释为事件发生的索引范围。

"labels" 列中的标签（如果存在）表示事件的类型。

predict_points(X)

在测试/部署数据上预测变点/异常。

与 predict 的主要区别在于，即使任务不是异常或变点检测，此方法始终返回一个包含兴趣点的 pd.DataFrame。

参数：

Xpd.DataFrame

进行检测的时间序列，将被分配标签或分数。

返回：

y具有 RangeIndex 的 pd.DataFrame

包含以下列的 pd.DataFrame

• "ilocs" - 总是存在。值为整数，是对 X 索引的 iloc 引用，表示兴趣点。

• "labels" - 如果任务（通过标签）是监督或半监督分割，或异常聚类。

"ilocs" 列和 "labels" 列中片段的含义如下：

• 如果 task 是 "anomaly_detection" 或 "change_point_detection"，则值为变点/异常的整数索引。

• 如果 task 是 "segmentation"，则值为连续的片段边界。

"labels" 是兴趣点的潜在标签。

predict_scores(X)

返回测试/部署数据上预测标签的分数。

参数：

Xpd.DataFrame, pd.Series 或 np.ndarray

待标记的数据（时间序列）。

返回：

scores与 predict 返回值具有相同索引的 pd.DataFrame

序列 X 预测的分数。

predict_segments(X)

在测试/部署数据上预测片段。

与 predict 的主要区别在于，即使任务不是分割，此方法始终返回一个包含兴趣片段的 pd.DataFrame。

参数：

Xpd.DataFrame

进行检测的时间序列，将被分配标签或分数。

返回：

y具有 RangeIndex 的 pd.DataFrame

包含以下列的 pd.DataFrame

• "ilocs" - 总是存在。值为左闭区间，其左/右值为对 X 索引的 iloc 引用，表示片段。

• "labels" - 如果任务（通过标签）是监督或半监督分割，或片段聚类。

"ilocs" 列和 "labels" 列中片段的含义如下：

• 如果 task 是 "anomaly_detection" 或 "change_point_detection"，则区间是变点/异常之间的区间，潜在标签是从 0 开始的连续整数。

• 如果 task 是 "segmentation"，则值为分割标签。

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 或文件位置 (str 或 Path)

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

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

• path=”/home/stored/estimator”，则会创建一个名为 `estimator.zip` 的 zip 文件，并

存储在 `/home/stored/` 中。

serialization_format: str，默认值 = “pickle”

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

返回：

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

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

static segments_to_change_points(y_sparse)

将片段转换为变点。

参数：

y_sparsepd.DataFrame

一系列的段。索引必须是区间数据类型，值应为段的整数标签。

返回：

pd.Index

一个 Index 数组，包含每个段起始点的索引。

示例

>>> import pandas as pd
>>> from sktime.detection.base import BaseDetector
>>> segments =  pd.DataFrame({
        "ilocs": pd.IntervalIndex.from_tuples([(0, 3), (3, 4), (4, 5),
        (5, 6), (6, 7), (7, 8), (8, 10), (10, 11), (11, 12), (12, 20)]),
        "labels": [0, 2, 1, 0, 2, 1, 0, 2, 1, 0]
    })
>>> BaseDetector.segments_to_change_points(segments)
Index([0, 3, 4, 5, 6, 7, 8, 10, 11, 12], dtype='int64')

set_config(**config_dict)

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

参数：

config_dict字典

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

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

jupyter 内核如何显示 self 的实例

• “diagram” = html 框图表示

• “text” = 字符串输出

print_changed_onlybool，默认值=True

打印 self 时，是只列出与默认值不同的 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，则抑制警告

返回：

self指向 self 的引用。

注意

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

set_params(**params)

设置此对象的参数。

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

参数：

**paramsdict

BaseObject 参数，键必须是 `__` 字符串。如果 `__` 后缀在 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` 时，也应用于剩余组件对象中的 `random_state` 参数。

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

参数：

random_stateint, RandomState 实例或 None，默认值=None

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

deep布尔值，默认为 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_dictdict

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

返回：

Self

对自身的引用。

static sparse_to_dense(y_sparse, index)

将检测器的稀疏输出转换为密集格式。

参数：

y_sparsepd.Series

• 如果 `y_sparse` 是一个索引为区间的 Series，它应表示段，其中 Series 的每个值是段的标签。未分类的区间应标记为 -1。段的标签绝不能为 0。

• 如果 `y_sparse` 的索引不是一组区间，Series 的值应表示变化点/异常的索引。

indexarray-like

包含 `y_sparse` 中事件索引的较大索引集，用作返回 Series 的索引。

返回：

pd.Series

返回一个索引为 `index` 的 Series。* 如果 `y_sparse` 是一个变化点/异常的 Series，则返回的

Series 根据索引是否与异常/变化点相关联而被标记为 0 和 1。其中 1 表示异常/变化点。

• 如果 `y_sparse` 是一个段的 Series，则返回的 Series 根据其索引落入的段进行标记。未落入任何段的索引标记为 -1。

示例

>>> import pandas as pd
>>> from sktime.detection.base import BaseDetector
>>> y_sparse = pd.Series([2, 5, 7])  # Indices of changepoints/anomalies
>>> index = range(0, 8)
>>> BaseDetector.sparse_to_dense(y_sparse, index=index)
0    0
1    0
2    1
3    0
4    0
5    1
6    0
7    1
dtype: int64
>>> y_sparse = pd.Series(
...     [1, 2, 1],
...     index=pd.IntervalIndex.from_arrays(
...         [0, 4, 6], [4, 6, 10], closed="left"
...     )
... )
>>> index = range(10)
>>> BaseDetector.sparse_to_dense(y_sparse, index=index)
0    1
1    1
2    1
3    1
4    2
5    2
6    1
7    1
8    1
9    1
dtype: int64

transform(X)

在测试/部署数据上创建标签。

参数：

Xpd.DataFrame, pd.Series 或 np.ndarray

进行检测的时间序列，将被分配标签或分数。

返回：

y与 X 具有相同索引的 pd.DataFrame

序列 X 的标签。

• 用于转换的数据 (时间序列)。如果 `task` 是 "anomaly_detection"，值是整数标签。值为 0 表示 `X` 在同一时间索引处没有异常。其他值表示异常。大多数检测器会返回 0 或 1，但有些如果能检测到不同类型的异常，可能会返回更多值。指示 `X` 在同一索引处是否为异常，0 表示否，1 表示是。

• 如果 task 是 "changepoint_detection"，则值为整数标签，表示变点之间的片段标签。可能的标签是从 0 开始的整数。

• 如果 task 是“segmentation”，则值为片段的整数标签。可能的标签是从 0 开始的整数。

transform_scores(X)

返回测试/部署数据上预测标签的分数。

参数：

Xpd.DataFrame, pd.Series 或 np.ndarray

待标记的数据（时间序列）。

返回：

序列 `X` 的得分。

scorespd.DataFrame，索引与 X 相同

update(X, y=None)

使用新数据和可选的真实标签更新模型。

参数：

Xpd.DataFrame, pd.Series 或 np.ndarray

用于更新模型的训练数据（时间序列）。

ypd.Series，可选

如果检测器是监督式的，则这是用于训练的真实标签。

返回：

self

对自身的引用。

注意

更新已拟合的模型，该模型会更新以“_”结尾的属性。

update_predict(X, y=None)

使用新数据更新模型并为其创建标签。

参数：

Xpd.DataFrame, pd.Series 或 np.ndarray

用于更新模型和进行预测的训练数据（时间序列）。

y具有 RangeIndex 的 pd.DataFrame，可选。

训练中已知的事件，位于 X 中，如果检测器是监督的。

y 的每一行是一个已知事件。可以有以下列

• "ilocs" - 总是存在。值编码事件发生的地点/时间，通过对 X 索引的 iloc 引用，或 X 索引的范围，如下所示。

• "label" - 如果任务（通过标签）是带有标签的监督或半监督分割，或片段聚类。

"ilocs" 列和 "labels" 列中条目的含义描述了给定行中的事件，如下所示：

• 如果 task 是 "anomaly_detection" 或 "change_point_detection"，则 "ilocs" 包含事件发生的 iloc 索引。

• 如果 task 是 "segmentation"，则 "ilocs" 包含基于 iloc 的片段的左闭区间，解释为事件发生的索引范围。

"labels" 列中的标签（如果存在）表示事件的类型。

返回：

y具有 RangeIndex 的 pd.DataFrame

检测到或预测的事件。

y 的每一行是一个检测到或预测的事件。可以有以下列

• "ilocs" - 总是存在。值编码事件发生的地点/时间，通过对 X 索引的 iloc 引用，或 X 索引的范围，如下所示。

• "label" - 如果根据标签，任务是监督式或半监督式分割，或段聚类。

"ilocs" 列和 "labels" 列中条目的含义描述了给定行中的事件，如下所示：

• 如果 task 是 "anomaly_detection" 或 "change_point_detection"，则 "ilocs" 包含事件发生的 iloc 索引。

• 如果 task 是 "segmentation"，则 "ilocs" 包含基于 iloc 的片段的左闭区间，解释为事件发生的索引范围。

"labels" 列中的标签（如果存在）表示事件的类型。