MovingWindow

class MovingWindow(change_score=None, bandwidth: int = 30, threshold_scale=2.0, level: float = 0.01, min_detection_interval: int = 1)

来自 skchange 的用于多变点检测的滑动窗口算法。

重定向到 skchange.change_detectors.moving_window。

MOSUM (移动和) 算法 [1] 的通用版本，用于变点检测。它在数据上以长度为 2 * bandwidth 的滑动窗口，在窗口中点运行单变点检验统计量。使用 numba 高效实现。

参数:

change_scoreBaseChangeScore 或 BaseCost，可选（默认为 ``L2Cost``）

算法中使用的变点得分。如果提供了成本函数，则使用 ChangeScore 类将其转换为变点得分。

bandwidthint，默认值=30

带宽是候选变点两侧的样本数量。最小带宽取决于检验统计量。对于 "mean"，最小带宽为 1。

threshold_scalefloat，默认值=2.0

阈值的缩放因子。阈值设置为 threshold_scale * default_threshold，其中默认阈值取决于样本数量、变量数量、bandwidth 和 level。如果为 None，则在 fit 时根据输入数据调整阈值。

levelfloat，默认值=0.01

如果 threshold_scale 为 None，则阈值设置为训练数据上变点得分的 (1-level) 分位数。为了使其正确，训练数据必须不包含变点。如果 threshold_scale 是一个数字，则 level 用于默认阈值，在缩放_之前_。

min_detection_intervalint，默认值=1

连续得分高于阈值被视为变点的最小数量。必须在 1 到 bandwidth/2 之间。

属性:

is_fitted

是否已调用 fit。

参考文献

[1]

Eichinger, B., & Kirch, C. (2018). A MOSUM procedure for the estimation of

multiple random change points.

示例

>>> from skchange.change_detectors import MovingWindow
>>> from skchange.datasets.generate import generate_alternating_data
>>> df = generate_alternating_data(
        n_segments=4, mean=10, segment_length=100, p=5
    )
>>> detector = MovingWindow()
>>> detector.fit_predict(df)
0    100
1    200
2    300
Name: changepoint, dtype: int64

方法

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])	返回 skbase 对象的测试参数设置。
is_composite()	检查对象是否由其他 BaseObject 组成。
load_from_path(serial)	从文件位置加载对象。
load_from_serial(serial)	从序列化内存容器加载对象。
predict(X)	在测试/部署数据上创建标签。
predict_points(X)	预测测试/部署数据上的变点/异常。
predict_scores(X)	返回测试/部署数据上预测标签的得分。
predict_segments(X)	预测测试/部署数据上的分段。
reset()	将对象重置为初始状态后的干净状态。
save([path, serialization_format])	将序列化的 self 保存为类似字节的对象或 (.zip) 文件。
segments_to_change_points(y_sparse)	将分段转换为变点。
set_config(**config_dict)	将配置标志设置为给定值。
set_params(**params)	设置此对象的参数。
set_random_state([random_state, deep, ...])	为 self 设置 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 of int，升序排序

包含变点 iloc 索引的序列。

start可选，默认值=0

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

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

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

返回:

pd.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 属性是否存在且为 True。is_fitted 属性应在对象 fit 方法调用中设置为 True。

如果未设置，则引发 NotFittedError。

参数:

method_namestr，可选

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

引发:

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。

引发:

如果克隆不符合规范，则抛出 RuntimeError，原因可能是 __init__ 故障。

clone_tags(estimator, tag_names=None)

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

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

clone_tags 从另一个对象 estimator 设置动态标签覆盖。

clone_tags 方法应仅在对象构造期间的 __init__ 方法中调用，或在构造后立即通过 __init__ 调用。

动态标签设置为 estimator 中标签的值，其名称在 tag_names 中指定。

tag_names 的默认设置将 estimator 中的所有标签写入 self。

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

estimator:class:BaseObject 或派生类的实例

参数:

tag_namesstr 或 str 列表，默认值 = None

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

self

返回:

对 self 的引用。

classmethod create_test_instance(parameter_set='default')

parameter_setstr，默认值=”default”

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

参数:

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

instance具有默认参数的类实例

返回:

classmethod create_test_instances_and_names(parameter_set='default')

objscls 实例列表

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

参数:

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

instance具有默认参数的类实例

返回:

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

namesstr 列表，与 objs 长度相同

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

