EAgglo#

class EAgglo(member=None, alpha=1.0, penalty=None)[source]#

多变点分层凝聚估计。

E-Agglo 是一种用于多元时间序列的非参数聚类方法[R7d39cf41170f-1]_，其中相邻段依次合并以最大化拟合优度统计量。与大多数通用凝聚聚类算法不同，此过程保留了观测值的时间顺序。

此方法可以检测独立序列内的分布变化，并且不作任何分布假设（除了存在 alpha 阶矩）。估计以同时识别变点数量和位置的方式执行。

参数:
memberarray_like (默认=None)

将点分配给初始集群成员，因此第一维应与数据相同。如果为 None，它将被初始化为虚拟向量，其中每个点被分配到单独的集群。

alphafloat (默认=1.0)

在发散度度量中使用的固定常数 alpha，范围在 (0, 2] 内，作为 alpha 阶绝对矩，参见 [1] 中的方程 (4)。

penaltystr 或 callable 或 None (默认=None)

一个函数，用于定义拟合优度统计序列的惩罚项，以解决过拟合问题。如果为 None，则不应用惩罚。也可以是现有惩罚名称，例如 len_penalty 或 mean_diff_penalty。

属性:
merged_array_like

2D array_like，概述了在每个步骤中哪些集群被 merged_。

gof_float

当前聚类的拟合优度统计量。

cluster_array_like

1D array_like，指定输入数据 X 的每一行属于哪个集群。

注意

基于 [1] 的工作。

参考文献

[1] (1,2)

Matteson, David S., and Nicholas A. James. “A nonparametric approach for

multiple change point analysis of multivariate data.” Journal of the American Statistical Association 109.505 (2014): 334-345.

[2]

James, Nicholas A., and David S. Matteson. “ecp: An R package for

nonparametric multiple change point analysis of multivariate data.” arXiv preprint arXiv:1309.3295 (2013).

示例

>>> from sktime.detection.datagen import piecewise_normal_multivariate
>>> X = piecewise_normal_multivariate(means=[[1, 3], [4, 5]], lengths=[3, 4],
... random_state = 10)
>>> from sktime.detection.eagglo import EAgglo
>>> model = EAgglo()
>>> model.fit_transform(X)
array([0, 0, 0, 1, 1, 1, 1])

方法

check_is_fitted([method_name])

检查估计器是否已拟合。

克隆()

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

clone_tags(estimator[, tag_names])

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

create_test_instance([parameter_set])

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

create_test_instances_and_names([parameter_set])

创建所有测试实例的列表和它们的名称列表。

fit(X[, y])

用 X（可选 y）拟合变换器。

fit_transform(X[, y])

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

get_class_tag(tag_name[, tag_value_default])

从类中获取类标签值，带有从父类继承的标签层级。

get_class_tags()

从类中获取类标签，带有从父类继承的标签层级。

get_config()

获取 self 的配置标志。

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

测试参数。

inverse_transform(X[, y])

对 X 进行逆变换并返回逆变换后的版本。

is_composite()

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

load_from_path(serial)

从文件位置加载对象。

load_from_serial(serial)

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

重置()

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

save([path, serialization_format])

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

set_config(**config_dict)

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

set_params(**params)

设置此对象的参数。

set_random_state([random_state, deep, ...])

为 self 设置 random_state 伪随机种子参数。

set_tags(**tag_dict)

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

transform(X[, y])

变换 X 并返回变换后的版本。

update(X[, y, update_params])

用 X（可选 y）更新变换器。
classmethod get_test_params() → list[dict][source]#

测试参数。

测试参数。

检查估计器是否已拟合。

检查估计器是否已拟合。在调用对象的 fit 方法时，is_fitted 属性应设置为 True。

如果未拟合，则引发 NotFittedError。

参数:
method_namestr, 可选

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

引发:
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 或 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])

names字符串列表，与 objs 长度相同

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

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

用 X（可选 y）拟合变换器。

状态变化

将状态更改为“已拟合”。

