ContractableBOSS

class ContractableBOSS(n_parameter_samples=250, max_ensemble_size=50, max_win_len_prop=1, min_window=10, time_limit_in_minutes=0.0, contract_max_n_parameter_samples=inf, save_train_predictions=False, feature_selection='none', n_jobs=1, random_state=None)

可收缩符号傅里叶近似符号袋 (cBOSS)。

实现了 Schäfer (2015) 的 BOSS Ensemble，并包含 Middlehurst、Vickers 和 Bagnall (2019) 描述的改进。[1, 2]_

概述：输入长度为“m”的“n”个序列，cBOSS 随机抽取 n_parameter_samples 参数集，并使用 LOOCV 评估每个参数集。然后保留准确率最高的 max_ensemble_size 个分类器。有三个主要参数：

• alpha：字母表大小

• w：窗口长度

• l：单词长度。

对于任何组合，单个 BOSS 都会沿着序列滑动长度为“w”的窗口。通过进行傅里叶变换并保留前 l/2 个复数系数，将长度为“w”的窗口缩短为长度为“l”的单词。然后将这些“l”个系数离散化为“alpha”个可能的值，形成长度为“l”的单词。为每个序列形成并存储一个单词直方图。

拟合涉及找到“n”个直方图。

预测使用带有定制 BOSS 距离函数的 1 最近邻。

参数:

n_parameter_samplesint, 默认 = 250

如果搜索是随机的，要尝试的参数组合数量。

max_ensemble_sizeint 或 None, 默认 = 50

保留的最大分类器数量。即使超过 max_ensemble_size 的分类器在阈值内，也会限制保留的分类器数量。

max_win_len_propint 或 float, 默认 = 1

最大窗口长度与序列长度的比例。

min_windowint, 默认 = 10

最小窗口大小。

time_limit_in_minutesint, 默认 = 0

时间约束，以分钟为单位限制构建时间。默认值为 0 表示没有限制。

contract_max_n_parameter_samplesint, 默认=np.inf

设置 time_limit_in_minutes 时要考虑的最大参数组合数量。

save_train_predictionsbool, 默认=False

在拟合（fit）时保存集成成员的训练预测，用于 _get_train_probs 留一法交叉验证。

n_jobsint, 默认 = 1

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

feature_selection: {“chi2”, “none”, “random”}, 默认: none

设置要使用的特征选择策略。Chi2 显著减少单词数量，因此速度更快（首选）。Random 也显著减少单词数量。None 不应用特征选择，并产生大的词袋，例如可能需要大量内存。

random_stateint 或 None, 默认=None

随机整数的种子。

属性:

n_classes_int

类别数量。从数据中提取。

classes_list

类别标签。

n_instances_int

实例数量。从数据中提取。

n_estimators_int

使用的最终分类器数量。如果指定了 max_ensemble_size，将小于等于 max_ensemble_size。

series_length_int

所有序列的长度（假定相等）。

estimators_list

DecisionTree 分类器列表。

weights_

集成中每个分类器的权重。

另请参阅

BOSSEnsemble, IndividualBOSS

注意

Java 版本请参见 TSML。

参考文献

[1]

Patrick Schäfer，“BOSS 关注存在噪声的时间序列分类”，Data Mining and Knowledge Discovery, 29(6): 2015 https://link.springer.com/article/10.1007/s10618-014-0377-7

[2]

Matthew Middlehurst, William Vickers 和 Anthony Bagnall，“用于时间序列分类的可扩展字典分类器”，收录于第 20 届智能数据工程与自动化学习国际会议论文集，LNCS，第 11871 卷 https://link.springer.com/chapter/10.1007/978-3-030-33607-3_2

示例

>>> from sktime.classification.dictionary_based import ContractableBOSS
>>> 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 = ContractableBOSS(
...     n_parameter_samples=10, max_ensemble_size=3
... ) 
>>> clf.fit(X_train, y_train) 
ContractableBOSS(...)
>>> 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()	获取自身的配置标志。
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])	将序列化的自身保存到字节类对象或 (.zip) 文件。
score(X, y)	在 X 上根据真实标签评估预测标签。
set_config(**config_dict)	将配置标志设置为给定值。
set_params(**params)	设置此对象的参数。
set_random_state([random_state, deep, ...])	为自身设置 random_state 伪随机种子参数。
set_tags(**tag_dict)	将实例级标签覆盖设置为给定值。

classmethod get_test_params(parameter_set='default')

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

参数:

parameter_setstr, 默认=”default”

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

返回:

paramsdict 或 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。

等同于构建 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)

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

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

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

clone_tags 从另一个对象 estimator 设置动态标签覆盖。

clone_tags 方法只能在对象的 __init__ 方法中，在构建期间或通过 __init__ 直接在构建后调用。

动态标签被设置为 estimator 中标签的值，其名称由 tag_names 指定。

tag_names 的默认值将 estimator 中的所有标签写入 self。

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

参数:

estimatorBaseObject 或其派生类的一个实例

tag_namesstr 或 str 列表, 默认 = None

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

返回:

self

对 self 的引用。

classmethod create_test_instance(parameter_set='default')

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

参数:

parameter_setstr, 默认=”default”

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

返回:

instance使用默认参数的类实例

