StatThresholdAnomaliser

class StatThresholdAnomaliser(change_detector, stat=<function mean>, stat_lower: float = -1.0, stat_upper: float = 1.0)

基于分段统计量阈值的异常检测，skchange。

重定向至 skchange.anomaly_detectors.anomalisers。

参数:

change_detectorChangeDetector

用于检测分段的改变检测器。

statcallable, 可选 (默认=``np.mean``)

每段计算的统计量。

stat_lowerfloat, 可选 (默认=-1.0)

统计量低于此值的段被视为异常。

stat_upperfloat, 可选 (默认=1.0)

统计量高于此值的段被视为异常。

属性:

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()	返回占位符的虚拟测试参数。
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])	使用新数据更新模型并为其创建标签。

get_test_params()

返回占位符的虚拟测试参数。

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。在调用对象的 fit 方法时，is_fitted 属性应设置为 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 或 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')

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

参数:

parameter_setstr，默认值=”default”

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

返回:

objscls 实例列表

第 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 的整数，则它是一个段数组。

返回:

pd.Series

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

• 如果 y_sparse 是一个段序列，将返回一个具有区间数据类型索引的 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

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

标签名称。

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

获取已拟合参数。

所需状态

要求状态为“已拟合”。

参数:

deepbool，默认值=True

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

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

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

返回:

fitted_params键为 str 值的字典

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

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

参数:

deepbool，默认值=True

是否返回组件的参数。

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

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

返回:

params键为 str 值的字典

参数字典，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_tagsdict

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

is_composite()

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

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

返回:

composite: bool

一个对象是否拥有任何值是 BaseObject 后代实例的参数。

property is_fitted

是否已调用 fit。

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

返回:

bool

估计器是否已 fit。

classmethod load_from_path(serial)

从文件位置加载对象。

参数:

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

返回:

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

classmethod load_from_serial(serial)

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

参数:

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

返回:

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

predict(X)

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

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

编码因任务和 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 调用会删除任何对象属性，除了：

• 超参数 = __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 或文件位置 (str 或 Path)

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

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

• 如果 path=”/home/stored/estimator”，则将在 /home/stored/ 存储一个 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_dictdict

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

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

jupyter 内核如何显示 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 的引用。

备注

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

set_params(**params)

设置此对象的参数。

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

参数:

**paramsdict

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 将它们设置为通过 sample_dependent_seed 从 random_state 派生出的整数。这些整数通过链式哈希采样，保证种子随机生成器具有伪随机独立性。

根据 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_dictdict

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

返回:

Self

对 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 根据索引是否与异常/变化点相关联，标记为 0 或 1。其中 1 表示异常/变化点。

• 如果 y_sparse 是一个段序列，则返回的 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

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

返回:

scores索引与 X 相同的 pd.DataFrame

序列 X 的分数。

update(X, y=None)

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

参数:

Xpd.DataFrame, pd.Series 或 np.ndarray

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

ypd.Series，可选

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

返回:

self

对 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" 列中的标签（如果存在）表示事件的类型。