TSCGridSearchCV

class TSCGridSearchCV(estimator, param_grid, scoring=None, n_jobs=None, refit=True, cv=None, verbose=0, pre_dispatch='2*n_jobs', error_score=nan, return_train_score=False, tune_by_variable=False)

对估计器指定参数值进行详尽搜索。

改编自 sklearn GridSearchCV，用于 sktime 时间序列分类器

通过详尽网格搜索优化估计器的超参数。

参数：

estimator估计器对象

假定其实现 scikit-learn 估计器接口。估计器需要提供一个 score 函数，或者必须传入 scoring 参数。

param_griddict 或 字典列表

字典的键为参数名（str），值为要尝试的参数设置列表；或者是一个字典列表，在这种情况下将探索列表中每个字典覆盖的网格。这使得可以搜索任何参数设置序列。

scoringstr、callable、list、tuple 或 dict，默认值=None

评估交叉验证模型在测试集上性能的策略。

如果 scoring 表示单个分数，可以使用

• 一个字符串（参见 评分参数：定义模型评估规则）；

• 一个可调用对象（参见 评分函数），返回单个值。

如果 scoring 表示多个分数，可以使用

• 唯一的字符串列表或元组；

• 返回一个字典的可调用对象，其中键是指标名称，值是指标分数；

• 一个字典，键是指标名称，值是可调用对象。

n_jobsint，默认值=None

并行运行的作业数。None 表示 1，除非在 joblib.parallel_backend 上下文中。-1 表示使用所有处理器。有关更多详细信息，请参见术语表。

refitbool、str 或 callable，默认值=True

使用找到的最佳参数在整个数据集上重新拟合估计器。如果为 False，则 predict 和 predict_proba 将不起作用。

对于多指标评估，这需要是一个 str，表示用于在最后找到最佳参数以重新拟合估计器的评分器。

在选择最佳估计器时，如果除了最高分数还有其他考虑因素，refit 可以设置为一个函数，该函数在给定 cv_results_ 的情况下返回选定的 best_index_。在这种情况下，best_estimator_ 和 best_params_ 将根据返回的 best_index_ 设置，而 best_score_ 属性将不可用。

重新拟合的估计器可通过 best_estimator_ 属性访问，并允许直接在此 GridSearchCV 实例上使用 predict。

对于多指标评估，属性 best_index_、best_score_ 和 best_params_ 仅在设置了 refit 时可用，并且它们都将相对于此特定评分器确定。

有关多指标评估的更多信息，请参见 scoring 参数。

cvint、交叉验证生成器或可迭代对象，默认值=None

确定交叉验证分割策略。cv 的可能输入有

• None，使用默认的 5 折交叉验证，

• 整数，指定 (Stratified)KFold 中的折数，

• CV 分割器,

• 生成 (训练集, 测试集) 分割作为索引数组的可迭代对象。

对于整数/None 输入，如果估计器是分类器且 y 是二元或多类别，则使用 StratifiedKFold。在所有其他情况下，使用 KFold。这些分割器实例化时将 shuffle=False，因此不同调用之间的分割将相同。

请参阅用户指南，了解此处可使用的各种交叉验证策略。

verboseint

控制输出的详细程度：值越高，消息越多。

• >1：显示每个折叠和参数候选的计算时间；

• >2：也显示分数；

• >3：还显示折叠和候选参数索引以及计算的开始时间。

pre_dispatchint 或 str，默认值='2*n_jobs'

控制并行执行期间分派的作业数。当分派的作业数多于 CPU 可处理的数量时，减少此数字有助于避免内存消耗激增。此参数可以是

• None，在这种情况下，所有作业将立即创建并生成。将其用于轻量级且快速运行的作业，以避免因按需生成作业而导致的延迟

• 整数，指定要生成的总作业的确切数量

• 字符串，给出作为 n_jobs 函数的表达式，例如 '2*n_jobs'

error_score'raise' 或 numeric，默认值=np.nan

如果估计器拟合时发生错误，则赋给分数的值。如果设置为 'raise'，则会引发错误。如果给定一个数值，则会引发 FitFailedWarning。此参数不影响重新拟合步骤，该步骤将始终引发错误。

return_train_scorebool，默认值=False

如果为 False，则 cv_results_ 属性将不包含训练分数。计算训练分数可用于了解不同参数设置如何影响过拟合/欠拟合的权衡。然而，计算训练集上的分数计算成本可能很高，并且并非选择获得最佳泛化性能参数的严格要求。

tune_by_variablebool，可选（默认值=False）

是否在将多元数据传递给调优估计器时，按每个时间序列变量分别调优参数。仅在传递的时间序列是严格多元时适用。如果为 True，估计器的克隆将分别拟合到每个变量，并通过 classifiers_ 属性的字段访问。这与将 ColumnEnsembleClassifier 包装器应用于 self 具有相同的效果。如果为 False，则为所有变量选择相同的最佳参数。

属性：

cv_results_numpy (masked) ndarrays 的字典