classmethod create_test_instances_and_names(parameter_set='default')

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

参数:

parameter_setstr, 默认=”default”

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

返回:

objscls 实例列表

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

namesstr 列表，与 objs 长度相同

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

fit(X, y)

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

状态改变

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

写入自身

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

参数:

Xsktime 兼容的 Panel 科学类型的时间序列面板数据容器

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

可以是 Panel 科学类型的任何 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

并非所有评估器都支持具有多元或不等长序列的面板，详情请参阅标签参考。

ysktime 兼容的表格数据容器，Table 科学类型

1D 可迭代对象，形状为 [n_instances]，或 2D 可迭代对象，形状为 [n_instances, n_dimensions]，用于拟合的类标签。第 0 个索引对应于 X 中的实例索引，第 1 个索引（如果适用）对应于 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.is_fitted 设置为 True。设置以“_”结尾的已拟合模型属性。

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

参数:

Xsktime 兼容的 Panel 科学类型的时间序列面板数据容器

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

可以是 Panel 科学类型的任何 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

并非所有评估器都支持具有多元或不等长序列的面板，详情请参阅标签参考。

ysktime 兼容的表格数据容器，Table 科学类型

1D 可迭代对象，形状为 [n_instances]，或 2D 可迭代对象，形状为 [n_instances, n_dimensions]，用于拟合的类标签。第 0 个索引对应于 X 中的实例索引，第 1 个索引（如果适用）对应于 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 折交叉验证的样本外预测，并且如果 self 存在，则 random_state x 取自 self，否则 x=None

change_statebool, 可选 (默认=True)

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

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

返回:

y_predsktime 兼容的表格数据容器，Table 科学类型

预测的类别标签

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

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

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

fit_predict_proba(X, y, cv=None, change_state=True)

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

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

如果 change_state=True，则写入自身

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

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

参数:

Xsktime 兼容的 Panel 科学类型的时间序列面板数据容器

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

可以是 Panel 科学类型的任何 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

并非所有评估器都支持具有多元或不等长序列的面板，详情请参阅标签参考。

ysktime 兼容的表格数据容器，Table 科学类型

1D 可迭代对象，形状为 [n_instances]，或 2D 可迭代对象，形状为 [n_instances, n_dimensions]，用于拟合的类标签。第 0 个索引对应于 X 中的实例索引，第 1 个索引（如果适用）对应于 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 折交叉验证的样本外预测，并且如果 self 存在，则 random_state x 取自 self，否则 x=None

change_statebool, 可选 (默认=True)

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

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

返回:

y_pred2D np.array，int 类型，形状为 [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_default任意类型

如果找不到标签，则为默认/备用值。

返回:

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 的键值对，通常用作控制行为的瞬时标志。

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

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

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

classmethod get_param_defaults()

获取对象的默认参数。

返回:

default_dict: dict[str, Any]

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

classmethod 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 的单个标签的值，考虑标签覆盖，按以下降序优先级：

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

在实例构造时。

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

3. 在父类的 _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 设置的标签。

值是相应的标签值，覆盖顺序按以下降序优先级：

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

在实例构造时。

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

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

按继承顺序。

返回:

collected_tagsdict

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

is_composite()

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

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

返回:

composite: bool

对象的任何参数的值是否是 BaseObject 的后代实例。

property is_fitted

fit 是否已被调用。

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

返回:

bool

评估器是否已被 fit。

classmethod load_from_path(serial)

从文件位置加载对象。

参数:

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

返回:

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

classmethod load_from_serial(serial)

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

参数:

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

返回:

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

predict(X)

预测 X 中序列的标签。

参数:

Xsktime 兼容的 Panel 科学类型的时间序列面板数据容器

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

可以是 Panel 科学类型的任何 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_predsktime 兼容的表格数据容器，Table 科学类型

预测的类别标签

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

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

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

predict_proba(X)

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

参数:

Xsktime 兼容的 Panel 科学类型的时间序列面板数据容器

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

可以是 Panel 科学类型的任何 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_pred2D np.array，int 类型，形状为 [n_instances, n_classes]

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

reset()

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

结果是将 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')

将序列化的自身保存到字节类对象或 (.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, 默认 = “pickle”

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

返回:

如果 path 为 None - 内存中的序列化对象本身

如果 path 是文件位置 - ZipFile 引用该文件

score(X, y) → float

在 X 上根据真实标签评估预测标签。

参数:

Xsktime 兼容的 Panel 科学类型的时间序列面板数据容器

要计算其预测标签得分的时间序列。

可以是 Panel 科学类型的任何 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

并非所有评估器都支持具有多元或不等长序列的面板，详情请参阅标签参考。

ysktime 兼容的表格数据容器，Table 科学类型

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)

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

参数:

config_dictdict

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

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

jupyter 内核如何显示对象实例

• “diagram” = html 框图表示

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

print_changed_onlybool, 默认=True

打印对象实例时，是否只列出与默认值不同的自身参数，或列出所有参数名称和值。不嵌套，即只影响自身而不影响组件估计器。（*注：原始文本中的 (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，则抑制警告

返回:

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

根据 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)

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

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

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

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

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

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

参数:

**tag_dictdict

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

返回:

自身

对象的引用。