DummyClassifier

class DummyClassifier(strategy='prior', random_state=None, constant=None)

DummyClassifier 进行预测时会忽略输入特征。

该分类器作为一个简单的基线，用于与其他更复杂的分类器进行比较。基线的具体行为通过 strategy 参数选择。

所有策略进行的预测都忽略作为 X 参数传递给 fit 和 predict 的输入特征值。但是，预测通常取决于作为 y 参数传递给 fit 时观察到的值。

功能上与 sklearn.dummy.DummyClassifier 相同，内部会调用它。

参数:

strategy{“most_frequent”, “prior”, “stratified”, “uniform”, “constant”}，默认为 “prior”

用于生成预测的策略。 * “most_frequent”：“predict” 方法总是返回在传递给 fit 的 y 参数中观察到的最

常见的类别标签。“predict_proba” 方法返回匹配的独热编码向量。

• “prior”：“predict” 方法总是返回在传递给 fit 的 y 参数中观察到的最常见类别标签（如“most_frequent”）。“predict_proba” 总是返回 y 的经验类别分布，也称为经验类别先验分布。

• “stratified”：“predict_proba” 方法根据经验类别先验概率参数化的多项分布随机采样独热向量。“predict” 方法返回在“predict_proba” 的独热向量中概率为一的类别标签。因此，两种方法采样的每一行都是独立同分布的。

• “uniform”：从 y 中观察到的唯一类别列表中均匀随机生成预测，即每个类别具有相等的概率。

• “constant”：总是预测用户提供的常量标签。这对于评估非多数类别的指标很有用。

random_stateint, RandomState 实例或 None，默认为 None

控制当 strategy='stratified' 或 strategy='uniform' 时生成预测的随机性。传递一个整数可以在多次函数调用中获得可复现的输出。参阅 术语表。

constantint 或 str 或 形状为 (n_outputs,) 的数组式对象，默认为 None

“constant” 策略预测的显式常量。此参数仅对“constant” 策略有用。

属性:

is_fitted

是否已调用 fit。

示例

>>> from sktime.classification.dummy import DummyClassifier
>>> from sktime.datasets import load_unit_test
>>> X_train, y_train = load_unit_test(split="train")
>>> X_test, y_test = load_unit_test(split="test")
>>> classifier = DummyClassifier(strategy="prior")
>>> classifier.fit(X_train, y_train)
DummyClassifier()
>>> y_pred = classifier.predict(X_test)
>>> y_pred_proba = classifier.predict_proba(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" 集。

返回值:

paramsdict 或 list of 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()

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

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

抛出异常:

如果由于 __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 或 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])

namesstr 列表，与 objs 长度相同

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

fit(X, y)

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

状态变化

状态变为“fitted”（已拟合）。

写入自身

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

参数:

XPanel scitype 的 sktime 兼容时间序列面板数据容器

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

可以是 Panel scitype 的任何 mtype，例如

• pd-multiindex：pd.DataFrame，列 = 变量，索引 = pd.MultiIndex，第一层 = 实例索引，第二层 = 时间索引

• numpy3D：3D np.array（任意维度，等长序列），形状为 [n_instances, n_dimensions, series_length]

• 或任何其他支持的 Panel mtype

mtypes 列表请参见 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.is_fitted 设置为 True。设置以“_”结尾的已拟合模型属性。

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

参数:

XPanel scitype 的 sktime 兼容时间序列面板数据容器

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

可以是 Panel scitype 的任何 mtype，例如

• pd-multiindex：pd.DataFrame，列 = 变量，索引 = pd.MultiIndex，第一层 = 实例索引，第二层 = 时间索引

• numpy3D：3D np.array（任意维度，等长序列），形状为 [n_instances, n_dimensions, series_length]

• 或任何其他支持的 Panel mtype

mtypes 列表请参见 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_predTable scitype 的 sktime 兼容表格数据容器

预测的类别标签

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，则不更新状态。

参数:

XPanel scitype 的 sktime 兼容时间序列面板数据容器

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

可以是 Panel scitype 的任何 mtype，例如

• pd-multiindex：pd.DataFrame，列 = 变量，索引 = pd.MultiIndex，第一层 = 实例索引，第二层 = 时间索引

• numpy3D：3D np.array（任意维度，等长序列），形状为 [n_instances, n_dimensions, series_length]

• 或任何其他支持的 Panel mtype

mtypes 列表请参见 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 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)

获取已拟合的参数。

所需状态

要求状态为“fitted”（已拟合）。

参数:

deepbool，默认为 True

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

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

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

返回值:

fitted_params键为 str 类型的字典

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

参数字典，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) 的结果

返回值:

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

classmethod load_from_serial(serial)

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

参数:

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

返回值:

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

predict(X)

预测 X 中序列的标签。

参数:

XPanel scitype 的 sktime 兼容时间序列面板数据容器

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

可以是 Panel scitype 的任何 mtype，例如

• pd-multiindex：pd.DataFrame，列 = 变量，索引 = pd.MultiIndex，第一层 = 实例索引，第二层 = 时间索引

• numpy3D：3D np.array（任意维度，等长序列），形状为 [n_instances, n_dimensions, series_length]

• 或任何其他支持的 Panel mtype

mtypes 列表请参见 datatypes.SCITYPE_REGISTER

具体说明请参见 examples/AA_datatypes_and_datasets.ipynb

并非所有估计器都支持多变量或不等长序列的面板，详细信息请参见 标签参考。

返回值:

y_predTable scitype 的 sktime 兼容表格数据容器

预测的类别标签

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

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

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

predict_proba(X)

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

参数:

XPanel scitype 的 sktime 兼容时间序列面板数据容器

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

可以是 Panel scitype 的任何 mtype，例如

• pd-multiindex：pd.DataFrame，列 = 变量，索引 = pd.MultiIndex，第一层 = 实例索引，第二层 = 时间索引

• numpy3D：3D np.array（任意维度，等长序列），形状为 [n_instances, n_dimensions, series_length]

• 或任何其他支持的 Panel mtype

mtypes 列表请参见 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，则返回内存中的序列化自身；如果 path 是文件位置，则将自身作为 zip 文件存储在该位置。

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

参数:

pathNone 或文件位置 (str 或 Path)

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

• path=”estimator”，则将在当前工作目录 (cwd) 创建一个 zip 文件 estimator.zip。

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

存储在 /home/stored/ 中。

serialization_format: str，默认 = “pickle”

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

返回值:

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

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

score(X, y) → float

评估 X 上预测标签与真实标签的得分。

参数:

XPanel scitype 的 sktime 兼容时间序列面板数据容器

用于对预测标签进行评分的时间序列。

可以是 Panel scitype 的任何 mtype，例如

• pd-multiindex：pd.DataFrame，列 = 变量，索引 = pd.MultiIndex，第一层 = 实例索引，第二层 = 时间索引

• numpy3D：3D np.array（任意维度，等长序列），形状为 [n_instances, n_dimensions, series_length]

• 或任何其他支持的 Panel mtype

mtypes 列表请参见 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 kernel 如何显示 self 的实例

• “diagram” = html 框图表示

• “text” = 字符串输出

print_changed_onlybool，默认=True

打印 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”；要使用的日志记录器名称。

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

返回值:

self对 self 的引用。

注意

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

set_params(**params)

设置此对象的参数。

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

参数:

**paramsdict

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

返回值:

self对 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对 self 的引用

set_tags(**tag_dict)

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

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

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

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

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

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

参数:

**tag_dictdict

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

返回值:

Self

对 self 的引用。