static dense_to_sparse(y_dense)

y_densepd.Series

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

参数:

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

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

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

返回:

pd.Series

• 如果 y_sparse 是分段序列，则返回一个带有区间数据类型索引的序列。序列的值将是分段的标签。

• 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 的引用。

返回:

对 self 的引用。

注意

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

fit_predict(X, y=None)

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

拟合数据，然后预测。

要转换的数据

参数:

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

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

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

y带 RangeIndex 的 pd.DataFrame

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

• "label" - 如果任务（根据标签）是有标签的有监督或半监督分段，或分段聚类。

• "ilocs" 列和 "labels" 列中条目的含义如下所述：

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

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

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

对 self 的引用。

返回:

检测到或预测的事件。

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

fit_transform(X, y=None)

• "label" - 如果任务（根据标签）是有标签的有监督或半监督分段，或分段聚类。

• "ilocs" 列和 "labels" 列中条目的含义如下所述：

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

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

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

对 self 的引用。

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

拟合数据，然后转换。

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

参数:

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

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

要预测数据的目标值。

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 的标签值，考虑标签覆盖，按优先级降序排列：

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

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

2. 按继承顺序排列。

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

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

tag_namestr

参数:

标签值的名称。

tag_value_default任何类型

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

tag_value

返回:

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

classmethod get_class_tags()

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

从类中获取类标签，带有来自父类的标签级别继承。

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

clone_tags 从另一个对象 estimator 设置动态标签覆盖。

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

值是相应的标签值，覆盖按优先级降序排列：

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

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

2. 按继承顺序排列。

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

要检索具有潜在实例覆盖的标签，请改用 get_tags 方法。

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

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

collected_tagsdict

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

get_config()

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

获取自身的配置标志。

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

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

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

config_dictdict

返回:

配置名称：配置值对字典。通过嵌套继承从 _config 类属性收集，然后通过 _onfig_dynamic 对象属性收集所有覆盖和新标签。

get_fitted_params(deep=True)

所需状态

获取拟合的参数。

要求状态为“fitted”。

deepbool，默认值=True

参数:

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

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

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

• fitted_params键为 str 的 dict

返回:

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

获取对象的参数名称。

sortbool，默认值=True

参数:

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

param_names: list[str]

返回:

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

get_params(deep=True)

是否返回组件的参数。

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

参数:

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

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

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

• params键为 str 的 dict

返回:

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

总是：此对象的所有参数，如通过 get_param_names 获得的此对象该键的参数值，值总是与构造时传递的值相同

• get_tag(tag_name, tag_value_default=None, raise_error=True)

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

• classmethod get_param_defaults()

get_tag 方法从实例中检索名称为 tag_name 的单个标签值，考虑标签覆盖，按优先级降序排列：

从实例中获取标签值，带有标签级别继承和覆盖。

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

clone_tags 从另一个对象 estimator 设置动态标签覆盖。

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

1. 在实例构造时设置。

要检索的标签名称

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

3. 按继承顺序排列。

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

参数:

标签值的名称。

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

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

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

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

clone_tags 从另一个对象 estimator 设置动态标签覆盖。

collected_tagsdict

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

1. 在实例构造时设置。

要检索的标签名称

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

3. 按继承顺序排列。

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

返回:

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

classmethod get_test_params(parameter_set='default')

get_test_params 是一个统一的接口点，用于存储测试目的的参数设置。此函数也用于 create_test_instance 和 create_test_instances_and_names 来构建测试实例。

返回 skbase 对象的测试参数设置。

get_test_params 应返回单个 dict，或 dict 的 list。

每个 dict 是一个用于测试的参数配置，可用于构造一个“有趣的”测试实例。对于 get_test_params 返回中的所有字典 params，调用 cls(**params) 应该有效。

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

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

参数:

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

instance具有默认参数的类实例

返回:

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

is_composite()

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

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

composite: bool

返回:

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

property is_fitted

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

是否已调用 fit。

bool

返回:

评估器是否已 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)

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

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

编码因任务和 learning_type（标签）而异，参见下文。

对于跨任务类型一致的返回值，请参见 predict_points 和 predict_segments。

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

参数:

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

predict_points(X)

返回:

检测到或预测的事件。

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

fit_transform(X, y=None)

• "label" - 如果任务（根据标签）是有标签的有监督或半监督分段，或分段聚类。

