SupervisedTimeSeriesForest#

class SupervisedTimeSeriesForest(n_estimators=200, n_jobs=1, random_state=None)[source]#

监督时间序列森林 (STSF)。

基于通过监督过程选择的间隔构建的决策树集成，如 _[1] 中所述。概述：输入长度为 m 的 n 条序列 对于每棵树

  • 使用类别平衡的装袋（bagging）对 X 进行采样

  • 使用监督

  • 方法对所有 3 种表示和 7 种特征的间隔进行采样

  • 使用其对应的间隔找到均值、中位数、标准差、斜率、四分位距、最小值和最大值

  • 针对每种表示，串联形成新的数据集

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

对树进行集成，使用平均概率估计。

参数：
n_estimators：int，默认为 200

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

n_jobs：int，默认为 1

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

random_state：int 或 None，默认为 None

随机数生成种子。

属性：
n_classes_：int

类别数量。

n_instances_：int

训练样本数量。

series_length_：int

每条序列的长度。

classes_：list

类别标签。

intervals：形状为 [n_estimators][3][7][n_intervals][2] 的类数组

存储所有估计器的所有起始点和结束点的索引。每个估计器包含每种表示和特征组合的索引。

estimators_：形状为 (n_estimators) 的 DecisionTreeClassifier 列表

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

注意

Java 版本参见 `TSML `_。

