MVTSTransformerClassifier

class MVTSTransformerClassifier(d_model=256, n_heads=4, num_layers=4, dim_feedforward=128, dropout=0.1, pos_encoding='fixed', activation='relu', norm='BatchNorm', freeze=False, num_epochs=10, batch_size=8, criterion=None, criterion_kwargs=None, optimizer=None, optimizer_kwargs=None, lr=0.001, verbose=True, random_state=None)

用于分类的多元时间序列 Transformer，如 [1] 中所述。

此分类器封装了 Transformer 的官方 PyTorch 实现（来自 [Rd7b568e6af84-2]），该实现由论文 [1] 的作者提供。

参数:

d_modelint, 可选 (默认=256)

输入中预期的特征数量（即模型的维度）。

n_headsint, 可选 (默认=4)

多头注意力机制中的头数量。

num_layersint, 可选 (默认=4)

Transformer 编码器中的层（或块）数量。

dim_feedforwardint, 可选 (默认=128)

前馈网络模型的维度。

dropoutfloat, 可选 (默认=0.1)

要应用的 dropout 比率。

pos_encodingstr, 可选 (默认=”fixed”)

要使用的位置编码类型。选项：[“fixed”, “learnable”]。

activationstr, 可选 (默认=”relu”)

要使用的激活函数。选项：[“relu”, “gelu”]。

normstr, 可选 (默认=”BatchNorm”)

要使用的归一化类型。选项：[“BatchNorm”, “LayerNorm”]。

freezebool, 可选 (默认=False)

如果为 True，Transformer 层将被冻结且不训练。

num_epochsint, 可选 (默认=10)

训练模型的 epoch 数量。

batch_sizeint, 可选 (默认=8)

训练期间每个 mini-batch 的大小。

criterioncallable, 可选 (默认=None)

要使用的损失函数。如果为 None，将使用 CrossEntropyLoss。

criterion_kwargsdict, 可选 (默认=None)

传递给损失函数的附加关键字参数。

optimizerstr, 可选 (默认=None)

要使用的优化器。如果为 None，将使用 Adam 优化器。

optimizer_kwargsdict, 可选 (默认=None)

传递给优化器的附加关键字参数。

lrfloat, 可选 (默认=0.001)

优化器的学习率。

verbosebool, 可选 (默认=True)

如果为 True，将在训练期间打印进度信息。

random_stateint 或 None, 可选 (默认=None)

随机数生成器的种子。

属性:

is_fitted

是否已调用 fit。

参考文献

[1] (1,2)

George Zerveas, Srideepika Jayaraman, Dhaval Patel, Anuradha Bhamidipaty,

and Carsten Eickhoff. 2021. 用于多元时间序列表示学习的 Transformer 框架 (A Transformer-based Framework for Multivariate Time Series Representation Learning)。第 27 届 ACM SIGKDD 知识发现与数据挖掘大会 (KDD ‘21) 会议论文集。计算机协会，美国纽约州纽约市，2114-2124. https://doi.org/10.1145/3447548.3467401. .. [Rd7b568e6af84-2] gzerveas/mvts_transformer

示例

>>> from sktime.datasets import load_unit_test
>>> from sktime.classification.deep_learning import MVTSTransformerClassifier
>>>
>>> X_train, y_train = load_unit_test(split="train")
>>> X_test, _ = load_unit_test(split="test")
>>>
>>> model = MVTSTransformerClassifier()
>>> model.fit(X_train, y_train)  
>>> preds = model.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()	检查对象是否由其他 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, ...])	设置对象的 pseudo-random 种子参数 random_state。
set_tags(**tag_dict)	将实例级别标签覆盖设置为给定值。

classmethod get_test_params(parameter_set='default')

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

参数:

parameter_setstr, 默认值=”default”

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

“results_comparison” - 在某些分类器中用于同一性测试

应包含与“TSC bakeoff”相当的参数设置

返回:

paramsdict 或 list of dict, 默认值 = {}

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