写入 self

  • 设置以“_”结尾的已拟合模型属性，可通过 get_fitted_params 查看已拟合属性。

  • 将 self.is_fitted 标志设置为 True。

  • 如果 self.get_tag("remember_data") 为 True，则将 X 记忆为 self._X，强制转换为 self.get_tag("X_inner_mtype")。

参数:
Xsktime 兼容数据容器格式的时间序列

用于拟合变换的数据。

sktime 中的个体数据格式是所谓的 mtype 规范，每种 mtype 实现了一个抽象的 scitype。

  • Series scitype = 单个时间序列。pd.DataFrame, pd.Series 或 np.ndarray (1D 或 2D)

  • Panel scitype = 时间序列集合。pd.DataFrame 具有 2 级行 MultiIndex (instance, time), 3D np.ndarray (instance, variable, time), list 包含 Series 类型的 pd.DataFrame

  • Hierarchical scitype = 分层时间序列集合。pd.DataFrame 具有 3 级或更多行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)

有关数据格式的更多详细信息，请参阅关于 mtype 的术语表。有关用法，请参阅变换器教程 examples/03_transformers.ipynb

y可选，sktime 兼容数据格式的数据，默认=None

附加数据，例如用于变换的标签。如果 self.get_tag("requires_y") 为 True，则必须在 fit 中传入，而不是可选的。有关所需格式，请参阅类文档字符串了解详细信息。

返回:
self估计器的一个已拟合实例
fit_transform(X, y=None)[source]#

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

用 X 和 y 拟合变换器并返回 X 的变换后版本。

状态变化

将状态更改为“已拟合”。

写入 self: _is_fitted : 标志设置为 True。 _X : X 的强制转换副本 X，如果 remember_data 标签为 True

如果可能，通过引用强制转换为内部类型或 update_data 兼容类型

模型属性（以“_”结尾）：取决于估计器

参数:
Xsktime 兼容数据容器格式的时间序列

用于拟合变换的数据，以及要变换的数据。

sktime 中的个体数据格式是所谓的 mtype 规范，每种 mtype 实现了一个抽象的 scitype。

  • Series scitype = 单个时间序列。pd.DataFrame, pd.Series 或 np.ndarray (1D 或 2D)

  • Panel scitype = 时间序列集合。pd.DataFrame 具有 2 级行 MultiIndex (instance, time), 3D np.ndarray (instance, variable, time), list 包含 Series 类型的 pd.DataFrame

  • Hierarchical scitype = 分层时间序列集合。pd.DataFrame 具有 3 级或更多行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)

有关数据格式的更多详细信息，请参阅关于 mtype 的术语表。有关用法，请参阅变换器教程 examples/03_transformers.ipynb

y可选，sktime 兼容数据格式的数据，默认=None

附加数据，例如用于变换的标签。如果 self.get_tag("requires_y") 为 True，则必须在 fit 中传入，而不是可选的。有关所需格式，请参阅类文档字符串了解详细信息。

返回:
X 的变换后版本
类型取决于 X 的类型和 scitype:transform-output 标签
X | tf-output | 返回类型 |

|----------|————–|------------------------| | Series | Primitives | pd.DataFrame (1 行) | | Panel | Primitives | pd.DataFrame | | Series | Series | Series | | Panel | Series | Panel | | Series | Panel | Panel |

返回中的实例对应于 X 中的实例
表格中未列出的组合目前不受支持
明确说明，附带示例

  • 如果 X 是 Series (例如，pd.DataFrame)

且 transform-output 是 Series，则返回相同 mtype 的单个 Series。示例：对单个序列进行去趋势

  • 如果 X 是 Panel (例如，pd-multiindex) 且 transform-output

是 Series，则返回与 X 具有相同数量实例的 Panel（变换器应用于每个输入的 Series 实例）。示例：面板中的所有序列都单独进行去趋势

  • 如果 X 是 Series 或 Panel 且 transform-output 是

Primitives，则返回一个 pd.DataFrame，其行数与 X 中的实例数相同。示例：返回的第 i 行包含第 i 个序列的均值和方差

  • 如果 X 是 Series 且 transform-output 是 Panel，

则返回一个类型为 pd-multiindex 的 Panel 对象。示例：输出的第 i 个实例是在 X 上运行的第 i 个窗口

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 的配置标志。

