HIVECOTEV1#

class HIVECOTEV1(stc_params=None, tsf_params=None, rise_params=None, cboss_params=None, verbose=0, n_jobs=1, random_state=None)[source]#

分层投票集合变换基集成 (HIVE-COTE) V1。

使用 CAWPE 结构，将来自不同特征表示的 STC, TSF, RISE 和 cBOSS 分类器进行集成，如文献 [1] 所述。默认实现与文献 [1] 中描述的有所不同，STC 组件使用袋外错误 (OOB) 估计权重（如文献 [2] 所述），而不是交叉验证估计。OOB 速度快一个数量级，平均而言与 CV 一样好。这意味着此版本的 HIVE COTE 比 HC2 稍快，尽管平均准确率较低。

参数:

stc_paramsdict 或 None，默认=None: ShapeletTransformClassifier 模块的参数。如果为 None，则使用默认参数，变换契约时间为 2 小时。
tsf_paramsdict 或 None，默认=None: TimeSeriesForestClassifier 模块的参数。如果为 None，则使用默认参数，其中 n_estimators 设置为 500。
rise_paramsdict 或 None，默认=None: RandomIntervalSpectralForest 模块的参数。如果为 None，则使用默认参数，其中 n_estimators 设置为 500。
cboss_paramsdict 或 None，默认=None: ContractableBOSS 模块的参数。如果为 None，则使用默认参数。
verboseint，默认=0: 控制台打印的输出级别（仅供参考）。
n_jobsint，默认=1: fit 和 predict 并行运行的作业数。-1 表示使用所有处理器。
random_stateint 或 None，默认=None: 随机数生成的种子。

属性:

n_classes_int: 类别数量。
classes_list: 唯一的类别标签。
stc_weight_float: STC 概率的权重。
tsf_weight_float: TSF 概率的权重。
rise_weight_float: RISE 概率的权重。
cboss_weight_float: cBOSS 概率的权重。

另请参阅

HIVECOTEV2, ShapeletTransformClassifier, TimeSeriesForestClassifier
RandomIntervalSpectralForest, ContractableBOSS

注意

有关 Java 版本，请参阅 `https://github.com/uea-machine-learning/tsml/blob/master/src/main/java/ tsml/classifiers/hybrids/HIVE_COTE.java`_。

参考文献

[1] (1,2)

Anthony Bagnall, Michael Flynn, James Large, Jason Lines 和 Matthew Middlehurst。“关于基于变换的集成层次投票集合版本 1.0 (hive-cote v1.0) 的使用和性能” 2020 年先进分析和时间数据学习国际研讨会

[2]

Middlehurst, Matthew, James Large, Michael Flynn, Jason Lines, Aaron Bostrom, 和 Anthony Bagnall。“HIVE-COTE 2.0：时间序列分类的新元集成。” 机器学习 (2021)。

方法

`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`()	获取对象的配置标志。
`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`()	检查对象是否由其他 BaseObject 组成。
`load_from_path`(serial)	从文件位置加载对象。
`load_from_serial`(serial)	从序列化内存容器加载对象。
`predict`(X)	预测 X 中序列的标签。
`predict_proba`(X)	预测 X 中序列的标签概率。
`reset`()	将对象重置到初始化后的干净状态。
`save`([path, serialization_format])	将序列化的自身保存到字节类对象或到 (.zip) 文件中。
`score`(X, y)	针对 X 上的真实标签对预测标签进行评分。
`set_config`(**config_dict)	将配置标志设置为给定值。
`set_params`(**params)	设置此对象的参数。
`set_random_state`([random_state, deep, ...])	为自身设置 random_state 伪随机种子参数。
`set_tags`(**tag_dict)	将实例级别标签覆盖设置为给定值。

类方法 get_test_params(parameter_set='default')[源代码]#

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

参数:

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

返回值:

paramsdict 或 list of dict, 默认为 {}: 用于创建类的测试实例的参数。每个 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, 可选: 调用此函数的方法的名称。如果提供，错误消息将包含此信息。