check_is_fitted(method_name=None)

检查估计器是否已拟合。

检查 _is_fitted 属性是否存在且为 True。在调用对象的 fit 方法时，is_fitted 属性应设置为 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 设置动态标签覆盖。

此方法应仅在对象的 __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 的引用。

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

nameslist of str, 与 objs 长度相同

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

fit(X, y)

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

状态改变

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

写入 self

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

参数:

X兼容 sktime 的 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兼容 sktime 的 Table scitype 表格数据容器

1D iterable，形状为 [n_instances] 或 2D iterable，形状为 [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，则不更新状态。

参数:

X兼容 sktime 的 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兼容 sktime 的 Table scitype 表格数据容器

1D iterable，形状为 [n_instances] 或 2D iterable，形状为 [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 折交叉验证的样本外预测，其中 random_state x 如果存在则取自 self，否则 x=None

change_statebool, 可选 (默认=True)

• 如果为 False，将不改变分类器的状态，即 fit/predict 序列在副本上运行，self 不会改变

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

返回:

y_pred兼容 sktime 的 Table scitype 表格数据容器

预测的类别标签

1D iterable，形状为 [n_instances]，或 2D iterable，形状为 [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，则不更新状态。

参数:

X兼容 sktime 的 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兼容 sktime 的 Table scitype 表格数据容器

1D iterable，形状为 [n_instances] 或 2D iterable，形状为 [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 折交叉验证的样本外预测，其中 random_state x 如果存在则取自 self，否则 x=None

change_statebool, 可选 (默认=True)

• 如果为 False，将不改变分类器的状态，即 fit/predict 序列在副本上运行，self 不会改变

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

返回:

y_pred2D np.array of 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()

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

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

返回:

composite: bool

对象是否具有任何参数，其值是 BaseObject 后代实例。

property is_fitted

是否已调用 fit。

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

返回:

bool

估计器是否已 拟合。

classmethod load_from_path(serial)

从文件位置加载对象。

参数:

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

返回:

反序列化的 self，结果位于 path，由 cls.save(path) 生成

classmethod load_from_serial(serial)

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

参数:

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

返回:

反序列化后的 self，产生 cls.save(None) 的输出 serial

predict(X)

预测 X 中序列的标签。

参数:

X兼容 sktime 的 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_pred兼容 sktime 的 Table scitype 表格数据容器

预测的类别标签

1D iterable，形状为 [n_instances]，或 2D iterable，形状为 [n_instances, n_dimensions]。

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

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

predict_proba(X)

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

参数:

X兼容 sktime 的 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 of 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，则返回一个内存中的序列化 self；如果 path 是文件位置，则将 self 存储在该位置作为 zip 文件

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

参数:

pathNone 或文件位置 (str 或 Path)

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

• path=”estimator”，则会在当前工作目录创建 estimator.zip 文件。

• path=”/home/stored/estimator”，则会在

存储在 /home/stored/ 中。

serialization_format: str, 默认值 = “pickle”

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

返回:

如果 path 为 None - 内存中的序列化 self

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

score(X, y) → float

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

参数:

X兼容 sktime 的 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兼容 sktime 的 Table scitype 表格数据容器

1D iterable，形状为 [n_instances] 或 2D iterable，形状为 [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 kernel 如何显示 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”；要使用的 logger 名称。

  • “mute_warnings”：bool，默认值=False；如果为 True，则抑制警告。

返回:

self对 self 的引用。

注释

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

set_params(**params)

设置此对象的参数。

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

参数:

**paramsdict

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

返回:

self对 self 的引用（参数设置后）

set_random_state(random_state=None, deep=True, self_policy='copy')

设置对象的 pseudo-random 种子参数 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对 self 的引用。

set_tags(**tag_dict)

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

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

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

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

set_tags 方法只能在对象的 __init__ 方法中、构造期间或通过 __init__ 直接构造后调用。

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

参数:

**tag_dictdict

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

返回:

Self

对 self 的引用。