配置是 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 类型的字典

已拟合参数字典，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, 默认=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 类型的字典

参数字典，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任意类型，可选；默认=None

如果未找到标签，则使用默认/回退值

raise_errorbool

未找到标签时是否引发 ValueError

返回:
tag_valueAny

self 中 tag_name 标签的值。如果未找到，则在 raise_error 为 True 时引发错误，否则返回 tag_value_default。

引发:
如果 raise_error 为 True，则引发 ValueError。

如果 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 对象属性获取任何覆盖和新标签。

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

对 X 进行逆变换并返回逆变换后的版本。

目前假定只有带有以下标签的变换器

“scitype:transform-input”=”Series”, “scitype:transform-output”=”Series”,”

具有 inverse_transform 方法。

所需状态

要求状态为“已拟合”。

在 self 中的访问

  • 以“_”结尾的已拟合模型属性。

  • self.is_fitted, 必须为 True

参数:
Xsktime 兼容数据容器格式的时间序列

用于拟合变换的数据。

sktime 中的个体数据格式是所谓的 mtype 规范，每种 mtype 实现了一个抽象的 scitype。

  • Series scitype = 单个时间序列。pd.DataFrame, pd.Series 或 np.ndarray (1D 或 2D)

  • Panel scitype = 时间序列集合。pd.DataFrame 具有 2 级行 MultiIndex (instance, time), 3D np.ndarray (instance, variable, time), list 包含 Series 类型的 pd.DataFrame

  • Hierarchical scitype = 分层时间序列集合。pd.DataFrame 具有 3 级或更多行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)

有关数据格式的更多详细信息，请参阅关于 mtype 的术语表。有关用法，请参阅变换器教程 examples/03_transformers.ipynb

y可选，sktime 兼容数据格式的数据，默认=None

附加数据，例如用于变换的标签。某些变换器需要此项，请参阅类文档字符串了解详细信息。

返回:
X 的逆变换后版本

与 X 类型相同，并符合 mtype 格式规范

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

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

参数:
serialcls.save(None) 输出的第一个元素
返回:
反序列化的 self，结果输出 serial，即 cls.save(None) 的输出
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]#

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

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

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

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

如果为 None，对象本身将保存到内存对象中 如果是文件位置，对象本身将保存到该文件位置。

  • 如果 path=”estimator”，则将在当前工作目录 (cwd) 创建一个 zip 文件 estimator.zip。

  • 如果 path=”/home/stored/estimator”，则将把 zip 文件 estimator.zip 保存

到 /home/stored/ 中。

serialization_format: str, 默认 = “pickle”

用于序列化的模块。可用选项有“pickle”和“cloudpickle”。请注意，非默认格式可能需要安装其他软依赖项。

返回:
如果 path 为 None - 内存中的序列化对象本身
如果 path 为文件位置 - 包含文件引用的 ZipFile
set_config(**config_dict)[source]#

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

参数:
config_dictdict

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

displaystr, “diagram” (默认), 或 “text”

jupyter 内核如何显示对象实例

  • “diagram” = html 框图表示

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

print_changed_onlybool, 默认=True

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

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，则抑制警告

input_conversionstr, “on” (默认), “off”, 或 有效 mtype 字符串之一

控制输入检查和转换，用于 _fit, _transform, _inverse_transform, _update

  • "on" - 执行输入检查和转换

  • "off" - 在将数据传递给内部方法之前，不执行输入检查和转换

  • 有效 mtype 字符串 - 输入被假定为指定的 mtype，执行转换但不进行检查

output_conversionstr, “on”, “off”, 有效 mtype 字符串之一

控制 _transform, _inverse_transform 的输出转换

  • "on" - 如果 input_conversion 为“on”，则执行输出转换

  • "off" - 直接返回 _transform, _inverse_transform 的输出

  • 有效 mtype 字符串 - 输出被转换为指定的 mtype

返回:
self对象本身的引用。

注意

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

set_params(**params)[source]#

设置此对象的参数。

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

参数:
**paramsdict

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

返回:
self对象本身的引用（设置参数后）
set_random_state(random_state=None, deep=True, self_policy='copy')[source]#