引发:

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

clone()[源代码]#

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

克隆是另一个没有共享引用、处于初始化后状态的对象。此函数等效于返回 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)[源代码]#

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

每个兼容 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 的引用。

类方法 create_test_instance(parameter_set='default')[源代码]#

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

参数:

parameter_setstr, 默认为“default”: 要返回的测试参数集的名称，用于测试。如果未为值定义特殊参数，将返回 “default” 集。

返回值:

instance具有默认参数的类实例

类方法 create_test_instances_and_names(parameter_set='default')[源代码]#

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

参数:

parameter_setstr, 默认为“default”: 要返回的测试参数集的名称，用于测试。如果未为值定义特殊参数，将返回 “default” 集。

返回值:

objscls 实例列表: 第 i 个实例是 cls(**cls.get_test_params()[i])
nameslist of str, 与 objs 长度相同: 第 i 个元素是测试中 obj 的第 i 个实例的名称。如果实例多于一个，命名约定是 {cls.__name__}-{i}，否则是 {cls.__name__}。

fit(X, y)[源代码]#

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

状态改变: 状态改变为“已拟合”。
写入自身 (self): 将 self.is_fitted 设置为 True。设置以“_”结尾的已拟合模型属性。

参数:

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

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

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

pd-multiindex: pd.DataFrame，其中 columns = 变量，index = pd.MultiIndex，第一级 = 实例索引，第二级 = 时间索引
numpy3D: 3D np.array（任意维数，等长序列），形状为 [n_instances, n_dimensions, series_length]
或任何其他支持的 Panel mtype

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

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

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

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

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

返回值:

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，其中 columns = 变量，index = pd.MultiIndex，第一级 = 实例索引，第二级 = 时间索引
numpy3D: 3D np.array（任意维数，等长序列），形状为 [n_instances, n_dimensions, series_length]
或任何其他支持的 Panel mtype

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

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

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

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

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

cvNone, 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_statebool, 可选 (默认为 True)

如果为 False，则不会改变分类器的状态，即 fit/predict 序列使用副本运行，self 不改变。
如果为 True，则会将 self 拟合到完整的 X 和 y，最终状态等同于运行 fit(X, y)。

返回值:

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

预测的类标签

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

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

1D np.npdarray，如果 y 是一元的（一维）；否则，与 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，其中 columns = 变量，index = pd.MultiIndex，第一级 = 实例索引，第二级 = 时间索引
numpy3D: 3D np.array（任意维数，等长序列），形状为 [n_instances, n_dimensions, series_length]
或任何其他支持的 Panel mtype

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

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

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

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

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

cvNone, 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_statebool, 可选 (默认为 True)

如果为 False，则不会改变分类器的状态，即 fit/predict 序列使用副本运行，self 不改变。
如果为 True，则会将 self 拟合到完整的 X 和 y，最终状态等同于运行 fit(X, y)。

返回值:

y_pred2D np.array (int 类型), 形状为 [n_instances, n_classes]: 预测的类标签概率 0-th 索引对应于 X 中的实例索引 1-st 索引对应于类索引，顺序与 self.classes_ 中的顺序相同 entries 是预测的类概率，总和为 1。

类方法 get_class_tag(tag_name, tag_value_default=None)[源代码]#

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

每个兼容 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。

类方法 get_class_tags()[源代码]#

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

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

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

get_class_tags 方法是一个类方法，它仅考虑类级别标签值和覆盖，检索标签的值。

它返回一个字典，其键是类或其任何父类中设置的 _tags 属性的任何键。

值是相应的标签值，覆盖优先级从高到低如下：

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

按继承顺序。

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

要检索具有潜在实例覆盖的标签，请改用 get_tags 方法。

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

对于包含来自动态标签的覆盖，请使用 get_tags。

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

get_config()[源代码]#

获取对象的配置标志。

Configs 是 self 的键值对，通常用作控制行为的瞬态标志。

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

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

Configs 在 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] 等。

类方法 get_param_defaults()[源代码]#

获取对象的默认参数。

返回值:

