CircularBinarySegmentation

class CircularBinarySegmentation(anomaly_score=None, threshold_scale=None, level: float = 1e-08, min_segment_length: int = 5, max_interval_length: int = 1000, growth_factor: float = 1.5)

用于异常段检测的循环二分分割算法，skchange。

重定向到 skchange.anomaly_detectors.circular_binseg。

二分分割类型变化点检测算法递归地将数据分割成两个段，并测试两个段是否不同。循环二分分割 [1] 是二分分割的一种变体，其中统计检验（异常分数）用于比较内部间隔子集与外部间隔中包含的周围数据的数据行为。

换句话说，在每个外部间隔内的零假设是数据是平稳的，而备择假设是在外部间隔内存在集体异常。

使用 numba 高效实现。

参数:

anomaly_scoreBaseLocalAnomalyScore 或 BaseCost，可选 (默认值=L2Cost())

用于异常检测的局部异常分数。如果给定成本，则使用 LocalAnomalyScore 类将其转换为局部异常分数。

threshold_scale浮点数，默认值=2.0

阈值的比例因子。阈值设置为 threshold_scale * 2 * p * np.sqrt(np.log(n))，其中 n 是样本大小，p 是变量数量。如果为 None，则在输入到 .fit() 的数据上调整阈值。

level浮点数，默认值=0.01

如果 threshold_scale 为 None，则阈值设置为训练数据上所有种子间隔的变化点分数的 (1-level)-分位数。为了使其正确，训练数据必须不包含变化点。

min_segment_length整数，默认值=5

两个变化点之间的最小长度。必须大于或等于 1。

max_interval_length整数，默认值=100

估计变化点的间隔的最大长度。必须大于或等于 2 * min_segment_length。

growth_factor浮点数，默认值=1.5

种子间隔的增长因子。间隔大小根据 interval_len=max(interval_len + 1, np.floor(growth_factor * interval_len)) 增长，从 interval_len=min_interval_length 开始。它还控制相同长度的间隔之间的重叠量，因为每个间隔的开始都偏移了 1 + 1 / growth_factor 的因子。必须是 (1, 2] 中的浮点数。

属性:

is_fitted

fit 是否已被调用。

说明

使用成本生成局部异常分数将比使用直接实现的异常分数慢得多。这是因为局部异常分数需要评估数据不相交子集（异常之前和之后）的成本，这对于实现为间隔评估器的成本来说不是一个自然的操作。

参考

[1]

Olshen, A. B., Venkatraman, E. S., Lucito, R., & Wigler, M. (2004). Circular

binary segmentation for the analysis of array-based DNA copy number data. Biostatistics, 5(4), 557-572.

示例

>>> from skchange.anomaly_detectors import CircularBinarySegmentation
>>> from skchange.datasets.generate import generate_alternating_data
>>> df = generate_alternating_data(n_segments=5, mean=10, segment_length=20)
>>> detector = CircularBinarySegmentation()
>>> detector.fit_predict(df)
0    [20, 40)
1    [60, 80)
Name: anomaly_interval, dtype: interval

方法

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()	检查对象是否由其他 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, ...])	设置自身的随机状态伪随机种子参数。
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 索引的序列。

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。

引发:

如果克隆不符合要求（由于 __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 个元素是测试中第 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 是一个变化点/异常序列，将返回一个包含变化点/异常索引的 pandas 序列。

• 如果 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

自身的引用。

说明

创建拟合模型，该模型更新以 “_” 结尾的属性。将 _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)

获取已拟合的参数。

所需状态

要求状态为“fitted”。

参数:

deepbool, 默认值=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)

获取对象的参数名称。

参数:

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键为字符串类型的字典

参数字典，键值对为 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 对象属性中获取任何覆盖和新标签。

classmethod get_test_params(parameter_set='default')

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

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

get_test_params 应该返回一个单独的 dict，或者一个 dict 的 list。

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

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

参数:

parameter_setstr，默认值=”default”

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

返回:

paramsdict 或 dict 列表，默认 = {}

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

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，其输出位于 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。

参数:

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" - 始终包含。值是整数，是 iloc 对 X 索引的引用，表示兴趣点。

• "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” 则将在当前工作目录创建 zip 文件 estimator.zip。

• path=”/home/stored/estimator” 则将在

/home/stored/ 中存储 zip 文件 estimator.zip。

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>，例如，没有两个组件的参数名称相同。

参数:

**paramsdict

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

返回:

self对 self 的引用（参数设置后）

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

设置自身的随机状态伪随机种子参数。

通过 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_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

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

返回:

scores与 X 索引相同的 pd.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" 列中的标签（如果存在）指示事件的类型。