为 self 设置 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对象本身的引用
set_tags(**tag_dict)[source]#

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

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

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

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

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

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

参数:
**tag_dictdict

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

返回:
Self

对象本身的引用。

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

变换 X 并返回变换后的版本。

所需状态

要求状态为“已拟合”。

在 self 中的访问

  • 以“_”结尾的已拟合模型属性。

  • self.is_fitted, 必须为 True

参数:
Xsktime 兼容数据容器格式的时间序列

要转换的数据。

sktime 中的个体数据格式是所谓的 mtype 规范，每种 mtype 实现了一个抽象的 scitype。

  • Series scitype = 单个时间序列。pd.DataFrame, pd.Series 或 np.ndarray (1D 或 2D)

  • Panel scitype = 时间序列集合。pd.DataFrame 具有 2 级行 MultiIndex (instance, time), 3D np.ndarray (instance, variable, time), list 包含 Series 类型的 pd.DataFrame

  • Hierarchical scitype = 分层时间序列集合。pd.DataFrame 具有 3 级或更多行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)

有关数据格式的更多详细信息，请参阅关于 mtype 的术语表。有关用法，请参阅变换器教程 examples/03_transformers.ipynb

y可选，sktime 兼容数据格式的数据，默认=None

附加数据，例如用于变换的标签。某些变换器需要此项，请参阅类文档字符串了解详细信息。

返回:
X 的变换后版本
类型取决于 X 的类型和 scitype:transform-output 标签

转换 (transform)

X

-输出

返回类型

Series

Primitives

pd.DataFrame (1-row)

Panel

Primitives

pd.DataFrame

Series

Series

Series

Panel

Series

Panel

Series

Panel

Panel
返回中的实例对应于 X 中的实例
表格中未列出的组合目前不受支持
明确说明，附带示例

  • 如果 X 是 Series (例如，pd.DataFrame)

且 transform-output 是 Series，则返回相同 mtype 的单个 Series。示例：对单个序列进行去趋势

  • 如果 X 是 Panel (例如，pd-multiindex) 且 transform-output

是 Series，则返回与 X 具有相同数量实例的 Panel（变换器应用于每个输入的 Series 实例）。示例：面板中的所有序列都单独进行去趋势

  • 如果 X 是 Series 或 Panel 且 transform-output 是

Primitives，则返回一个 pd.DataFrame，其行数与 X 中的实例数相同。示例：返回的第 i 行包含第 i 个序列的均值和方差

  • 如果 X 是 Series 且 transform-output 是 Panel，

则返回一个类型为 pd-multiindex 的 Panel 对象。示例：输出的第 i 个实例是在 X 上运行的第 i 个窗口

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

用 X（可选 y）更新变换器。

所需状态

要求状态为“已拟合”。

在 self 中的访问

  • 以“_”结尾的已拟合模型属性。

  • self.is_fitted, 必须为 True

写入 self

  • 以“_”结尾的已拟合模型属性。

  • 如果 remember_data 标签为 True，则通过 update_data 将 X 中的值更新到 self._X 中。

参数:
Xsktime 兼容数据容器格式的时间序列

用于更新转换的数据

sktime 中的个体数据格式是所谓的 mtype 规范，每种 mtype 实现了一个抽象的 scitype。

  • Series scitype = 单个时间序列。pd.DataFrame, pd.Series 或 np.ndarray (1D 或 2D)

  • Panel scitype = 时间序列集合。pd.DataFrame 具有 2 级行 MultiIndex (instance, time), 3D np.ndarray (instance, variable, time), list 包含 Series 类型的 pd.DataFrame

  • Hierarchical scitype = 分层时间序列集合。pd.DataFrame 具有 3 级或更多行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)

有关数据格式的更多详细信息，请参阅关于 mtype 的术语表。有关用法，请参阅变换器教程 examples/03_transformers.ipynb

y可选，sktime 兼容数据格式的数据，默认=None

附加数据，例如用于变换的标签。某些变换器需要此项，请参阅类文档字符串了解详细信息。

返回:
self估计器的一个已拟合实例