一个字典，键为列标题，值为列，可以导入到 pandas DataFrame 中。

对于多指标评估，所有评分器的分数在 cv_results_ 字典中可用，其键以该评分器的名称结尾（'_<scorer_name>'），而不是上面所示的 '_score'。（如 ‘split0_test_precision’，‘mean_train_precision’ 等）

best_estimator_估计器

搜索选择的估计器，即在保留数据上给出最高分数（如果指定了，则是最小损失）的估计器。如果 refit=False 则不可用。

有关允许值的更多信息，请参见 refit 参数。

best_score_float

best_estimator 的平均交叉验证分数

对于多指标评估，仅在指定 refit 时存在。

如果 refit 是函数，则此属性不可用。

best_params_dict

在保留数据上给出最佳结果的参数设置。

对于多指标评估，仅在指定 refit 时存在。

best_index_int

cv_results_ 数组中的索引，对应于最佳候选参数设置。

search.cv_results_['params'][search.best_index_] 处的字典给出最佳模型的参数设置，该模型给出最高平均分数（search.best_score_）。

对于多指标评估，仅在指定 refit 时存在。

scorer_function 或 dict

用于在保留数据上选择模型最佳参数的评分函数。

对于多指标评估，此属性包含经过验证的 scoring 字典，该字典将评分器键映射到可调用评分器。

n_splits_int

交叉验证分割（折叠/迭代）的数量。

refit_time_float

在整个数据集上重新拟合最佳模型所用的秒数。

仅在 refit 不为 False 时存在。

multimetric_bool

评分器是否计算多个指标。

classes_形状为 (n_classes,) 的 ndarray

类别标签。仅在指定了 refit 且底层估计器是分类器时存在。

n_features_in_int

拟合期间看到的特征数量。仅在定义了 best_estimator_（有关 refit 参数的更多详细信息，请参见文档）并且该 best_estimator_ 在拟合时暴露 n_features_in_ 时定义。

feature_names_in_形状为 (n_features_in_,) 的 ndarray

拟合期间看到的特征名称。仅在定义了 best_estimator_（有关 refit 参数的更多详细信息，请参见文档）并且该 best_estimator_ 在拟合时暴露 feature_names_in_ 时定义。

另请参见

ParameterGrid

生成超参数网格的所有组合。

train_test_split

一个实用函数，用于将数据分割成一个用于拟合 GridSearchCV 实例的开发集和一个用于最终评估的评估集。

sklearn.metrics.make_scorer

从性能指标或损失函数创建评分器。

方法

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()	检查对象是否由其他 BaseObject 组成。
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')

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

参数：

parameter_setstr，默认值=“default”

要返回的测试参数集名称，用于测试。如果未为值定义特殊参数，将返回“default”集。对于分类器，应为一般测试提供一组“default”参数，如果通用参数集无法产生适合比较的概率，则提供一组“results_comparison”参数用于与先前记录的结果进行比较。

返回值：

paramsdict 或 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 设置动态标签覆盖。

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

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

参数：

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

fit(X, y)

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

状态改变

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

写入 self

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

参数：

Xsktime 兼容的时间序列面板数据容器，Panel scitype

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

可以是 Panel mtype 的任何格式，例如

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

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

• 或任何其他支持的 Panel mtype

mtype 列表，请参见 datatypes.SCITYPE_REGISTER

规范，请参见 examples/AA_datatypes_and_datasets.ipynb

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

ysktime 兼容的表格数据容器，Table scitype

1D 可迭代对象，形状为 [n_instances]，或 2D 可迭代对象，形状为 [n_instances, n_dimensions]，用于拟合的类别标签 0-th 索引对应于 X 中的实例索引 1-st 索引（如果适用）对应于 X 中的多输出向量索引 支持的 sktime 类型：np.ndarray (1D, 2D), pd.Series, pd.DataFrame

返回值：

self对 self 的引用。

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

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

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

写入 self，如果 change_state=True

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

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

参数：

Xsktime 兼容的时间序列面板数据容器，Panel scitype

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

可以是 Panel mtype 的任何格式，例如

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

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

• 或任何其他支持的 Panel mtype

mtype 列表，请参见 datatypes.SCITYPE_REGISTER

规范，请参见 examples/AA_datatypes_and_datasets.ipynb

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

ysktime 兼容的表格数据容器，Table scitype

1D 可迭代对象，形状为 [n_instances]，或 2D 可迭代对象，形状为 [n_instances, n_dimensions]，用于拟合的类别标签 0-th 索引对应于 X 中的实例索引 1-st 索引（如果适用）对应于 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，将用完整的 X 和 y 拟合 self，最终状态等同于运行 fit(X, y)

返回值：

y_predsktime 兼容的表格数据容器，Table scitype

预测的类别标签

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

0-th 索引对应于 X 中的实例索引，1-st 索引（如果适用）对应于 X 中的多输出向量索引。如果 y 是一元（一维），则是 1D np.npdarray；否则，与拟合时传入的 y 类型相同

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

