MrSEQL

类 MrSEQL(seql_mode='fs', symrep='sax', custom_config=None)

MrSEQL = 多重表示序列学习分类模型。

直接接口到 mrseql 中的 MrSEQLClassifier。注意：mrseql 本身是 copyleft (GPL3) 的。此接口是许可性许可证 (BSD3)。

MrSEQL 是一种高效的时间序列分类器，利用时间序列的符号表示，使用 SAX 和 SFA 特征。

参数：

seql_mode字符串，可以是 ‘clf’ 或 ‘fs’（默认）。

在 ‘clf’ 模式下，Mr-SEQL 是 SEQL 模型的集成，而在 ‘fs’ 模式下，Mr-SEQL 使用 SEQL 从时间序列的符号表示中提取的特征训练逻辑回归模型。

symrep字符串，或字符串列表或元组，字符串为 ‘sax’ 或 ‘sfa’。

默认 = “sax”，即仅使用 SAX 特征，不使用 SFA 特征。用于转换输入时间序列的符号表示。

custom_config字典，可选，默认=None

符号转换的自定义参数。如果已定义，则忽略 symrep。（原始 mrseql 代码中未提供此参数的文档）

属性：

is_fitted

是否已调用 fit 方法。

参考文献

[1]

Thach Le Nguyen, Severin Gsponer, Iulia Ilie, Martin O’Reilly, Georgiana Ifrim. “Interpretable Time Series Classification Using Linear Models and Multi-resolution Multi-domain Symbolic Representations”, Data Mining and Knowledge Discovery, 2019.

方法

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

check_is_fitted(method_name=None)

检查估计器是否已拟合。

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

如果未拟合，则引发 NotFittedError。

参数：

method_name字符串，可选

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

引发：

NotFittedError

如果估计器尚未拟合。

clone()

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

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

等同于构造一个新的 type(self) 实例，其参数与 self 相同，即 type(self)(**self.get_params(deep=False))。

如果在 self 上设置了配置，则克隆也将具有与原始对象相同的配置，等同于调用 cloned_self.set_config(**self.get_config())。

其值也等同于调用 self.reset，不同之处在于 clone 返回一个新对象，而不是像 reset 那样改变 self。

引发：

如果克隆不符合要求，则引发 RuntimeError，原因在于 __init__ 错误。

clone_tags(estimator, tag_names=None)

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

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

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

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

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

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

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

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

参数：

estimatorBaseObject 或派生类的实例 :class:

tag_names字符串或字符串列表，默认 = None

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

返回：

self

对 self 的引用。

类方法 create_test_instance(parameter_set='default')

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

参数：

parameter_set字符串，默认=”default”

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

返回：

instance具有默认参数的类实例

类方法 create_test_instances_and_names(parameter_set='default')

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

参数：

parameter_set字符串，默认=”default”

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

返回：

objscls 的实例列表

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

names字符串列表，与 objs 长度相同

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

fit(X, y)

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

状态改变

将状态更改为“fitted”。

写入 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 索引对应于 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，则不更新状态。

参数：

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 索引对应于 X 中的实例索引 1 索引（如果适用）对应于 X 中的多输出向量索引。 支持的 sktime 类型：np.ndarray (1D, 2D), pd.Series, pd.DataFrame

cvNone，整数，或 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 测试折叠必须不相交

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

change_state布尔值，可选（默认=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 索引对应于 X 中的实例索引，1 索引（如果适用）对应于 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 索引对应于 X 中的实例索引 1 索引（如果适用）对应于 X 中的多输出向量索引。 支持的 sktime 类型：np.ndarray (1D, 2D), pd.Series, pd.DataFrame

cvNone，整数，或 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 测试折叠必须不相交

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

change_state布尔值，可选（默认=True）

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

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

返回：

y_pred2D np.array（整型），形状为 [n_instances, n_classes]

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

类方法 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_name字符串

标签值的名称。

tag_value_default任何类型

如果未找到标签时的默认/备用值。

返回：

tag_value

self 中 tag_name 标签的值。如果未找到，则返回 tag_value_default。

