MUSE#

class MUSE(anova=True, variance=False, bigrams=True, window_inc=2, alphabet_size=4, use_first_order_differences=True, feature_selection='chi2', p_threshold=0.05, support_probabilities=False, n_jobs=1, random_state=None)[source]#

MUSE (多变量符号扩展)。

也称为 WEASLE-MUSE：WEASEL 的多变量实现，在 [1] 中简称 MUSE。

概述：输入 n 个序列，长度为 m

WEASEL+MUSE 是一种多变量字典分类器，它使用 SFA 构建不同窗口长度的模式袋，并在此模式袋上学习逻辑回归分类器。

主要参数如下：: alphabet_size: 字母表大小 chi2-threshold: 用于特征选择以选择最佳词语 anova: 选择除了第一个傅里叶系数之外的最佳 l/2 个傅里叶系数 bigrams: 使用 SFA 词语的二元组 binning_strategy: 用于离散化为

SFA 词语的分箱策略。

参数:

anova: 布尔值, 默认为 True: 如果为 True，则通过单向 ANOVA 检验选择傅里叶系数。如果为 False，则选择前几个傅里叶系数。仅在给出标签时适用
variance: 布尔值, 默认为 False: 如果为 True，则通过最大方差选择傅里叶系数。如果为 False，则选择前几个傅里叶系数。仅在给出标签时适用
bigrams: 布尔值, 默认为 True: 是否创建 SFA 词语的二元组
window_inc: int, 默认为 2: WEASEL 为每个窗口大小创建一个 BoP 模型。这是用于确定下一个窗口大小的增量。
alphabet_size默认为 4: 每个词语可能的字母（值）数量。
p_threshold: int, 默认为 0.05（默认禁用）: 当基于卡方检验进行特征选择时使用。这是在词袋上进行卡方检验使用的 p 值阈值（值越低越严格）。1 表示不执行该检验。
use_first_order_differences: 布尔值, 默认为 True: 如果设置为 True，会将每个维度的一阶差分添加到数据中。
support_probabilities: bool, 默认为 False: 如果设置为 False，将训练 RidgeClassifierCV，它的精度更高，速度更快，但不支持 predict_proba。如果设置为 True，将训练 LogisticRegression，它支持 predict_proba()，但速度较慢，通常精度较低。例如，在早期分类器（如 TEASER）中需要 predict_proba()。
feature_selection: {“chi2”, “none”, “random”}, 默认为 chi2: 设置要使用的特征选择策略。Chi2 显著减少词语数量，因此速度快得多（首选）。Random 也显著减少数量。None 不应用特征选择，产生较大的词袋，例如可能需要大量内存。
n_jobsint, 默认为 1: fit 和 predict 并行运行的作业数量。-1 表示使用所有处理器。
random_state: int 或 None, 默认为 None: 随机数种子, 整数

属性:

n_classes_int: 类别数量。
classes_list: 类别标签。

另请参阅

WEASEL

注意

对于 Java 版本，请参阅 - 原始出版物。 - `MUSE

<uea-machine-learning/tsml

classifiers/multivariate/WEASEL_MUSE.java>`_。

参考资料

[1]

Patrick Schäfer 和 Ulf Leser，“使用 WEASEL+MUSE 进行多变量时间序列分类”，发表于第 3 届 ECML/PKDD AALTD 研讨会论文集，2018 https://arxiv.org/abs/1711.11343

示例

