CanonicalIntervalForest#

class CanonicalIntervalForest(n_estimators=200, n_intervals=None, att_subsample_size=8, min_interval=3, max_interval=None, base_estimator='CIT', n_jobs=1, random_state=None)[来源]#

Canonical Interval Forest 分类器 (CIF)。

实现基于区间的森林，利用 Middlehurst 等人 (2020) 描述的随机选择区间上的 catch22 特征集。[1]

概述：输入长度为“m”的“d”维“n”个序列。对于每棵树

  • 随机选择 n_intervals 个随机位置和长度的区间

  • 随机抽取 att_subsample_size 个 catch22 或统计摘要属性

  • 为每个区间随机选择维度

  • 计算每个区间的属性，连接形成新的数据集

  • 在新数据集上构建决策树

集成树并平均概率估计值

参数:
n_estimatorsint, default=200

集成中构建的估计器数量。

n_intervalsint or None, default=None

每棵树提取的区间数量，如果为 None，则提取 (sqrt(series_length) * sqrt(n_dims)) 个区间。

att_subsample_sizeint, default=8

每棵树抽样的 catch22 或统计摘要属性数量。

min_intervalint, default=3

区间的最小长度。

max_intervalint or None, default=None

区间的最大长度，如果为 None，则设置为 (series_length / 2)。

base_estimatorBaseEstimator or str, default=”DTC”

集成的基础估计器，可以是 sklearn BaseEstimator 或表示建议选项的字符串。“DTC”使用 sklearn DecisionTreeClassifier，以熵作为分裂度量。“CIT”使用 sktime ContinuousIntervalTree，它是原始树的实现，嵌入属性处理以加快预测速度。

n_jobsint, default=1

fit 和 predict 并行运行的作业数量。-1 表示使用所有处理器。

random_stateint or None, default=None

随机数生成的种子。

属性:
n_classes_int

类别数量。

n_instances_int

训练样本数量。

n_dims_int

每个样本的维度数量。

series_length_int

每个序列的长度。

classes_list

类别标签。

estimators_list of shape (n_estimators) of BaseEstimator

在 fit 中训练的估计器集合。

intervals_list of shape (n_estimators) of ndarray with shape (n_intervals,2)

存储所有分类器每个区间起始点和结束点的索引。

atts_list of shape (n_estimators) of array with shape (att_subsample_size)

所有分类器抽样的 catch22 或统计摘要属性的索引。

dims_list of shape (n_estimators) of array with shape (n_intervals)

所有分类器从中提取属性的维度。

参见

DrCIF

注意

Java 版本参见 TSML。

参考文献

[1]

Matthew Middlehurst and James Large and Anthony Bagnall. “The Canonical Interval Forest (CIF) Classifier for Time Series Classification.” IEEE International Conference on Big Data 2020

示例

>>> from sktime.classification.interval_based import CanonicalIntervalForest
>>> from sktime.datasets import load_unit_test
>>> X_train, y_train = load_unit_test(split="train", return_X_y=True)
>>> X_test, y_test = load_unit_test(split="test", return_X_y=True) 
>>> clf = CanonicalIntervalForest(
...     n_estimators=3, n_intervals=2, att_subsample_size=2
... ) 
>>> clf.fit(X_train, y_train) 
CanonicalIntervalForest(...)
>>> y_pred = clf.predict(X_test)

方法

check_is_fitted([method_name])

检查估计器是否已拟合。

clone()

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

clone_tags(estimator[, tag_names])

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

create_test_instance([parameter_set])

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

create_test_instances_and_names([parameter_set])

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

fit(X, y)

将时间序列分类器拟合到训练数据。

fit_predict(X, y[, cv, change_state])

拟合并预测 X 中序列的标签。

fit_predict_proba(X, y[, cv, change_state])

拟合并预测 X 中序列的标签概率。

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([parameter_set])

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

is_composite()

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

load_from_path(serial)

从文件位置加载对象。

load_from_serial(serial)

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

predict(X)

预测 X 中序列的标签。

predict_proba(X)

预测 X 中序列的标签概率。

reset()

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

save([path, serialization_format])

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

score(X, y)

对 X 上的预测标签与真实标签进行评分。

set_config(**config_dict)

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

set_params(**params)

设置此对象的参数。

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

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

set_tags(**tag_dict)

将实例级标签覆盖设置为给定值。
classmethod get_test_params(parameter_set='default')[来源]#

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

参数:
parameter_setstr, default=”default”

要返回的测试参数集的名称，用于测试。如果某个值没有定义特殊参数，则返回 "default" 集。对于分类器，应提供一组“default”参数用于一般测试，以及一组“results_comparison”参数用于与先前记录的结果进行比较，如果一般参数集无法产生适合比较的概率。