default_dict: dict[str, Any]: 键是 cls 中在 __init__ 中定义了默认值的所有参数。值是在 __init__ 中定义的默认值。

类方法 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 的单个标签的值，考虑标签覆盖，优先级从高到低如下：

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

在实例构造时。

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

值是相应的标签值，覆盖优先级从高到低如下：

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

在实例构造时。

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

按继承顺序。

返回值:

collected_tagsdict: 标签名称：标签值对的字典。通过嵌套继承从 _tags 类属性收集，然后从 _tags_dynamic 对象属性收集任何覆盖和新标签。

is_composite()[源代码]#

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

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

返回值:

composite: bool: 对象是否有任何参数的值是 BaseObject 的派生实例。

属性 is_fitted[源代码]#

fit 是否已被调用。

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

返回值:

bool: 估计器是否已 fit。

类方法 load_from_path(serial)[源代码]#

从文件位置加载对象。

参数:

serialZipFile(path).open(“object) 的结果

返回值:

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

类方法 load_from_serial(serial)[源代码]#

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

参数:

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

返回值:

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

predict(X)[源代码]#

预测 X 中序列的标签。

参数:

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

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

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

pd-multiindex: pd.DataFrame，其中 columns = 变量，index = 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_predsktime 兼容的表格数据容器，Table scitype

预测的类标签

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

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

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

predict_proba(X)[源代码]#

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

参数:

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

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

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

pd-multiindex: pd.DataFrame，其中 columns = 变量，index = 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_pred2D np.array (int 类型), 形状为 [n_instances, n_classes]: 预测的类标签概率 0-th 索引对应于 X 中的实例索引 1-st 索引对应于类索引，顺序与 self.classes_ 中的顺序相同 entries 是预测的类概率，总和为 1。

reset()[源代码]#

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

结果是将 self 设置为其在构造函数调用后立即所处的状态，具有相同的超参数。通过 set_config 设置的配置值也会保留。

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

超参数 = __init__ 的参数，写入 self，例如 self.paramname，其中 paramname 是 __init__ 的一个参数。
包含双下划线的对象属性，即字符串“__”。例如，名为“__myattr”的属性将保留。
config 属性，配置不变地保留。即 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，则返回内存中的序列化自身；如果 path 是文件位置，则将自身以 zip 文件形式存储在该位置。

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

参数:

pathNone 或文件位置 (str 或 Path)

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

path=”estimator”，则将在当前工作目录 (cwd) 下创建 zip 文件 estimator.zip。
path=”/home/stored/estimator”，则将在

存储在 /home/stored/ 中。

serialization_format: str, 默认为 “pickle”

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

返回值:

如果 path 为 None - 内存中的序列化自身
如果 path 是文件位置 - 引用该文件的 ZipFile

score(X, y) → float[源代码]#

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

参数:

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

用于对预测标签进行评分的时间序列。

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

pd-multiindex: pd.DataFrame，其中 columns = 变量，index = pd.MultiIndex，第一级 = 实例索引，第二级 = 时间索引
numpy3D: 3D np.array（任意维数，等长序列），形状为 [n_instances, n_dimensions, series_length]
或任何其他支持的 Panel mtype

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

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

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

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

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

返回值:

float，predict(X) 对 y 的准确率得分。

set_config(**config_dict)[源代码]#

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

参数:

config_dictdict

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

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

jupyter 内核如何显示 self 的实例

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

print_changed_onlybool, 默认为 True

打印 self 时是仅列出自参数与默认值不同的参数 (True)，还是列出所有参数名称和值 (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对自身的引用。

注意

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

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

设置此对象的参数。

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

参数:

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

返回值:

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 从链式哈希中采样，并保证种子随机生成器的伪随机独立性。

仅当 deep=True 时，根据 self_policy 应用于 self 中的 random_state 参数以及其余组件对象。

注意：即使 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)[源代码]#

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

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

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

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

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

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

参数:

**tag_dictdict: 标签名称：标签值对的字典。

返回值:

Self: 对自身的引用。