java/tsml/classifiers/interval_based/STSF.java>`_。

参考文献

[1]

Cabello, Nestor, et al. “通过监督间隔搜索实现的快速准确时间序列分类。” IEEE ICDM 2020

示例

>>> from sktime.classification.interval_based import SupervisedTimeSeriesForest
>>> 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 = SupervisedTimeSeriesForest(n_estimators=5)
>>> clf.fit(X_train, y_train)
SupervisedTimeSeriesForest(n_estimators=5)
>>> 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')[source]#

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

参数：
parameter_set：str，默认为 “default”

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

返回：
params：dict 或 dict 列表，默认为 {}

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

check_is_fitted(method_name=None)[source]#

检查估计器是否已拟合。

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

如果不是，则引发 NotFittedError。

参数：
method_name：str，可选

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

引发：
NotFittedError

如果估计器尚未拟合。

clone()[source]#

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

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

等同于使用 self 的参数构造 type(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：BaseObject 或派生类的实例
tag_names：str 或 str 列表，默认为 None

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

返回：
self

对 self 的引用。

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

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

参数：
parameter_set：str，默认为 “default”

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

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

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

参数：
parameter_set：str，默认为 “default”

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

返回：
objs：cls 实例列表

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

names：str 列表，与 objs 长度相同

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

fit(X, y)[source]#

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

状态变化

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

写入 self

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

参数：
X：sktime 兼容的时间序列面板数据容器，Panel scitype 类型

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

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

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

  • numpy3D：3D np.array（任意维度，等长序列），形状为 [n_instances, n_dimensions, series_length]

  • 或任何其他支持的 Panel mtype

有关 mtype 列表，请参阅 datatypes.SCITYPE_REGISTER

有关规范，请参阅 examples/AA_datatypes_and_datasets.ipynb

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

y：sktime 兼容的表格数据容器，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)[source]#

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

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

如果 change_state=True，则写入 self

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

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

参数：
X：sktime 兼容的时间序列面板数据容器，Panel scitype 类型

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

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

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

  • numpy3D：3D np.array（任意维度，等长序列），形状为 [n_instances, n_dimensions, series_length]

  • 或任何其他支持的 Panel mtype

有关 mtype 列表，请参阅 datatypes.SCITYPE_REGISTER

有关规范，请参阅 examples/AA_datatypes_and_datasets.ipynb

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

y：sktime 兼容的表格数据容器，Table scitype 类型

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

cv：None、int 或 sklearn 交叉验证对象，可选，默认为 None

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

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

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

change_state：bool，可选（默认为 True）

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

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

返回：
y_pred：sktime 兼容的表格数据容器，Table scitype 类型

预测的类别标签

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

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

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

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

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

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

如果 change_state=True，则写入 self

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

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

参数：
X：sktime 兼容的时间序列面板数据容器，Panel scitype 类型

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

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

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

  • numpy3D：3D np.array（任意维度，等长序列），形状为 [n_instances, n_dimensions, series_length]

  • 或任何其他支持的 Panel mtype

有关 mtype 列表，请参阅 datatypes.SCITYPE_REGISTER

有关规范，请参阅 examples/AA_datatypes_and_datasets.ipynb

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

y：sktime 兼容的表格数据容器，Table scitype 类型

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

cv：None、int 或 sklearn 交叉验证对象，可选，默认为 None

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

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

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

change_state：bool，可选（默认为 True）

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

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

返回：
y_pred：2D np.array，整型，形状为 [n_instances, n_classes]

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

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_name：str

标签值的名称。

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_tags：dict

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

get_config()[source]#

获取 self 的配置标志。

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

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

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

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

返回：
config_dict：dict

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

get_fitted_params(deep=True)[source]#

获取拟合参数。

所需状态

要求状态为“已拟合”。

参数：
deep：bool，默认为 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()[source]#

获取对象的默认参数。

返回：
default_dict: dict[str, Any]

键是 cls 中在 __init__ 中定义了默认值的所有参数。值是在 __init__ 中定义的默认值。

classmethod get_param_names(sort=True)[source]#

获取对象的参数名称。

参数：
sort：bool，默认为 True

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

返回：
param_names: list[str]

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

get_params(deep=True)[source]#

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

参数：
deep：bool，默认为 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)[source]#

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

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

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

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

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

在实例构造时设置。

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

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

按继承顺序排列。

参数：
tag_name：str

要检索的标签名称

tag_value_default：任意类型，可选；默认为 None

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

raise_error：bool

当未找到标签时是否引发 ValueError

返回：
tag_value：Any

self 中 tag_name 标签的值。如果未找到，并且 raise_error 为 True，则引发 ValueError，否则返回 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_tags：dict

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

从文件位置加载对象。

参数：
serial：ZipFile(path).open(“object”) 的结果
返回：
反序列化的 self，其结果是 cls.save(path) 在 path 的输出
classmethod load_from_serial(serial)[source]#

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

参数：
serial：cls.save(None) 输出的第一个元素
返回：
反序列化的 self，其结果是 cls.save(None) 的输出 serial
predict(X)[source]#

预测 X 中的序列的标签。

参数：
X：sktime 兼容的时间序列面板数据容器，Panel scitype 类型

要预测标签的时间序列。

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

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

  • numpy3D：3D np.array（任意维度，等长序列），形状为 [n_instances, n_dimensions, series_length]

  • 或任何其他支持的 Panel mtype

有关 mtype 列表，请参阅 datatypes.SCITYPE_REGISTER

有关规范，请参阅 examples/AA_datatypes_and_datasets.ipynb

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

返回：
y_pred：sktime 兼容的表格数据容器，Table scitype 类型

预测的类别标签

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

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

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

predict_proba(X)[source]#

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

参数：
X：sktime 兼容的时间序列面板数据容器，Panel scitype 类型

要预测标签的时间序列。

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

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

  • numpy3D：3D np.array（任意维度，等长序列），形状为 [n_instances, n_dimensions, series_length]

  • 或任何其他支持的 Panel mtype

有关 mtype 列表，请参阅 datatypes.SCITYPE_REGISTER

有关规范，请参阅 examples/AA_datatypes_and_datasets.ipynb

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

返回：
y_pred：2D np.array，整型，形状为 [n_instances, n_classes]

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

reset()[source]#

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

将 self 设置为构造函数调用后直接处于的状态，具有相同的超参数。set_config 设置的配置值也会保留。

reset 调用删除所有对象属性，除了

  • hyper-parameters = `__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')[源代码]#

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

行为：如果 `path` 为 None，则返回内存中的序列化自身；如果 `path` 是文件位置，则将自身存储在该位置为一个zip文件

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

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

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

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

  • 如果 path=”/home/stored/estimator”，则 zip 文件 `estimator.zip` 将被

存储在 `/home/stored/` 中。

serialization_format: str, default = “pickle”

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

返回：
如果 `path` 为 None - 内存中的序列化自身
如果 `path` 是文件位置 - 引用该文件的 ZipFile
score(X, y) → float[源代码]#