返回:
paramsdict or list of dict, default={}

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

check_is_fitted(method_name=None)[来源]#

检查估计器是否已拟合。

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

如果不是，则引发 NotFittedError。

参数:
method_namestr, optional

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

引发:
NotFittedError

如果估计器尚未拟合。

clone()[来源]#

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

副本是一个不同的对象，没有共享引用，处于初始化后状态。此函数等同于返回 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。

引发:
如果副本不符合要求，则抛出 RuntimeError，原因可能是 __init__ 存在问题。
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 or list of str, default = None

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

返回:
self

对 self 的引用。

classmethod create_test_instance(parameter_set='default')[来源]#

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

参数:
parameter_setstr, default=”default”

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

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

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

参数:
parameter_setstr, default=”default”

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

返回:
objscls 实例列表

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

namesstr 列表，与 objs 长度相同

第 i 个元素是测试中 objs 中第 i 个实例的名称。命名约定为 {cls.__name__}-{i} (如果实例多于一个) 或 {cls.__name__} (如果实例只有一个)。

fit(X, y)[来源]#

将时间序列分类器拟合到训练数据。

状态改变

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

写入 self

将 self.is_fitted 设置为 True。设置以“_”结尾的拟合模型属性。

参数:
Xsktime 兼容的时间序列面板数据容器，Panel scitype

用于拟合估计器的时间序列。

可以是 Panel scitype 的任何 mtype，例如

  • pd-multiindex: pd.DataFrame，列为变量，索引为 pd.MultiIndex，第一级为实例索引，第二级为时间索引

  • numpy3D: 形状为 [n_instances, n_dimensions, series_length] 的 3D np.array (任意维数，等长序列)

  • 或任何其他支持的 Panel mtype

mtypes 列表参见 datatypes.SCITYPE_REGISTER

规范参见 examples/AA_datatypes_and_datasets.ipynb

并非所有估计器都支持多变量或不等长序列的面板，详情参见标签参考。

ysktime 兼容的表格数据容器，Table scitype

1D 可迭代对象，形状为 [n_instances] 或 2D 可迭代对象，形状为 [n_instances, n_dimensions] 用于拟合的类别标签 第 0 个索引对应于 X 中的实例索引 第 1 个索引（如果适用）对应于 X 中的多输出向量索引 支持的 sktime 类型：np.ndarray (1D, 2D), pd.Series, pd.DataFrame

返回:
self对 self 的引用。
fit_predict(X, y, cv=None, change_state=True)[来源]#

拟合并预测 X 中序列的标签。

生成样本内预测和交叉验证样本外预测的便利方法。

如果 change_state=True，则写入 self

将 self.is_fitted 设置为 True。设置以“_”结尾的拟合模型属性。

如果 change_state=False，则不更新状态。

参数:
Xsktime 兼容的时间序列面板数据容器，Panel scitype

用于拟合和预测标签的时间序列。

可以是 Panel scitype 的任何 mtype，例如

  • pd-multiindex: pd.DataFrame，列为变量，索引为 pd.MultiIndex，第一级为实例索引，第二级为时间索引

  • numpy3D: 形状为 [n_instances, n_dimensions, series_length] 的 3D np.array (任意维数，等长序列)

  • 或任何其他支持的 Panel mtype

mtypes 列表参见 datatypes.SCITYPE_REGISTER

规范参见 examples/AA_datatypes_and_datasets.ipynb

并非所有估计器都支持多变量或不等长序列的面板，详情参见标签参考。

ysktime 兼容的表格数据容器，Table scitype

1D 可迭代对象，形状为 [n_instances] 或 2D 可迭代对象，形状为 [n_instances, n_dimensions] 用于拟合的类别标签 第 0 个索引对应于 X 中的实例索引 第 1 个索引（如果适用）对应于 X 中的多输出向量索引 支持的 sktime 类型：np.ndarray (1D, 2D), pd.Series, pd.DataFrame

cvNone, int, or sklearn cross-validation object, optional, default=None

  • None：预测是样本内的，等同于 fit(X, y).predict(X)

  • cv：预测等同于 fit(X_train, y_train).predict(X_test)，其中从 cv 折中获得多个 X_train、y_train、X_test。返回的 y 是所有测试折预测的并集，cv 测试折必须不相交

  • int：等同于 cv=KFold(cv, shuffle=True, random_state=x)，即样本外的 k-折交叉验证预测，其中 random_state x 从 self 获取（如果存在），否则 x=None

