ZeroAnomalies

class ZeroAnomalies

永远不检测到任何异常的虚拟异常检测器。

可作为基准测试流水线或 API 测试的朴素方法。

不检测异常。

属性:

is_fitted

fit 方法是否已被调用。

示例

>>> import pandas as pd
>>> from sktime.detection.dummy import ZeroAnomalies
>>> X = pd.Series([1, 2, 3, 4, 5, 6, 7, 8, 9, 10])
>>> d = ZeroAnomalies()
>>> Xt = d.fit_transform(X)

方法

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, ...])	为对象设置 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_sparseint 类型的 pd.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，可选

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

抛出:

未拟合错误

如果估计器尚未拟合。

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 或 list of 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 个元素是测试中 objs 中第 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 是段落序列，将返回一个带有区间数据类型索引的序列。序列的值将是段落的标签。

fit(X, y=None)

拟合训练数据。

参数:

Xpd.DataFrame, pd.Series 或 np.ndarray

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

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

如果检测器是监督式的，则是在 X 中的已知训练事件。

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

• "ilocs" - 始终存在。值编码事件发生的位置/时间，通过 iloc 引用 X 的索引，或 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" - 始终存在。值编码事件发生的位置/时间，通过 iloc 引用 X 的索引，或 X 的索引范围，如下所述。

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

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

• 如果 task 是 "anomaly_detection"（异常检测）或 "change_point_detection"（变化点检测），"ilocs" 包含事件发生的 iloc 索引。

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

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

返回:

y带有 RangeIndex 的 pd.DataFrame

检测到或预测到的事件。

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

• "ilocs" - 始终存在。值编码事件发生的位置/时间，通过 iloc 引用 X 的索引，或 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 类型的 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)

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

参数:

deepbool，默认为 True

是否返回组件的参数。

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

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

返回:

params键为 str 类型的 dict

参数字典，包含 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 或 list of 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”) 的结果

返回:

cls.save(path) 将序列化的 self 保存到 path，此方法反序列化得到的结果。

classmethod load_from_serial(serial)

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

参数:

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

返回:

cls.save(None) 将序列化的 self 保存到 serial，此方法反序列化得到的结果。

predict(X)

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

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

编码方式因任务和学习类型（标签）而异，详见下文。

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

参数:

Xpd.DataFrame, pd.Series 或 np.ndarray

待检测的时间序列，将为其分配标签或分数。

返回:

y带有 RangeIndex 的 pd.DataFrame

检测到或预测到的事件。

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

• "ilocs" - 始终存在。值编码事件发生的位置/时间，通过 iloc 引用 X 的索引，或 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" - 始终存在。值是左闭区间，左/右值是 iloc 对 X 索引的引用，表示段落。

• "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。

存储在 /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 时是仅列出与默认值不同的参数（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对对象的引用。

注意事项

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

set_params(**params)

设置此对象的参数。

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

参数:

**paramsdict

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

返回:

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 从链式哈希中采样，并保证种子随机生成器的伪随机独立性。

仅当 deep=True 时，根据 self_policy 应用于 self 中的 random_state 参数以及其余组件对象。

注意：即使 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引用自身

set_tags(**tag_dict)

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

每个 scikit-base 兼容对象都有一个标签字典，用于存储对象的元数据。

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

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

set_tags 方法应仅在对象的 __init__ 方法中、构建期间，或通过 __init__ 直接在构建后调用。

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

参数:

**tag_dict字典

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

返回:

自身

对对象的引用。

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)

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

参数:

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" - 始终存在。值编码事件发生的位置/时间，通过 iloc 引用 X 的索引，或 X 的索引范围，如下所述。

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

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

• 如果 task 是 "anomaly_detection"（异常检测）或 "change_point_detection"（变化点检测），"ilocs" 包含事件发生的 iloc 索引。

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

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

返回:

y带有 RangeIndex 的 pd.DataFrame

检测到或预测到的事件。

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

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

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

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

• 如果 task 是 "anomaly_detection"（异常检测）或 "change_point_detection"（变化点检测），"ilocs" 包含事件发生的 iloc 索引。

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

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