根据地面真实标签评估 X 上的预测标签。

参数：
X：sktime 兼容的时间序列面板数据容器，Panel scitype 类型

需要评估其预测标签的时间序列。

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

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

  • numpy3D：3D np.array（任意维度，等长序列），形状为 [n_instances, n_dimensions, series_length]

  • 或任何其他支持的 Panel mtype

有关 mtype 列表，请参阅 datatypes.SCITYPE_REGISTER

有关规范，请参阅 examples/AA_datatypes_and_datasets.ipynb

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

y：sktime 兼容的表格数据容器，Table scitype 类型

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

返回：
浮点数，predict(X) 与 y 的准确率得分。
set_config(**config_dict)[源代码]#

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

参数：
config_dict：dict

配置名 : 配置值 对的字典。有效的配置、值及其含义列在下方

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

jupyter kernel 如何显示自身实例

  • “diagram” = html 框图表示

  • “text” = 字符串输出

print_changed_onlybool, default=True

打印自身时是否仅列出与默认值不同的自身参数（False），还是列出所有参数名称和值（False）。不嵌套，即仅影响自身，不影响组件估计器。

warningsstr, “on” (默认值), 或 “off”

是否引发警告，仅影响来自 sktime 的警告

  • “on” = 将引发来自 sktime 的警告

  • “off” = 将不引发来自 sktime 的警告

backend:parallelstr, 可选, default=”None”

广播/向量化时用于并行化的后端，其中之一

  • “None”: 按顺序执行循环，简单的列表推导

  • “loky”, “multiprocessing” 和 “threading”: 使用 `joblib.Parallel`

  • “joblib”: 自定义和第三方 `joblib` 后端，例如 `spark`

  • “dask”: 使用 `dask`，需要环境中安装 `dask` 包

  • “ray”: 使用 `ray`，需要环境中安装 `ray` 包

backend:parallel:paramsdict, 可选, default={} (不传递参数)

作为配置传递给并行化后端的附加参数。有效的键取决于 `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, default=True; False 可防止 `ray` 在

      并行化后关闭。

    • “logger_name”: str, default=”ray”; 要使用的日志记录器名称。

    • “mute_warnings”: bool, default=False; 如果为 True，则抑制警告

返回：
self自身引用。

注意

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

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

设置此对象的参数。

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

参数：
**paramsdict

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

返回：
self对自身的引用（设置参数后）
set_random_state(random_state=None, deep=True, self_policy='copy')[源代码]#

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

通过 `self.get_params` 查找名为 `random_state` 的参数，并通过 `set_params` 将它们设置为从 `random_state` 导出的整数。这些整数通过 `sample_dependent_seed` 从链式哈希中采样，保证种子随机生成器之间的伪随机独立性。

适用于 `self` 中的 `random_state` 参数（取决于 `self_policy`），以及剩余的组件对象，当且仅当 `deep=True` 时。

注意：即使 `self` 没有 `random_state`，或者没有任何组件有 `random_state` 参数，也会调用 `set_params`。因此，`set_random_state` 将重置任何 `scikit-base` 对象，即使是那些没有 `random_state` 参数的对象。

参数：
random_stateint, RandomState 实例或 None, default=None

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

deep：bool，默认为 True

是否在值为 skbase 对象的参数中设置随机状态，即组件估计器。

  • 如果为 False，则仅设置自身的 `random_state` 参数（如果存在）。

  • 如果为 True，也将设置组件对象中的 `random_state` 参数。

self_policystr, 选项之一 {“copy”, “keep”, “new”}, default=”copy”

  • “copy” : `self.random_state` 被设置为输入的 `random_state`

  • “keep” : `self.random_state` 保持原样

  • “new” : `self.random_state` 被设置为一个新的随机状态，

从输入的 `random_state` 导出，通常与它不同

返回：
self自身引用
set_tags(**tag_dict)#

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

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

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

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

set_tags 方法应仅在对象的 `__init__` 方法中调用，在构造期间，或通过 `__init__` 直接在构造后调用。

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

参数：
**tag_dictdict

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

返回：
Self

自身引用。