PyODDetector#

class PyODDetector(estimator, labels='indicator')[source]#

应用 pyOD 库中异常检测器的转换器。

参数:
estimatorPyOD 估算器

有关所有选项的详细说明，请参阅 https://pyod.readthedocs.io/en/stable/ 文档。

属性:
is_fitted

是否已调用 fit 方法。

示例

>>> import pandas as pd
>>> from sktime.detection.datagen import piecewise_normal_multivariate
>>> X = pd.DataFrame(piecewise_normal_multivariate(
...     means=[[1, 3], [4, 5]],
...     lengths=[3, 4],
...     random_state=10),
... )
>>> from sktime.detection.adapters._pyod import PyODDetector
>>> from pyod.models.ecod import ECOD
>>> model = PyODDetector(ECOD())
>>> model.fit_transform(X)
   labels
0       0
1       1
2       0
3       0
4       0
5       0
6       0

方法

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

检查对象是否由其他 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])

将序列化的对象保存到字节类对象或到 (.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])

使用新数据更新模型并为其创建标签。
classmethod get_test_params(parameter_set='default')[source]#

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

参数:
parameter_setstr，默认值=”default”

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

返回值:
paramsdict 或 dict 列表，默认值 = {}

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

static change_points_to_segments(y_sparse, start=None, end=None)[source]#

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

参数:
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)[source]#

检查估算器是否已拟合。

检查 _is_fitted 属性是否存在且为 True。is_fitted 属性应在调用对象的 fit 方法时设置为 True。

如果未拟合，则引发 NotFittedError 错误。

参数:
method_namestr，可选

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

引发:
NotFittedError

如果估算器尚未拟合。

clone()[source]#

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

克隆是一个没有共享引用的不同对象，处于初始化后状态。此函数相当于返回 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)[source]#

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

每个与 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')[source]#

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

参数:
parameter_setstr，默认值=”default”

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

返回值:
instance具有默认参数的类实例
classmethod create_test_instances_and_names(parameter_set='default')[source]#

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

参数:
parameter_setstr，默认值=”default”

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

返回值:
objscls 实例列表

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

namesstr 列表，与 objs 长度相同

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

static dense_to_sparse(y_dense)[source]#

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

参数:
y_densepd.Series

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

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

返回值:
pd.Series

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

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

fit(X, y=None)[source]#

拟合训练数据。

参数:
Xpd.DataFrame、pd.Series 或 np.ndarray

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

ypd.DataFrame（带有 RangeIndex），可选。

用于训练的已知事件，位于 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)[source]#

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

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

参数:
Xpd.DataFrame、pd.Series 或 np.ndarray

待转换的数据

ypd.DataFrame（带有 RangeIndex），可选。

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

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

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

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

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

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

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

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

返回值:
ypd.DataFrame（带有 RangeIndex）

检测到或预测到的事件。

每行 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)[source]#

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

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

参数:
Xpd.DataFrame、pd.Series 或 np.ndarray

待转换的数据

ypd.Series 或 np.ndarray，可选 (默认值=None)

待预测数据的目标值。

返回值:
ypd.DataFrame，索引与 X 相同

序列 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)[source]#

从类中获取类标签值，并继承父类的标签级别。

每个与 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()[source]#

从类中获取类标签，并继承父类的标签级别。

每个与 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()[source]#

获取对象的配置标志。

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

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

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

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

返回值:
config_dictdict

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

get_fitted_params(deep=True)[source]#

获取已拟合参数。

所需状态

要求状态为“已拟合”。

参数:
deepbool，默认值=True

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

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

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

返回值:
fitted_params键为 str 值的 dict

已拟合参数的字典，参数名 : 参数值键值对包括

  • 始终：此对象的所有已拟合参数，通过 get_param_names 获取，值是此对象该键的已拟合参数值

  • 如果 deep=True，还包含组件参数的键/值对，组件参数按 [componentname]__[paramname] 索引，componentname 的所有参数都以 paramname 及其值的形式出现

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

classmethod get_param_defaults()[source]#

获取对象的默认参数。

返回值:
default_dict: dict[str, Any]

键是 cls 中所有在 __init__ 中定义了默认值的参数。值是默认值，如 __init__ 中所定义。

classmethod get_param_names(sort=True)[source]#

获取对象的参数名称。

参数:
sortbool，默认值=True

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

返回值:
param_names: list[str]

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

get_params(deep=True)[source]#

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

参数:
deepbool，默认值=True

是否返回组件的参数。

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

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

返回值:
params键为 str 值的 dict

参数字典，参数名 : 参数值键值对包括

  • 始终：此对象的所有参数，通过 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)[source]#

从实例中获取标签值，并包含标签级别继承和覆盖。

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

标签是特定于实例 self 的键值对，它们是对象构造后不会更改的静态标志。

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

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

在实例构造时。

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

  2. 在父类 _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()[source]#

从实例中获取标签，并包含标签级别继承和覆盖。

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

标签是特定于实例 self 的键值对，它们是对象构造后不会更改的静态标志。

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

值是相应的标签值，按照以下降序优先级考虑覆盖

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

在实例构造时。

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

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

按继承顺序。

返回值:
collected_tagsdict

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