>>> from sktime.classification.dictionary_based import MUSE
>>> 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 = MUSE(window_inc=4, use_first_order_differences=False) 
>>> clf.fit(X_train, y_train) 
MUSE(...)
>>> 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`()	获取 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)	将实例级标签覆盖设置为给定值。

classmethod get_test_params(parameter_set='default')[source]#

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

参数:

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

返回:

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

check_is_fitted(method_name=None)[source]#

检查估计器是否已拟合。

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

如果不是，则引发 NotFittedError。

参数:

method_namestr, 可选: 调用此方法的名称。如果提供，错误消息将包含此信息。

引发:

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

clone()[source]#

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

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

将另一个对象的标签克隆为动态覆盖。

每个与 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 列表, 默认为 None: 要克隆的标签名称。默认值（None）克隆来自 estimator 的所有标签。

返回:

self: 对 self 的引用。

classmethod create_test_instance(parameter_set='default')[source]#

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

参数:

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

返回:

instance带有默认参数的类实例

classmethod create_test_instances_and_names(parameter_set='default')[source]#

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

参数:

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

返回:

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

fit(X, y)[source]#

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

状态变化: 状态变为“已拟合”。
写入 self: 将 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对 self 的引用。

fit_predict(X, y, cv=None, change_state=True)[source]#

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

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

如果 change_state=True，则写入 self: 将 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 交叉验证对象, 可选, 默认为 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，将不会改变分类器的状态，即使用副本运行拟合/预测序列，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)[source]#

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

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

如果 change_state=True，则写入 self: 将 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 交叉验证对象, 可选, 默认为 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，将不会改变分类器的状态，即使用副本运行拟合/预测序列，self 不会改变
如果为 True，将 self 拟合到完整的 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)[source]#

从类中获取类标签值，并继承父类的标签级别。

每个与 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。

classmethod get_class_tags()[source]#

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

每个与 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()[source]#

获取 self 的配置标志。

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

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

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

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

返回:

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

get_fitted_params(deep=True)[source]#

获取已拟合的参数。

所需状态: 要求状态为“已拟合”。

参数:

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()[source]#

获取对象的参数默认值。

返回:

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

classmethod get_param_names(sort=True)[source]#

获取对象的参数名称。

参数:

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

返回:

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

get_params(deep=True)[source]#

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

参数:

deepbool, 默认为 True

是否返回组件的参数。

如果为 True，将返回此对象的参数名称 : 值字典，包括组件参数（= BaseObject 类型参数）。
如果为 False，将返回此对象的参数名称 : 值字典，但不包含组件参数。

返回:

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)[source]#

从实例中获取标签值，并继承标签级别和覆盖。

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

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

get_tag(tag_name, tag_value_default=None, raise_error=True)[source]#

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()[source]#

从实例中获取标签，并继承标签级别和覆盖。

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

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

get_tags 方法返回一个标签字典，其键是类或其任何父类中设置的任何 _tags 属性的键，或通过 set_tags 或 clone_tags 设置的标签。

值是相应的标签值，优先级从高到低依次为

get_tag 方法从实例中检索名称为 tag_name 的单个标签值，考虑标签覆盖，优先级从高到低依次为

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

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

按继承顺序。

返回:

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

is_composite()[source]#

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

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

返回:

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

property is_fitted[source]#

fit 是否已被调用。

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

返回:

bool: 估计器是否已 fit。

classmethod load_from_path(serial)[source]#

从文件位置加载对象。

参数:

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

返回:

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

classmethod load_from_serial(serial)[source]#

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

参数:

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

返回:

反序列化的 self，其输出为 serial，是 cls.save(None) 的结果

predict(X)[source]#

预测 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 中的多输出向量索引。

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

predict_proba(X)[source]#

预测 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_pred2D np.array (int), 形状为 [n_instances, n_classes]: 预测的类别标签概率。第 0 维索引对应于 X 中的实例索引，第 1 维索引对应于类索引，顺序与 self.classes_ 中的相同。条目是预测的类别概率，总和为 1。

reset()[source]#

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

结果是将 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')[source]#

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

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

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

参数:

pathNone 或文件位置 (str 或 Path)

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

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

存储一个 zip 文件 estimator.zip。

serialization_format: str, 默认 = “pickle”

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

返回:

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

score(X, y) → float[source]#

根据 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)[source]#

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

参数:

config_dictdict

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

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

jupyter 内核如何显示 self 的实例

“diagram” = HTML 框图表示
“text” = 字符串打印输出

print_changed_onlybool, 默认=True

当打印 self 时，是仅列出自变量参数（self-parameters）中与默认值不同的参数（False），还是列出所有参数名称和值（False）。它不会嵌套，即只影响 self 而不影响组件估计器（component estimators）。

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 由 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，则抑制警告

返回:

selfself 的引用。

注意

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

set_params(**params)[source]#

设置此对象的参数。

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

参数:

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

返回:

selfself 的引用（设置参数后）

set_random_state(random_state=None, deep=True, self_policy='copy')[source]#

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

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 派生，并且通常与输入的不同

返回:

selfself 的引用

set_tags(**tag_dict)[source]#

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

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

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

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

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

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

参数:

**tag_dictdict: 字典，包含标签名称: 标签值对。

返回:

Self: self 的引用。