SubLOF#

class SubLOF(n_neighbors, window_size, *, algorithm='auto', leaf_size=30, metric='minkowski', p=2, metric_params=None, contamination='auto', novelty=False, n_jobs=None)[source]#

局部异常因子（Local Outlier Factor）的时间序列版本。

LOF 模型适用于窗口时间序列数据。

参数:
n_neighborsint, default=20

默认情况下用于 kneighbors 查询的邻居数量。如果 n_neighbors 大于提供的样本数量，则将使用所有样本。

window_sizeint, float, timedelta

用于拟合 LOF 模型的非重叠窗口的大小。

algorithm{‘auto’, ‘ball_tree’, ‘kd_tree’, ‘brute’}, default=’auto’

用于计算最近邻居的算法

  • ‘ball_tree’ 将使用 BallTree

  • ‘kd_tree’ 将使用 KDTree

  • ‘brute’ 将使用暴力搜索。

  • ‘auto’ 将尝试根据传递给 fit 方法的值来决定最合适的算法。

注意：在稀疏输入上拟合将覆盖此参数的设置，使用暴力方法。

leaf_sizeint, default=30

传递给 BallTree 或 KDTree 的叶子大小。这会影响构建和查询的速度，以及存储树所需的内存。最佳值取决于问题的性质。

metricstr 或 callable, default=’minkowski’

用于距离计算的度量。默认为“minkowski”，当 p = 2 时，它对应于标准的欧几里得距离。有关有效度量值，请参见 scipy.spatial.distance 的文档以及 distance_metrics 中列出的度量。

如果度量是“precomputed”，则假设 X 是一个距离矩阵，并且在拟合期间必须是方阵。X 可以是 稀疏图，在这种情况下，只有“非零”元素才可能被视为邻居。

如果度量是一个可调用函数，它接受两个表示一维向量的数组作为输入，并且必须返回一个值来指示这些向量之间的距离。这对于 Scipy 的度量有效，但效率不如将度量名称作为字符串传递。

pfloat, default=2

sklearn.metrics.pairwise_distances 中 Minkowski 度量的参数。当 p = 1 时，这等同于使用 manhattan_distance (l1)，当 p = 2 时等同于 euclidean_distance (l2)。对于任意 p，使用 minkowski_distance (l_p)。

metric_paramsdict, default=None

度量函数的额外关键字参数。

contamination‘auto’ 或 float, default=’auto’

数据集的污染量，即数据集中异常值的比例。拟合时，此参数用于定义样本得分的阈值。

  • 如果为 ‘auto’，则阈值按照原始论文中的方法确定，

  • 如果为浮点数，污染量应在 (0, 0.5] 的范围内。

在 0.22 版本中更改: contamination 的默认值从 0.1 更改为 'auto'。

noveltybool, default=False

默认情况下，LocalOutlierFactor 仅用于异常值检测（novelty=False）。如果您想将 LocalOutlierFactor 用于新颖性检测，请将 novelty 设置为 True。在这种情况下，请注意您只能在新未见过的数据上使用 predict、decision_function 和 score_samples，而不能在训练集上使用；并注意以此方式获得的结果可能与标准的 LOF 结果不同。

n_jobsint, default=None

用于邻居搜索的并行作业数。None 表示 1，除非在 joblib.parallel_backend 上下文中。 -1 表示使用所有处理器。有关更多详细信息，请参见 词汇表。

属性:
is_fitted

是否已调用 fit。

示例

>>> import pandas as pd
>>> from sktime.detection.lof import SubLOF
>>> model = SubLOF(3, window_size=5, novelty=True)
>>> x = pd.DataFrame([0, 0.5, 100, 0.1, 0, 0, 0, 100, 0, 0, 0.3, -1, 0, 100, 0.2])
>>> model.fit_transform(x)
    labels
0        0
1        0
2        1
3        0
4        0
5        0
6        0
7        1
8        0
9        0
10       0
11       0
12       0
13       1
14       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()

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

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

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

参数:
parameter_setstr, default=”default”

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

返回:
paramsdict 或 list of dict
static change_points_to_segments(y_sparse, start=None, end=None)[source]#

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

参数:
y_sparsepd.Series of int, 按升序排序

包含变点 iloc 索引的序列。

start可选, default=0

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

end可选, default=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。

等同于使用 self 的参数构造一个 type(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)[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 或 list of str, default = None

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

返回:
self

对 self 的引用。

classmethod create_test_instance(parameter_set='default')[source]#

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

参数:
parameter_setstr, default=”default”

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

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

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

参数:
parameter_setstr, default=”default”

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

返回:
objscls 实例列表

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

nameslist of str, 与 objs 长度相同

第 i 个元素是测试中 obj 的第 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

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

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

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

使用给定的检测参数将模型拟合到 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)[source]#

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

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

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

要转换的数据

ypd.Series 或 np.ndarray, 可选 (default=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)[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]#

获取自身的配置标志。

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

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

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

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

返回:
config_dictdict

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

get_fitted_params(deep=True)[source]#

获取已拟合的参数。

所需状态

需要状态为“已拟合”。

参数:
deepbool, default=True

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

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

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

返回:
fitted_paramsstr 键的 dict

拟合参数的字典，包含 paramname : paramvalue 键值对：

  • 始终：此对象的所有拟合参数，如同通过 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, default=True

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

返回:
param_names: list[str]

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

get_params(deep=True)[source]#

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

参数:
deepbool, default=True

是否返回组件的参数。

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

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

返回:
paramsstr 键的 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)[source]#

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

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

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

get_tag 方法从实例中检索名为 tag_name 的单个标签的值，考虑标签覆盖，优先级从高到低顺序如下：

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

在实例构造时。

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

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

按照继承顺序。

参数:
tag_namestr

要检索的标签名称

tag_value_default任意类型, 可选; 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]#

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

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

返回:
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”) 的结果
返回:
反序列化 self，结果输出到 path，等同于 cls.save(path) 的输出
classmethod load_from_serial(serial)[source]#

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

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

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

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

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

对于在不同任务中类型一致的返回值，请参见 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)[source]#

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

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

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

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

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

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

序列 X 的预测分数。

predict_segments(X)[source]#

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

与 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()[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” 则会在

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

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”（默认）或“text”

jupyter 内核如何显示 self 的实例

  • “diagram” = html 框图表示

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

print_changed_only布尔值，默认值=True

打印 self 时是仅列出与默认值不同的 self 参数（True 时），还是列出所有参数名称和值（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”: 布尔值，默认值=True；False 阻止 ray 在

      并行化后关闭。

    • “logger_name”: str，默认值=”ray”；要使用的日志记录器的名称。

    • “mute_warnings”: 布尔值，默认值=False；如果为 True，则抑制警告

返回:
self指向 self 的引用。

注意

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

set_params(**params)[source]#

设置此对象的参数。

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

参数:
\*\*paramsdict

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

返回:
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 实例或 None，默认值=None

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

deepbool, default=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)[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 是一个以区间为索引的序列，它应该代表段，序列的每个值是段的标签。未分类的区间应标记为 -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)[source]#

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

参数:
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)[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，可选

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

返回:
self

对自身的引用。

注意

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

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

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

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