change_statebool, optional (default=True)

  • 如果为 False，则不会改变分类器的状态，即使用副本运行拟合/预测序列，self 不会改变

  • 如果为 True，则将 self 拟合到完整的 X 和 y，结束状态将等同于运行 fit(X, y)

返回:
y_predsktime 兼容的表格数据容器，Table scitype

预测的类别标签

1D 可迭代对象，形状为 [n_instances]，或 2D 可迭代对象，形状为 [n_instances, n_dimensions]。

第 0 个索引对应于 X 中的实例索引，第 1 个索引（如果适用）对应于 X 中的多输出向量索引。

如果 y 是单变量（一维），则为 1D np.npdarray；否则，与 fit 中传入的 y 类型相同

fit_predict_proba(X, y, cv=None, change_state=True)[来源]#

拟合并预测 X 中序列的标签概率。

生成样本内预测和交叉验证样本外预测的便利方法。

如果 change_state=True，则写入 self

将 self.is_fitted 设置为 True。设置以“_”结尾的拟合模型属性。

如果 change_state=False，则不更新状态。

参数:
Xsktime 兼容的时间序列面板数据容器，Panel scitype

用于拟合和预测标签的时间序列。

可以是 Panel scitype 的任何 mtype，例如

  • pd-multiindex: pd.DataFrame，列为变量，索引为 pd.MultiIndex，第一级为实例索引，第二级为时间索引

  • numpy3D: 形状为 [n_instances, n_dimensions, series_length] 的 3D np.array (任意维数，等长序列)

  • 或任何其他支持的 Panel mtype

mtypes 列表参见 datatypes.SCITYPE_REGISTER

规范参见 examples/AA_datatypes_and_datasets.ipynb

并非所有估计器都支持多变量或不等长序列的面板，详情参见标签参考。

ysktime 兼容的表格数据容器，Table scitype

1D 可迭代对象，形状为 [n_instances] 或 2D 可迭代对象，形状为 [n_instances, n_dimensions] 用于拟合的类别标签 第 0 个索引对应于 X 中的实例索引 第 1 个索引（如果适用）对应于 X 中的多输出向量索引 支持的 sktime 类型：np.ndarray (1D, 2D), pd.Series, pd.DataFrame

cvNone, int, or sklearn cross-validation object, optional, default=None

  • None：预测是样本内的，等同于 fit(X, y).predict(X)

  • cv：预测等同于 fit(X_train, y_train).predict(X_test)，其中从 cv 折中获得多个 X_train、y_train、X_test。返回的 y 是所有测试折预测的并集，cv 测试折必须不相交

  • int：等同于 cv=KFold(cv, shuffle=True, random_state=x)，即样本外的 k-折交叉验证预测，其中 random_state x 从 self 获取（如果存在），否则 x=None

change_statebool, optional (default=True)

  • 如果为 False，则不会改变分类器的状态，即使用副本运行拟合/预测序列，self 不会改变

  • 如果为 True，则将 self 拟合到完整的 X 和 y，结束状态将等同于运行 fit(X, y)

返回:
y_pred2D np.array of int, of shape [n_instances, n_classes]

预测的类别标签概率 第 0 个索引对应于 X 中的实例索引 第 1 个索引对应于类别索引，顺序与 self.classes_ 中的相同 条目为预测类别概率，总和为 1

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_defaultany type

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

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

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

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

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

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

返回:
config_dictdict

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

get_fitted_params(deep=True)[来源]#

获取拟合参数。

所需状态

要求状态为“已拟合”。

参数:
deepbool, default=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, default=True

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

返回:
param_names: list[str]

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

get_params(deep=True)[来源]#

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

参数:
deepbool, default=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_defaultany type, optional; default=None

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

raise_errorbool

当未找到标签时是否抛出 ValueError

返回:
tag_valueAny

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

引发:
ValueError, 如果 raise_error 为 True。

ValueError 在 tag_name 不在 self.get_tags().keys() 中时抛出。

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

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

参数:
serialcls.save(None) 输出的第一个元素
返回:
由 cls.save(None) 生成的 serial 输出中的反序列化后的 self。
predict(X)[source]#

预测 X 中序列的标签。

参数:
Xsktime 兼容的时间序列面板数据容器，Panel scitype

要预测标签的时间序列。

可以是 Panel scitype 的任何 mtype，例如

  • pd-multiindex: pd.DataFrame，列为变量，索引为 pd.MultiIndex，第一级为实例索引，第二级为时间索引

  • numpy3D: 形状为 [n_instances, n_dimensions, series_length] 的 3D np.array (任意维数，等长序列)

  • 或任何其他支持的 Panel mtype

