泊松HMM#

class PoissonHMM(n_components: int = 1, startprob_prior: float = 1.0, transmat_prior: float = 1.0, lambdas_prior: float = 0.0, lambdas_weight: float = 0.0, algorithm: str = 'viterbi', random_state: int = None, n_iter: int = 10, tol: float = 0.01, verbose: bool = False, params: str = 'stl', init_params: str = 'stl', implementation: str = 'log')[source]#

具有泊松发射的隐马尔可夫模型。

参数：

n_componentsint: 状态数。
startprob_priorarray, shape (n_components, ), optional: 用于 startprob_ 的 Dirichlet 先验分布参数。
transmat_priorarray, shape (n_components, n_components), optional: 用于转移概率 transmat_ 每一行的 Dirichlet 先验分布参数。
lambdas_prior, lambdas_weightarray, shape (n_components,), optional: 分别使用 alpha-beta 符号表示的 lambda 值的 gamma 先验。如果为 None，将根据矩法设置。
algorithm{“viterbi”, “map”}, optional: 解码算法。
random_state: RandomState 或整数种子, optional: 随机数生成器实例。
n_iterint, optional: 要执行的最大迭代次数。
tolfloat, optional: 收敛阈值。如果对数似然的增益低于此值，EM算法将停止。
verbosebool, optional: 是否将每次迭代的收敛报告打印到 sys.stderr。也可以使用 monitor_ 属性诊断收敛情况。
params, init_paramsstring, optional: 在训练期间 (params) 或训练之前 (init_params) 更新或初始化的参数。可以包含 ‘s’ (startprob)、‘t’ (transmat) 和 ‘l’ (lambdas) 的任意组合。默认为所有参数。
implementation: string, optional: 确定前向-后向算法是使用对数实现（“log”）还是使用缩放（“scaling”）实现。默认使用对数以保证向后兼容性。

属性：

monitor_ConvergenceMonitor: 用于检查 EM 算法收敛情况的监控对象。
startprob_array, shape (n_components, ): 初始状态分布。
transmat_array, shape (n_components, n_components): 状态间的转移概率矩阵。
lambdas_array, shape (n_components, n_features): 给定状态下每个特征等待时间参数的期望值。

示例

>>> from sktime.detection.hmm_learn import PoissonHMM
>>> from sktime.detection.datagen import piecewise_poisson
>>> data = piecewise_poisson(
...    lambdas=[1, 2, 3], lengths=[2, 4, 8], random_state=7
...    ).reshape((-1, 1))
>>> model = PoissonHMM(n_components=3)
>>> model = model.fit(data)
>>> labeled_data = model.predict(data)

方法

