TSRGridSearchCV

class TSRGridSearchCV(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)

对估计器在指定参数值上进行穷举搜索。

为 sktime 时间序列回归器适配 sklearn 的 GridSearchCV。

通过穷举网格搜索优化 estimators 的超参数。

参数:

estimator估计器对象

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

param_grid字典或字典列表

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

scoringstr、可调用对象、列表、元组或字典，默认为 None

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

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

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

• 返回单个值的可调用对象（参见 scoring）。

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

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

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

• 一个字典，其中键是度量名称，值是可调用对象。

n_jobsint，默认为 None

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

refitbool、str 或可调用对象，默认为 True

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

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

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

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

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

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

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

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

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

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

• CV 分割器,

• 一个可迭代对象，生成 (train, test) 分割作为索引数组。

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

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

verboseint

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

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

• >2：也显示分数；

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

pre_dispatchint 或 str，默认为 ‘2*n_jobs’

控制并行执行期间调度的作业数。当调度的作业数超过 CPU 可以处理的数量时，减少此数字有助于避免内存消耗爆炸。此参数可以是

• None，此时所有作业会立即创建并生成。对于轻量级和快速运行的作业使用此设置，以避免因按需生成作业而造成的延迟

• 一个 int，给出生成的总作业的确切数量

• 一个 str，给出作为 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，估计器的克隆将分别拟合到每个变量，并在 regressors_ 属性的字段中可用。这与将 ColumnEnsembleRegressor 包装器应用于 self 具有相同的效果。如果为 False，则为所有变量选择相同的最佳参数。

属性:

cv_results_numpy（掩码）ndarray 的字典

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

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

best_estimator_估计器

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

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

best_score_float

最佳估计器的平均交叉验证分数

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

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

best_params_dict

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

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

best_index_int

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

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

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

scorer_函数或字典

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

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

n_splits_int

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

refit_time_float

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

仅在 refit 不为 False 时存在。

multimetric_bool

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

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)	将时间序列回归器拟合到训练数据。
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 中序列的标签。
reset()	将对象重置到干净的初始化后状态。
save([path, serialization_format])	将序列化的 self 保存到字节类对象或 (.zip) 文件。
score(X, y[, multioutput])	根据 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”参数用于与先前记录的结果进行比较。

返回:

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

用于创建类测试实例的参数。每个字典都是用于构造“有趣”测试实例的参数，即 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。

等同于构造一个具有 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 列表，默认为 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。设置以“_”结尾的拟合模型属性。

参数:

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

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

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

• pd-multiindex：pd.DataFrame，其中 columns = 变量，index = pd.MultiIndex，第一级为实例索引，第二级为时间索引

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

• 或任何其他支持的 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 的引用。

注意

通过创建一个拟合模型来改变状态，该模型更新以“_”结尾的属性并将 is_fitted 标志设置为 True。

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_dictdict

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

get_fitted_params(deep=True)

获取已拟合参数。

所需状态

要求状态为“已拟合”。

参数:

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 类型的 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任意类型，可选；默认值=None

如果未找到标签，则为默认/备用值

raise_errorbool

如果未找到标签，是否引发 ValueError

返回:

tag_valueAny

标签 tag_name 在 self 中的值。如果未找到，并且 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 的后代实例。

属性 is_fitted

是否已调用 fit 方法。

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

返回:

bool

估计器是否已进行 fit。

类方法 load_from_path(serial)

从文件位置加载对象。

参数:

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

返回:

反序列化 self，得到 cls.save(path) 在 path 处的输出

类方法 load_from_serial(serial)

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

参数:

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

返回:

反序列化 self，得到 cls.save(None) 的输出 serial

predict(X) → ndarray

预测 X 中序列的标签。

参数:

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

要预测标签的时间序列。

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

• pd-multiindex：pd.DataFrame，其中 columns = 变量，index = pd.MultiIndex，第一级为实例索引，第二级为时间索引

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

• 或任何其他支持的 Panel mtype

mtypes 列表请参见 datatypes.SCITYPE_REGISTER

规范请参见 examples/AA_datatypes_and_datasets.ipynb

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

返回:

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

预测的回归标签

一维可迭代对象，形状为 [n_instances]，或二维可迭代对象，形状为 [n_instances, n_dimensions]。

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

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

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” 时，将在当前工作目录 (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, multioutput='uniform_average') → float

根据 X 中的真实标签对预测标签进行评分。

参数:

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

pd-multiindex: pd.DataFrame，列 = 变量，索引 = pd.MultiIndex，第一层 = 实例索引，第二层 = 时间索引 numpy3D: 三维 np.array（任意维数，等长序列），形状为 [n_instances, n_dimensions, series_length] 或任何其他支持的 Panel mtype 有关 mtype 列表，请参阅 datatypes.SCITYPE_REGISTER 有关详细规范，请参阅 examples/AA_datatypes_and_datasets.ipynb

y二维 np.array，int 类型，形状为 [n_instances, n_dimensions] - 回归标签

或 一维 np.array，int 类型，形状为 [n_instances] - 回归标签。用于 fit 的索引对应于 X 中的实例索引

multioutputstr，可选（默认值=”uniform_average”）

{“raw_values”, “uniform_average”, “variance_weighted”}，形状为 (n_outputs,) 的 array-like 或 None，默认值=”uniform_average”。定义了多个输出分数的聚合方式。Array-like 值定义了用于平均分数的权重。

返回:

float（默认值）或 一维 np.array，float 类型

predict(X) 与 y 的 R-squared 分数。如果 multioutput=”uniform_average” 或 “variance_weighted”，或 y 是一元的，则为 float；如果 multioutput=”raw_values” 且 y 是多元的，则为 一维 np.array。

set_config(**config_dict)

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

参数:

config_dictdict

配置名称：配置值对的字典。下面列出了有效的配置、值及其含义

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

jupyter kernel 如何显示 self 的实例

• “diagram” = html 框图表示

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

print_changed_onlybool，默认值=True

打印 self 时是否仅列出与默认值不同的 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: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”；要使用的 logger 名称。

  • “mute_warnings”：bool，默认值=False；如果为 True，则禁止显示警告

返回:

self对 self 的引用。

注意

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

set_params(**params)

设置此对象的参数。

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

参数:

**paramsdict

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

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 中指定的值，其中键是标签名称，字典值是要将标签设置为何值。

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

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

参数:

**tag_dictdict

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

返回:

Self

对 self 的引用。