mtypes 列表参见 datatypes.SCITYPE_REGISTER

规范参见 examples/AA_datatypes_and_datasets.ipynb

并非所有估计器都支持多变量或不等长序列的面板，详情参见标签参考。

返回:
y_predsktime 兼容的表格数据容器，Table scitype

预测的类别标签

1D 可迭代对象，形状为 [n_instances]，或 2D 可迭代对象，形状为 [n_instances, n_dimensions]。

第 0 个索引对应于 X 中的实例索引，第 1 个索引（如果适用）对应于 X 中的多输出向量索引。

如果 y 是单变量（一维），则为 1D np.npdarray；否则，与 fit 中传入的 y 类型相同

predict_proba(X)[source]#

预测 X 中序列的标签概率。

参数:
Xsktime 兼容的时间序列面板数据容器，Panel scitype

要预测标签的时间序列。

可以是 Panel scitype 的任何 mtype，例如

  • pd-multiindex: pd.DataFrame，列为变量，索引为 pd.MultiIndex，第一级为实例索引，第二级为时间索引

  • numpy3D: 形状为 [n_instances, n_dimensions, series_length] 的 3D np.array (任意维数，等长序列)

  • 或任何其他支持的 Panel mtype

mtypes 列表参见 datatypes.SCITYPE_REGISTER

规范参见 examples/AA_datatypes_and_datasets.ipynb

并非所有估计器都支持多变量或不等长序列的面板，详情参见标签参考。

返回:
y_pred2D np.array of int, of shape [n_instances, n_classes]

预测的类别标签概率，第 0 个索引对应于 X 中的实例索引，第 1 个索引对应于类别索引，顺序与 self.classes_ 中的条目相同，这些条目是预测的类别概率，总和为 1。

reset()[source]#

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

将 self 重置为其在构造函数调用之后直接拥有的状态，保留相同的超参数。通过 set_config 设置的配置值也会保留。

reset 调用会删除任何对象属性，除了

  • 超参数 = __init__ 的参数，写入 self，例如 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，则返回内存中的序列化 self；如果 path 是文件位置，则将 self 存储在该位置作为 zip 文件。

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

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

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

  • path=”estimator” 则会在当前工作目录下生成一个 zip 文件 estimator.zip。

  • path=”/home/stored/estimator” 则会在 /home/stored/ 中存储一个 zip 文件

estimator.zip。

serialization_format: str, 默认 = “pickle”

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

返回:
如果 path 为 None - 内存中的序列化 self
如果 path 为文件位置 - 引用该文件的 ZipFile
score(X, y) → float[source]#

对 X 上的预测标签与真实标签进行评分。

参数:
Xsktime 兼容的时间序列面板数据容器，Panel scitype

要评分预测标签的时间序列。

可以是 Panel scitype 的任何 mtype，例如

  • pd-multiindex: pd.DataFrame，列为变量，索引为 pd.MultiIndex，第一级为实例索引，第二级为时间索引

  • numpy3D: 形状为 [n_instances, n_dimensions, series_length] 的 3D np.array (任意维数，等长序列)

  • 或任何其他支持的 Panel mtype

mtypes 列表参见 datatypes.SCITYPE_REGISTER

规范参见 examples/AA_datatypes_and_datasets.ipynb

并非所有估计器都支持多变量或不等长序列的面板，详情参见标签参考。

ysktime 兼容的表格数据容器，Table scitype

1D 可迭代对象，形状为 [n_instances] 或 2D 可迭代对象，形状为 [n_instances, n_dimensions] 用于拟合的类别标签 第 0 个索引对应于 X 中的实例索引 第 1 个索引（如果适用）对应于 X 中的多输出向量索引 支持的 sktime 类型：np.ndarray (1D, 2D), pd.Series, pd.DataFrame

返回:
float，predict(X) 与 y 相比的准确率得分。
set_config(**config_dict)[source]#

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

参数:
config_dictdict

配置名称：配置值对的字典。下面列出了有效的配置、值及其含义。

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

Jupyter 内核如何显示 self 的实例

  • “diagram” = html 框图表示

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

print_changed_onlybool, 默认=True

打印 self 时是只列出与默认值不同的 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)[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]#

为 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, default=True

deep: bool, 默认=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 的引用

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

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

set_tags(**tag_dict)[source]#

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

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

当前的标签值可以通过 get_tags 或 get_tag 进行检查。

参数:
set_tags 方法应仅在对象的 __init__ 方法中（构造期间）或通过 __init__ 直接在构造后调用。

**tag_dictdict

返回:
标签名称：标签值对的字典。

Self