• "ilocs" 列和 "labels" 列中条目的含义如下所述：

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

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

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

对 self 的引用。

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

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

Xpd.DataFrame

参数:

pd.DataFrame 包含以下列：

predict_points(X)

返回:

检测到或预测的事件。

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

• "labels" - 如果任务（根据标签）是有监督或半监督分段，或异常聚类。

• "ilocs" 列和 "labels" 列中分段的含义如下所示：

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

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

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

predict_scores(X)

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

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

参数:

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

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

返回:

序列 X 的预测得分。

predict_segments(X)

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

预测测试/部署数据上的分段。

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

参数:

pd.DataFrame 包含以下列：

predict_points(X)

返回:

检测到或预测的事件。

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

• "labels" - 如果任务（根据标签）是有监督或半监督分段，或分段聚类。

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

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

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

• reset()

将 self 设置为构造函数调用后的状态，具有相同的超参数。set_config 设置的配置值也保留。

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

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

超参数 = __init__ 的参数写入 self，例如 self.paramname，其中 paramname 是 __init__ 的参数

• 包含双下划线（即字符串 “__”）的对象属性。例如，名为 “__myattr” 的属性将保留。

• 配置属性，配置保持不变。也就是说，reset 前后 get_config 的结果相同。

• 类方法和对象方法，以及类属性也不受影响。

等效于 clone，但 reset 会改变 self，而不是返回一个新对象。

等同于 clone，不同之处在于 reset 会修改 self 而不是返回一个新对象。

调用 self.reset() 后，self 的值和状态将与调用构造函数 ``type(self)(**self.get_params(deep=False))`` 后获得的对象相等。

返回:

对 self 的引用。

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

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

将序列化的 self 保存为类似字节的对象或 (.zip) 文件。

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

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

参数:

pathNone 或 文件位置 (str 或 Path)

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

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

• path=”/home/stored/estimator”，则将创建 zip 文件 estimator.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 类属性收集，然后通过 _onfig_dynamic 对象属性收集所有覆盖和新标签。

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

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

jupyter kernel 如何显示 self 的实例

• “diagram” = html 框图表示

• “text” = 字符串输出

print_changed_onlybool，默认值=True

打印 self 时是否只列出与默认值不同的 self 参数 (False)，还是列出所有参数名称和值 (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 的引用。

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

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

set_params(**params)

设置此对象的参数。

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

参数:

**paramsdict

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

返回:

self指向 self 的引用（参数设置后）

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

为 self 设置 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 可在多次函数调用中获得可复现的输出。

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

是否在 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)

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

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

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

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

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

estimator:class:BaseObject 或派生类的实例

参数:

**tag_dictdict

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

返回:

Self

注意

static sparse_to_dense(y_sparse, index)

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

参数:

y_sparsepd.Series

• 如果 y_sparse 是一个索引为区间的序列，它应该代表分段，其中序列的每个值是分段的标签。未分类的区间应标记为 -1。分段永远不能有标签 0。

• 如果 y_sparse 的索引不是区间集，则序列的值应代表变化点/异常的索引。

index类似数组的对象

包含 y_sparse 中事件索引的较大索引集，将用作返回序列的索引。

返回:

pd.Series

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

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

• 如果 y_sparse 是分段序列，则返回的序列根据其索引落入的分段进行标记。未落入任何分段的索引标记为 -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)

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

参数:

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

predict_points(X)

返回:

序列 X 的标签。

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

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

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

• classmethod get_class_tag(tag_name, tag_value_default=None)

transform_scores(X)

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

参数:

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

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

返回:

scores索引与 X 相同的 pd.DataFrame

序列 X 的得分。

update(X, y=None)

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

参数:

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

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

ypd.Series，可选

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

返回:

对 self 的引用。

注意

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

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

update_predict(X, y=None)

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

参数:

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

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

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

y带 RangeIndex 的 pd.DataFrame

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

• "label" - 如果任务（根据标签）是有标签的有监督或半监督分段，或分段聚类。

• "ilocs" 列和 "labels" 列中条目的含义如下所述：

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

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

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

对 self 的引用。

返回:

检测到或预测的事件。

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

fit_transform(X, y=None)

• "label" - 如果任务（根据标签）是有标签的有监督或半监督分段，或分段聚类。

• "label" - 如果任务（通过标签确定）是监督式或半监督式分段，或分段聚类。

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

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

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

对 self 的引用。