SignatureClassifier

class SignatureClassifier(estimator=None, augmentation_list=('basepoint', 'addtime'), window_name='dyadic', window_depth=3, window_length=None, window_step=None, rescaling=None, sig_tfm='signature', depth=4, random_state=None)

使用基于 Signature 的特征进行分类的模块。

这仅初始化 SignatureTransformer 类，该类构建特征提取管道，然后通过在特征提取步骤之后附加一个分类器来创建一个新的管道。

默认参数设置为“多变量时间序列的通用 Signature 方法” [1] 中找到的最佳实践参数

“A Generalised Signature Method for Multivariate TimeSeries” [1]

请注意，在 UEA 数据集上使用的最终分类器涉及调整超参数

• depth 范围 [1, 2, 3, 4, 5, 6]

• window_depth 范围 [2, 3, 4]

• RandomForestClassifier 超参数。

因为这些参数被发现是与数据集最相关的超参数。

因此，我们建议始终为任何给定数据集调优至少这些参数。

参数:

estimatorsklearn 估计器, default=RandomForestClassifier

这应该是任何 sklearn 类型的估计器。默认为 RandomForestClassifier。

augmentation_list: 字符串元组列表, default=(“basepoint”, “addtime”)

在应用 Signature 变换之前要应用的增强列表。

window_name: str, default=”dyadic”

要应用的窗口变换的名称。

window_depth: int, default=3

Dyadic 窗口的深度。（仅在 window_name == 'dyadic'] 时激活）。

window_length: int, default=None

滑动/扩展窗口的长度。（仅在 `window_name in [‘sliding, ‘expanding’]. 时激活）。

window_step: int, default=None

滑动/扩展窗口的步长。（仅在 `window_name in [‘sliding, ‘expanding’]. 时激活）。

rescaling: str, default=None

Signature 重缩放方法。

sig_tfm: str, default=”signature”

指定 Signature 变换类型的字符串。以下之一：['signature', 'logsignature'])。

depth: int, default=4

Signature 截断深度。

random_state: int, default=None

随机状态初始化。

属性:

signature_method: sklearn.Pipeline

执行 Signature 特征提取步骤的 sklearn 管道。

pipeline: sklearn.Pipeline

附加到 signature_method 管道后以构成分类管道的分类器。

n_classes_int

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

classes_shape 为 (n_classes_) 的 ndarray

保存每个类别的标签。

另请参阅

SignatureTransformer

参考文献

[1]

Morrill, James, et al. “A Generalised Signature Method for Multivariate TimeSeries” [1] https://arxiv.org/pdf/2006.00873.pdf

方法

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)	将实例级别标签覆盖设置为给定值。

classmethod get_test_params(parameter_set='default')

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

参数:

parameter_setstr, default=”default”

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

返回:

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

相当于使用 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 或 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 个元素是测试中 obj 第 i 个实例的名称。如果实例多于一个，命名约定为 {cls.__name__}-{i}，否则为 {cls.__name__}

fit(X, y)

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

状态改变

将状态更改为“fitted”。

写入自身

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

参数:

Xsktime 兼容的时间序列面板数据容器，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

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

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对自身的引用。

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

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

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

如果 change_state=True，则写入自身

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

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

参数:

Xsktime 兼容的时间序列面板数据容器，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

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

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, 或 sklearn 交叉验证对象, 可选, default=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, optional (default=True)

• 如果为 False，则不会更改分类器的状态，即 fit/predict 序列以副本运行，自身不改变

• 如果为 True，则将自身拟合到完整的 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.is_fitted 设置为 True。设置以“_”结尾的已拟合模型属性。

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

参数:

Xsktime 兼容的时间序列面板数据容器，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

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

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, 或 sklearn 交叉验证对象, 可选, default=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, optional (default=True)

• 如果为 False，则不会更改分类器的状态，即 fit/predict 序列以副本运行，自身不改变

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

返回:

y_pred形状为 [n_instances, n_classes] 的 2D np.array，元素类型为 int

预测的类别标签概率 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)

获取已拟合参数。

所需状态

要求状态为“fitted”。

参数:

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 在实例上设置的标签，

在实例构造时设置的标签。

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

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

按继承顺序。

参数:

tag_namestr

要检索的标签名称

tag_value_default任意类型, optional; 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

评估器是否已 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 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_predsktime 兼容的表格数据容器，Table scitype

预测的类别标签

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

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

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

predict_proba(X)

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

参数:

Xsktime 兼容的时间序列面板数据容器，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形状为 [n_instances, n_classes] 的 2D np.array，元素类型为 int

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

reset()

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

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

将序列化的自身保存为字节类对象或 (.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 上的真实标签对预测标签进行评分。

参数:

Xsktime 兼容的时间序列面板数据容器，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

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

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)

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

参数:

config_dictdict

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

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

Jupyter 内核如何显示自身实例

• “diagram” = html 框图表示

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

print_changed_onlybool, default=True

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

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

是否发出警告，仅影响 sktime 的警告

• “on” = 将发出 sktime 的警告

• “off” = 将不会发出 sktime 的警告

backend:parallelstr, optional, default=”None”

用于广播/向量化并行处理的后端，以下之一：

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

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

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

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

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

backend:parallel:paramsdict, optional, 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，则抑制警告

返回:

自身

备注

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

set_params(**params)

设置此对象的参数。

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

参数:

**paramsdict

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

返回:

自身 (设置参数后对自身的引用)

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，适用于自身中的 random_state 参数；当且仅当 deep=True 时，适用于剩余的组件对象。

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

参数:

random_stateint, RandomState 实例或 None, default=None

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

deepbool, default=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，通常与之不同

返回:

自身

set_tags(**tag_dict)

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

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

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

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

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

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

参数:

**tag_dictdict

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

返回:

自身

对自身的引用。