is_composite()[source]#

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

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

返回值:
composite: bool

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

property is_fitted[source]#

是否已调用 fit 方法。

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

返回值:
bool

估算器是否已 fit（拟合）。

classmethod load_from_path(serial)[source]#

从文件位置加载对象。

参数:
serialZipFile(path).open(“object) 的结果
返回值:
反序列化的对象，结果输出到 path，即 cls.save(path) 的输出
classmethod load_from_serial(serial)[source]#

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

参数:
serialcls.save(None) 输出的第一个元素
返回值:
反序列化的对象，结果输出为 serial，即 cls.save(None) 的输出
predict(X)[source]#

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

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

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

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

参数:
Xpd.DataFrame、pd.Series 或 np.ndarray

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

返回值:
ypd.DataFrame（带有 RangeIndex）

检测到或预测到的事件。

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

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

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

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

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

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

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

predict_points(X)[source]#

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

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

参数:
Xpd.DataFrame

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

返回值:
ypd.DataFrame（带有 RangeIndex）

包含以下列的 pd.DataFrame

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

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

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

  • 如果 task 是 "anomaly_detection"（异常检测）或 "change_point_detection"（变化点检测），值为变化点/异常的整数索引。

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

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

predict_scores(X)[source]#

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

参数:
Xpd.DataFrame、pd.Series 或 np.ndarray

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

返回值:
scorespd.DataFrame，索引与 predict 的返回值相同

序列 X 的预测分数。

predict_segments(X)[source]#

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

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

参数:
Xpd.DataFrame

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

返回值:
ypd.DataFrame（带有 RangeIndex）

包含以下列的 pd.DataFrame

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

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

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

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

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

reset()[source]#

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

导致将 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')[source]#

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

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

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

参数:
pathNone 或文件位置 (str 或 Path)

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

  • path=”estimator”，则会在当前工作目录 (cwd) 创建一个 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)[source]#

将分段转换为变化点。

参数:
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)[source]#

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

参数:
config_dictdict

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

displaystr, “diagram” (default), or “text”

jupyter kernel 如何显示 self 的实例

  • “diagram” = html 方框图表示

  • “text” = 字符串打印输出

print_changed_onlybool, default=True

打印 self 时是否仅列出与默认值不同的 self 参数 (True)，或列出所有参数名称和值 (False)。不进行嵌套，即只影响 self，不影响组件估计器。

warningsstr, “on” (default), or “off”

是否触发警告，只影响 sktime 的警告

  • “on” = 将触发 sktime 的警告

  • “off” = 将不触发 sktime 的警告

backend:parallelstr, optional, default=”None”

广播/向量化时用于并行的后端，可选值为

  • “None”：顺序执行循环，简单的列表推导式

  • “loky”, “multiprocessing” 和 “threading”：使用 joblib.Parallel

  • “joblib”：自定义和第三方 joblib 后端，例如 spark

  • “dask”：使用 dask，需要环境中安装 dask 包

  • “ray”：使用 ray，需要环境中安装 ray 包

backend:parallel:paramsdict, optional, default={} (no parameters passed)

作为配置传递给并行后端 的附加参数。有效键取决于 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”；要使用的 logger 的名称。

    • “mute_warnings”：bool, 默认=False；如果为 True，则抑制警告

返回值:
self对 self 的引用。

注意

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

set_params(**params)[source]#

设置此对象的参数。

该方法适用于简单的 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')[source]#

为此对象设置 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 instance or None, default=None

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

deepbool，默认值=True

是否在值是 skbase 对象的参数（即组件估计器）中设置随机状态。

  • 如果为 False，则仅设置 self 的 random_state 参数（如果存在）。

  • 如果为 True，则也会设置组件对象中的 random_state 参数。

self_policystr, one of {“copy”, “keep”, “new”}, default=”copy”

  • “copy” : self.random_state 设置为输入的 random_state

  • “keep” : self.random_state 保持不变

  • “new” : self.random_state 设置为一个新的随机状态，

从输入的 random_state 派生，通常与它不同

返回值:
self对 self 的引用
set_tags(**tag_dict)[source]#

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

每个与 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)[source]#

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

参数:
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)[source]#

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

参数:
Xpd.DataFrame、pd.Series 或 np.ndarray

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

返回值:
ypd.DataFrame，索引与 X 相同

序列 X 的标签。

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

  • 如果 task 是 "changepoint_detection"（变化点检测），值为整数标签，指示变化点之间的分段标签。可能的标签是从 0 开始的整数。

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

transform_scores(X)[source]#

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

参数:
Xpd.DataFrame、pd.Series 或 np.ndarray

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

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

序列 X 的分数。

update(X, y=None)[source]#

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

参数:
Xpd.DataFrame、pd.Series 或 np.ndarray

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

ypd.Series, optional

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

返回值:
self

对自身的引用。

注意

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

update_predict(X, y=None)[source]#

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

参数:
Xpd.DataFrame、pd.Series 或 np.ndarray

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

ypd.DataFrame（带有 RangeIndex），可选。

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

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

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

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

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

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

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

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

返回值:
ypd.DataFrame（带有 RangeIndex）

检测到或预测到的事件。

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

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

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

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

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

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

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