y_pred2D np.array (int 类型)，形状为 [实例数, 类别数]

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

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

写入 self，如果 change_state=True

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

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

参数：

Xsktime 兼容的时间序列面板数据容器，Panel scitype

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

可以是 Panel mtype 的任何格式，例如

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

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

• 或任何其他支持的 Panel mtype

mtype 列表，请参见 datatypes.SCITYPE_REGISTER

规范，请参见 examples/AA_datatypes_and_datasets.ipynb

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

ysktime 兼容的表格数据容器，Table scitype

1D 可迭代对象，形状为 [n_instances]，或 2D 可迭代对象，形状为 [n_instances, n_dimensions]，用于拟合的类别标签 0-th 索引对应于 X 中的实例索引 1-st 索引（如果适用）对应于 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，将用完整的 X 和 y 拟合 self，最终状态等同于运行 fit(X, y)

返回值：

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

预测的类别标签概率 第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 的配置标志。

配置是 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带有字符串值键的字典

拟合参数字典，包含 参数名:参数值 的键值对

• 总是：此对象的所有拟合参数，如同通过 get_param_names 获取；值是此对象该键的拟合参数值

• 如果 deep=True，也包含组件参数的键值对；组件的参数索引为 [componentname]__[paramname]； componentname 的所有参数都以 paramname 及其值的形式出现

• 如果 deep=True，也包含任意级别的组件递归，例如 [componentname]__[componentcomponentname]__[paramname] 等

classmethod get_param_defaults()

获取对象的参数默认值。

返回值：

default_dict: 字典[str, Any]

键是 cls 中在 __init__ 中定义了默认值的所有参数。值是在 __init__ 中定义的默认值。

classmethod get_param_names(sort=True)

获取对象的参数名称。

参数：

sort布尔型，默认为 True

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

返回值：

param_names: 列表[str]

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

get_params(deep=True)

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

参数：

deep布尔型，默认为 True

是否返回组件的参数。

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

• 如果为 False，将返回此对象的 参数名:值 的 dict，但不包括组件的参数。

返回值：

params带有字符串值键的字典

参数字典，包含 参数名:参数值 的键值对

• 总是：此对象的所有参数，如同通过 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_error布尔型

当未找到标签时是否引发 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_tags字典

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

is_composite()

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

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

返回值：

composite: 布尔型

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

property is_fitted

是否已调用 fit。

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

返回值：

布尔型

估计器是否已 fit。

classmethod load_from_path(serial)

从文件位置加载对象。

参数：

serial是 ZipFile(path).open(“object”) 的结果

返回值：

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

classmethod load_from_serial(serial)

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

参数：

serial是 cls.save(None) 输出的第一个元素

返回值：

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

predict(X)

预测 X 中序列的标签。

参数：

Xsktime 兼容的时间序列面板数据容器，Panel scitype

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

可以是 Panel mtype 的任何格式，例如

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

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

• 或任何其他支持的 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-th 索引对应于 X 中的实例索引，1-st 索引（如果适用）对应于 X 中的多输出向量索引。如果 y 是一元（一维），则是 1D np.npdarray；否则，与拟合时传入的 y 类型相同

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

predict_proba(X)

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

参数：

Xsktime 兼容的时间序列面板数据容器，Panel scitype

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

可以是 Panel mtype 的任何格式，例如

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

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

• 或任何其他支持的 Panel mtype

mtype 列表，请参见 datatypes.SCITYPE_REGISTER

规范，请参见 examples/AA_datatypes_and_datasets.ipynb

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

返回值：

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

预测的类别标签概率 第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，默认为 “pickle”

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

返回值：

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

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

score(X, y) → float

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

参数：

Xsktime 兼容的时间序列面板数据容器，Panel scitype

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

可以是 Panel mtype 的任何格式，例如

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

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

• 或任何其他支持的 Panel mtype

mtype 列表，请参见 datatypes.SCITYPE_REGISTER

规范，请参见 examples/AA_datatypes_and_datasets.ipynb

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

ysktime 兼容的表格数据容器，Table scitype

1D 可迭代对象，形状为 [n_instances]，或 2D 可迭代对象，形状为 [n_instances, n_dimensions]，用于拟合的类别标签 0-th 索引对应于 X 中的实例索引 1-st 索引（如果适用）对应于 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 时是只列出与默认值不同的参数（True），还是列出所有参数名称和值（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

    在并行化后关闭。

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

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

返回值：

self指向 self 的引用。

注意

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

set_params(**params)

设置此对象的参数。

该方法适用于简单的 skbase 对象以及复合对象。参数键字符串 <component>__<parameter> 可用于复合对象，即包含其他对象的对象，用于访问组件 <component> 中的 <parameter>。字符串 <parameter>（不带 <component>__）也可以使用，如果这使得引用明确，例如，没有两个组件参数具有相同的名称 <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 中的 random_state 参数（取决于 self_policy），并且仅当 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 的引用。