`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`()	将对象重置为干净的初始化后状态。
`sample`([n_samples, random_state, currstate])	允许用户从其 HMM 中采样的接口类。
`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 or list of dict

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

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

参数：

y_sparsepd.Series of int, sorted ascendingly: 一个包含变化点iloc索引的序列，按升序排序。
startoptional, default=0: 第一个段的起始点。必须在第一个变化点之前，即 < y_sparse[0]。
endoptional, 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, optional: 调用此方法的名称。如果提供，错误消息将包含此信息。

引发：

NotFittedError: 如果估计器尚未拟合。

clone()[source]#

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

克隆是一个没有共享引用的新对象，处于初始化后状态。此函数等效于返回 sklearn.clone(self)。

等效于构造一个 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 or list of str, default = None: 要克隆的标签名称。默认值 (None) 克隆 estimator 中的所有标签。

返回：

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])
namesstr 列表，与 objs 长度相同: 第 i 个元素是测试中 objs 中第 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 or 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 or 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 or np.ndarray: 要转换的数据
ypd.Series 或 np.ndarray, optional (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 的标签值，考虑到标签覆盖，优先级降序如下：

在类的 _tags 属性中设置的标签。
在父类的 _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 属性的任何键。

值是对应的标签值，按以下优先级降序进行覆盖：

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

按继承顺序排列。

实例可以根据超参数覆盖这些标签。

要检索可能带有实例覆盖的标签，请改用 get_tags 方法。

不考虑通过 set_tags 或 clone_tags 在实例上设置的动态标签覆盖。

要包含动态标签的覆盖，请使用 get_tags。

collected_tags字典: 标签名称 : 标签值对的字典。通过嵌套继承从 _tags 类属性收集。不受通过 set_tags 或 clone_tags 设置的动态标签覆盖。

get_config()[source]#

获取自身的配置标志。

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

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

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

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

返回：

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

get_fitted_params(deep=True)[source]#

获取已拟合参数。

所需状态: 要求状态为“已拟合”。

参数：

deepbool，默认=True

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

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

返回：

fitted_params键为 str 类型的字典

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

始终：此对象的所有已拟合参数，如通过 get_param_names 获取的，值是此对象该键对应的已拟合参数值
如果 deep=True，还包含组件参数的键/值对，组件的参数索引为 [组件名称]__[参数名称]，组件名称 的所有参数作为 参数名称 及其值出现
如果 deep=True，还包含任意级别的组件递归，例如，[组件名称]__[子组件名称]__[参数名称] 等

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，将返回此对象的参数名称 : 值 字典，包括组件（= BaseObject 类型的参数）的参数。
如果为 False，将返回此对象的参数名称 : 值 字典，但不包含组件的参数。

返回：

params键为 str 类型的字典

参数字典，paramname : paramvalue 键值对包含

始终：此对象的所有参数，如通过 get_param_names 获取的，值是此对象该键对应的参数值，值始终与构造时传递的值相同
如果 deep=True，还包含组件参数的键/值对，组件的参数索引为 [组件名称]__[参数名称]，组件名称 的所有参数作为 参数名称 及其值出现
如果 deep=True，还包含任意级别的组件递归，例如，[组件名称]__[子组件名称]__[参数名称] 等

get_tag(tag_name, tag_value_default=None, raise_error=True)[source]#

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

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

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

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

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

在实例构造时设置。

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

按继承顺序排列。

参数：

tag_namestr: 要检索的标签名称
tag_value_default任意类型，可选；默认=None: 如果未找到标签，则使用的默认/回退值
raise_errorbool: 当未找到标签时是否引发 ValueError

返回：

tag_value任意: 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 设置的标签。

值是对应的标签值，按以下优先级降序进行覆盖：

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

在实例构造时设置。

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

按继承顺序排列。

返回：

collected_tags字典: 标签名称 : 标签值对的字典。通过嵌套继承从 _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) 的结果

返回：

cls.save(path) 的反序列化自身，结果输出到 path

classmethod load_from_serial(serial)[source]#

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

参数：

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

返回：

cls.save(None) 的反序列化自身，结果输出为 serial

predict(X)[source]#

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

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

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

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

参数：

Xpd.DataFrame, pd.Series or 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" - 始终存在。值是整数，是 X 索引的 iloc 引用，表示关注点。
"labels" - 如果任务（通过标签指定）是监督或半监督分割，或异常聚类。

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

如果 task 是 "anomaly_detection" 或 "change_point_detection"，则这些值是变化点/异常的整数索引。
如果 task 是 "segmentation"，则这些值是连续的段边界。

`“labels”` 是感兴趣点的潜在标签。

predict_scores(X)[source]#

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

参数：

Xpd.DataFrame, pd.Series or np.ndarray: 要标注的数据（时间序列）。

返回：

scorespd.DataFrame，其索引与 predict 返回值的索引相同: 序列 X 的预测分数。

predict_segments(X)[source]#

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

与 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()[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: 类实例重置为初始化后的干净状态，但保留当前的超参数值。

sample(n_samples=1, random_state=None, currstate=None)[source]#: 允许用户从其 HMM 中采样的接口类。

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: 一个段序列。索引必须是 interval 数据类型，值应为段的整数标签。

返回：

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_dict字典

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

displaystr，“diagram”（默认）或“text”

jupyter kernel 如何显示 self 的实例

“diagram” = html 框图表示
“text” = 字符串打印输出

print_changed_onlybool，默认为 True

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

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)[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 中取决于 self_policy 的 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 对象的参数（即组件 estimator）中设置随机状态。

如果为 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 是一个索引为区间的 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 or 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 or np.ndarray: 要标注的数据（时间序列）。

返回：

scorespd.DataFrame，其索引与 X 相同: 序列 X 的分数。

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

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

参数：

Xpd.DataFrame, pd.Series or np.ndarray: 用于更新模型的训练数据（时间序列）。
ypd.Series，可选: 如果检测器是监督式的，则为训练用的真实标签。

返回：

self: 引用自身。

注意

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

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

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

参数：

Xpd.DataFrame, pd.Series or 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" 列中的标签（如果存在）指示事件的类型。