类方法 get_class_tags()

从类中获取类标签，并考虑来自父类的标签级别继承。

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

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

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

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

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

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

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

按继承顺序排列。

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

要检索可能包含实例覆盖的标签，请改用 get_tags 方法。

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

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

collected_tags字典

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

get_config()

获取 self 的配置标志。

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

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

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

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

返回：

config_dict字典

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

get_fitted_params(deep=True)

获取已拟合参数。

所需状态

要求状态为“fitted”。

参数：

deep布尔值，默认=True

是否返回组件的已拟合参数。

• 如果为 True，将返回此对象的 参数名称 : 值 字典，包括可拟合组件的已拟合参数（= BaseEstimator 值参数）。

• 如果为 False，将返回此对象的 参数名称 : 值 字典，但不包括组件的已拟合参数。

返回：

fitted_params具有字符串值键的字典

已拟合参数字典，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)

获取对象的参数名称。

参数：

sort布尔值，默认=True

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

返回：

param_names: list[str]

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

get_params(deep=True)

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

参数：

deep布尔值，默认=True

是否返回组件的参数。

• 如果 True，将返回此对象的 字典，包括组件的参数（= BaseObject 值参数）。

• 如果 False，将返回此对象的 字典，但不包括组件的参数。

返回：

params具有字符串值键的字典

参数字典，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_name字符串

要检索的标签名称

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

如果未找到标签时的默认/回退值

raise_error布尔值

未找到标签时是否引发 ValueError

返回：

tag_value任意类型

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_tags字典

标签名称 : 标签值 对的字典。从通过嵌套继承获得的 _tags 类属性以及来自 _tags_dynamic 对象属性的任何覆盖和新标签中收集。

classmethod get_test_params(parameter_set='default')

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

参数：

parameter_set字符串，默认=”default”

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

返回：

params字典或字典列表，默认为 {}

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

is_composite()

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

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

返回：

composite: 布尔值

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

property is_fitted

是否已调用 fit 方法。

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

返回：

布尔值

估计器是否已被 fit。

classmethod load_from_path(serial)

从文件位置加载对象。

参数：

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

返回：

反序列化的 self，结果位于 path，是 cls.save(path) 的输出

classmethod load_from_serial(serial)

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

参数：

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

返回：

反序列化的 self，结果是输出 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 索引对应于 X 中的实例索引，1 索引（如果适用）对应于 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（整型），形状为 [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')

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

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

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

参数：

pathNone 或文件位置 (str 或 Path)

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

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

• path=”/home/stored/estimator”，则 zip 文件 estimator.zip 将

存储在 /home/stored/ 中。

serialization_format: str, default = “pickle”

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

返回：

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

如果 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 索引对应于 X 中的实例索引 1 索引（如果适用）对应于 X 中的多输出向量索引。 支持的 sktime 类型：np.ndarray (1D, 2D), pd.Series, pd.DataFrame

返回：

浮点数，predict(X) 与 y 的准确率得分

set_config(**config_dict)

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

参数：

config_dict字典

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

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

jupyter 内核如何显示 self 的实例

• “diagram” = html 框图表示

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

print_changed_only布尔值，默认为 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:params字典，可选，默认为 {} (未传递参数)

作为配置传递给并行化后端的额外参数。有效键取决于 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”：布尔值，默认为 True；False 可防止 ray 在并行化后关闭。

    shutting down after parallelization.

  • “logger_name”：str，默认为“ray”；要使用的日志记录器的名称。

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

返回：

self对 self 的引用。

注意

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

set_params(**params)

设置此对象的参数。

此方法适用于简单的 skbase 对象以及复合对象。参数键字符串 <component>__<parameter> 可用于复合对象（即包含其他对象的对象）以访问组件 <component> 中的 <parameter>。如果不带 <component>__ 的字符串 <parameter> 能清晰指示（例如，没有两个组件参数同名 <parameter>），则也可使用该形式。

参数：

**params字典

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

返回：

self对 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_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 可在多次函数调用中获得可重现的输出。

deep布尔值，默认=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_dict字典

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

返回：

Self

对 self 的引用。