HMM#

类 HMM(emission_funcs: list, transition_prob_mat: ndarray, initial_probs: ndarray = None)[source]#

实现了一个使用维特比算法拟合的简单隐马尔可夫模型（HMM）。

HMM 注释估计器使用维特比算法将一系列“隐状态”类别注释（表示为一个与观测序列大小相同的整数数组）拟合到观测序列上。

这是通过找到给定发射概率（即特定观测值由给定隐状态产生的概率）、转移概率（即从一个状态转移到另一个状态或保持在同一状态的概率）以及初始概率（即对观测序列开始时隐状态概率分布的信念）的最可能路径来完成的。

当前实现的假设/限制

  • 假设时间序列点之间的间隔是等价的。

  • 它只适用于单变量数据。

  • 发射参数和转移概率是

    假设已知。

  • 如果未传递初始概率，则会分配均匀概率

    （即而不是平稳分布）。

  • 需要并返回 np.ndarrays。

_fit 当前为空，因为需要将概率分布的参数传递给算法。

_predict - 首先计算 transition_probability 和 transition_id 矩阵 - 这两个都是 nxm 矩阵，其中 n 是隐状态的数量，m 是观测值的数量。转移概率矩阵记录将观测值 m 分配给隐状态 n 的最可能序列的概率。transition_id 矩阵记录在最可能路径中先于隐状态 n 的前一步。这个逻辑主要由辅助函数 _calculate_trans_mats 完成。接下来，这些矩阵用于计算最可能的路径（通过从最终最可能的状态及其前面的 id 回溯）。这个逻辑通过辅助函数 hmm_viterbi_label 完成。

参数:
emission_funcslist, 形状 = [隐状态数量]

列表长度应为 n（隐状态的数量）。可以是可调用对象列表 [fx_1, fx_2]，其签名为 fx_1(X) -> float，或可调用对象及其匹配的关键字参数列表 [(fx_1, kwarg_1), (fx_2, kwarg_2)]，其签名为 fx_1(X, **kwargs) -> float（或两者混合的列表）。这些可调用对象应接受一个值并在传递单个观测值时返回一个概率。所有函数都应是在与观测数据相同空间上正确归一化的 PDF。

transition_prob_mat: 2D np.ndarry, 形状 = [num_states, num_states]

每行之和应为 1，以便正确归一化（即第 i 行中的第 j 列代表从状态 i 转移到状态 j 的概率）。

initial_probs: 1D np.ndarray, 形状 = [隐状态数量], 可选

一个表示隐状态序列开始于每个隐状态的概率数组。如果传递，其长度应为隐状态的数量 n，并且应与 emission funcs 列表和 transition_prob_mat 的长度匹配。初始概率应反映先验信念。如果未传递，每个隐状态将分配相同的初始概率。

属性:
emission_funcslist, 形状 = [隐状态数量]

用于计算发射概率的函数。取自同名的 __init__ 参数。

transition_prob_mat: 2D np.ndarry, 形状 = [num_states, num_states]

从隐状态到隐状态的转移概率矩阵。取自同名的 __init__ 参数。

initial_probs1D np.ndarray, 形状 = [隐状态数量]

关于第一个状态的隐状态身份的概率。如果传递了同名的 __init__ 参数，它将取该值。否则，它被设置为在所有隐状态上均匀分布。

num_statesint

隐状态的数量。设置为传递的 emission_funcs 参数的长度。

stateslist

一个包含从 0 到 num_states-1 的整数列表。用于隐状态的整数标签。

num_obsint

观测数据的长度。从数据中提取。

trans_prob2D np.ndarray, 形状 = [观测数量, 隐状态数量]

形状 [观测数量, 隐状态数量]。该观测值被分配给该隐状态的最大概率。在 _calculate_trans_mat 中计算并在 _predict 中赋值。

trans_id2D np.ndarray, 形状 = [观测数量, 隐状态数量]

形状 [观测数量, 隐状态数量]。在最可能路径中，先于该观测值被分配给该隐状态的状态 ID。在 _calculate_trans_mat 中计算并在 _predict 中赋值。

示例

>>> from sktime.detection.hmm import HMM
>>> from scipy.stats import norm
>>> from numpy import asarray
>>> # define the emission probs for our HMM model:
>>> centers = [3.5,-5]
>>> sd = [.25 for i in centers]
>>> emi_funcs = [(norm.pdf, {'loc': mean,
...  'scale': sd[ind]}) for ind, mean in enumerate(centers)]
>>> hmm_est = HMM(emi_funcs, asarray([[0.25,0.75], [0.666, 0.333]]))
>>> # generate synthetic data (or of course use your own!)
>>> obs = asarray([3.7,3.2,3.4,3.6,-5.1,-5.2,-4.9])
>>> hmm_est = hmm_est.fit(obs)
>>> labels = hmm_est.predict(obs)

方法

change_points_to_segments(y_sparse[, start, end])

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

check_is_fitted([method_name])

检查估计器是否已拟合。

克隆()

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

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

返回值:
paramsdict 或 dict 列表
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。在调用对象的 fit 方法时，应将属性 is_fitted 设置为 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_dense 只包含 1 和 0，则 1 表示变化点或异常。

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

返回值:
pd.Series

  • 如果 y_dense 是变化点/异常的密集序列，则返回一个包含变化点/异常索引的 pandas 稀疏序列。

  • 如果 y_dense 是段的密集序列，则返回一个带有区间数据类型索引的稀疏序列。序列的值将是段的标签。

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

对 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 设置的标签，

在实例构造时。

  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()[源代码]#

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

每个兼容 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()[源代码]#

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

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

返回值:
composite: bool

对象是否包含任何参数，其值是 BaseObject 的后代实例。

property is_fitted[源代码]#

是否已调用 fit。

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

返回值:
bool

估计器是否已 拟合。

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" - 始终存在。值编码事件发生的地点/时间，通过 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”，则将在当前工作目录 (cwd) 创建一个 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 kernel 如何显示 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对 self 的引用。

注意

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

set_params(**params)[源代码]#

设置此对象的参数。

此方法适用于简单的 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')[源代码]#

为自身设置 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，默认为 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 是一个带有区间索引的序列，它应该表示段，其中序列的每个值都是段的标签。未分类的区间应标记为 -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

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