FreshPRINCE

class FreshPRINCE(default_fc_parameters='comprehensive', n_estimators=200, save_transformed_data=False, verbose=0, n_jobs=1, chunksize=None, random_state=None)

带有 RotatIoN forest 分类器的新管道。

此分类器仅使用具有综合特征的 TSFresh [1] 转换器转换输入数据，并使用转换后的数据构建 RotationForest 估计器。

参数:

default_fc_parametersstr, 默认值=”comprehensive”

要提取的 TSFresh 特征集，选项包括“minimal”、“efficient”或“comprehensive”。

n_estimatorsint, 默认值=200

RotationForest 集成的估计器数量。

verboseint, 默认值=0

打印到控制台的输出级别（仅供参考）

n_jobsint, 默认值=1

用于 fit 和 predict 并行运行的作业数。-1 表示使用所有处理器。

chunksizeint 或 None, 默认值=None

每个并行 TSFresh 作业中处理的序列数量，应针对高效并行化进行优化。

random_stateint 或 None, 默认值=None

随机种子，整数。

属性:

n_classes_int

类别数。从数据中提取。

classes_形状为 (n_classes_) 的 ndarray

保存每个类别的标签。

另请参阅

TSFreshFeatureExtractor, TSFreshClassifier, RotationForest

参考

[1]

Christ, Maximilian 等人。“基于可伸缩假设检验的时间序列特征提取（tsfresh - 一个 Python 包）”。Neurocomputing 307 (2018): 72-77。https://www.sciencedirect.com/science/article/pii/S0925231218304843

示例

>>> from sktime.classification.feature_based import FreshPRINCE
>>> 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 = FreshPRINCE(
...     default_fc_parameters="comprehensive",
...     n_estimators=200,
...     save_transformed_data=False,
...     verbose=0,
...     n_jobs=1,
... ) 
>>> clf.fit(X_train, y_train)  
FreshPRINCE(...)
>>> 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()	获取自身的配置标志。
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”

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

返回:

paramsdict or list of dict, default={}

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

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

引发:

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 查看。

参数:

estimatorAn instance of :class:BaseObject or derived class

tag_namesstr or list of str, default = None

要克隆的标签名称。默认设置（None）克隆 estimator 中的所有标签。

返回:

self

对 self 的引用。

classmethod create_test_instance(parameter_set='default')

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

参数:

parameter_setstr, default=”default”

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

返回:

instanceinstance of the class with default parameters

classmethod create_test_instances_and_names(parameter_set='default')

创建所有测试实例的列表以及它们的名称列表。

参数:

parameter_setstr, default=”default”

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

返回:

objslist of instances of cls

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

nameslist of str, same length as objs

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

fit(X, y)

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

状态改变

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

写入自身

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

参数:

Xsktime compatible time series panel data container of Panel scitype

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

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

• pd-multiindex: pd.DataFrame with columns = variables, index = pd.MultiIndex with first level = instance indices, second level = time indices

• numpy3D: 3D np.array (any number of dimensions, equal length series) of shape [n_instances, n_dimensions, series_length]

• 或任何其他支持的 Panel mtype

有关 mtype 列表，请参阅 datatypes.SCITYPE_REGISTER

有关规范，请参阅 examples/AA_datatypes_and_datasets.ipynb

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

ysktime compatible tabular data container, Table scitype

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

返回:

selfReference to self.

对自身的引用。

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

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

如果 change_state=True，则写入自身

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

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

参数:

Xsktime compatible time series panel data container of Panel scitype

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

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

• pd-multiindex: pd.DataFrame with columns = variables, index = pd.MultiIndex with first level = instance indices, second level = time indices

• numpy3D: 3D np.array (any number of dimensions, equal length series) of shape [n_instances, n_dimensions, series_length]

• 或任何其他支持的 Panel mtype

有关 mtype 列表，请参阅 datatypes.SCITYPE_REGISTER

有关规范，请参阅 examples/AA_datatypes_and_datasets.ipynb

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

ysktime compatible tabular data container, 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, or sklearn cross-validation object, optional, default=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_statebool, optional (default=True)

• 如果为 False，将不改变分类器的状态，即拟合/预测序列使用副本运行，自身不会改变

• 如果为 True，将使用完整的 X 和 y 拟合自身，最终状态将等同于运行 fit(X, y)

返回:

y_predsktime compatible tabular data container, of 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.is_fitted 设置为 True。设置以“_”结尾的已拟合模型属性。

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

参数:

Xsktime compatible time series panel data container of Panel scitype

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

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

• pd-multiindex: pd.DataFrame with columns = variables, index = pd.MultiIndex with first level = instance indices, second level = time indices

• numpy3D: 3D np.array (any number of dimensions, equal length series) of shape [n_instances, n_dimensions, series_length]

• 或任何其他支持的 Panel mtype

有关 mtype 列表，请参阅 datatypes.SCITYPE_REGISTER

有关规范，请参阅 examples/AA_datatypes_and_datasets.ipynb

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

ysktime compatible tabular data container, 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, or sklearn cross-validation object, optional, default=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_statebool, optional (default=True)

• 如果为 False，将不改变分类器的状态，即拟合/预测序列使用副本运行，自身不会改变

• 如果为 True，将使用完整的 X 和 y 拟合自身，最终状态将等同于运行 fit(X, y)

返回:

y_pred2D np.array of int, of shape [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_defaultany type

如果找不到标签，则使用默认/备用值。

返回:

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)

获取已拟合的参数。

所需状态

要求状态为“已拟合”。

参数:

deepbool, default=True

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

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

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

返回:

fitted_paramsdict with str-valued keys

已拟合参数的字典，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, default=True

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

返回:

param_names: list[str]

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

get_params(deep=True)

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

参数:

deepbool, default=True

是否返回组件的参数。

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

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

返回:

paramsdict with str-valued keys

参数字典，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_defaultany type, optional; 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)

从文件位置加载对象。

参数:

serialresult of ZipFile(path).open(“object)

返回:

cls.save(path) 的结果，即在 path 处得到的反序列化自身。

classmethod load_from_serial(serial)

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

参数:

serial1st element of output of cls.save(None)

返回:

cls.save(None) 的结果 serial，即反序列化自身。

predict(X)

预测 X 中序列的标签。

参数:

Xsktime compatible time series panel data container of Panel scitype

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

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

• pd-multiindex: pd.DataFrame with columns = variables, index = pd.MultiIndex with first level = instance indices, second level = time indices

• numpy3D: 3D np.array (any number of dimensions, equal length series) of shape [n_instances, n_dimensions, series_length]

• 或任何其他支持的 Panel mtype

有关 mtype 列表，请参阅 datatypes.SCITYPE_REGISTER

有关规范，请参阅 examples/AA_datatypes_and_datasets.ipynb

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

返回:

y_predsktime compatible tabular data container, of 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 compatible time series panel data container of Panel scitype

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

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

• pd-multiindex: pd.DataFrame with columns = variables, index = pd.MultiIndex with first level = instance indices, second level = time indices

• numpy3D: 3D np.array (any number of dimensions, equal length series) of shape [n_instances, n_dimensions, series_length]

• 或任何其他支持的 Panel mtype

有关 mtype 列表，请参阅 datatypes.SCITYPE_REGISTER

有关规范，请参阅 examples/AA_datatypes_and_datasets.ipynb

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

返回:

y_pred2D np.array of int, of shape [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 or file location (str or Path)

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

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

• path=”/home/stored/estimator” 则会在

存储在 /home/stored/ 中。

serialization_format: str, default = “pickle”

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

返回:

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

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

score(X, y) → float

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

参数:

Xsktime compatible time series panel data container of Panel scitype

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

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

• pd-multiindex: pd.DataFrame with columns = variables, index = pd.MultiIndex with first level = instance indices, second level = time indices

• numpy3D: 3D np.array (any number of dimensions, equal length series) of shape [n_instances, n_dimensions, series_length]

• 或任何其他支持的 Panel mtype

有关 mtype 列表，请参阅 datatypes.SCITYPE_REGISTER

有关规范，请参阅 examples/AA_datatypes_and_datasets.ipynb

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

ysktime compatible tabular data container, 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_dictdict

配置名称 : 配置值 对的字典。有效的配置、值及其含义列在下方。

displaystr, “diagram” (default), or “text”

jupyter 内核如何显示自身的实例

• “diagram” = html 框图表示

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

print_changed_onlybool, default=True

打印自身时，是只列出与默认值不同的自身参数（False），还是列出所有参数名称和值（False）。不嵌套，即只影响自身，不影响组件估计器。

warningsstr, “on” (default), or “off”

是否引发警告，只影响来自 sktime 的警告

• “on” = 将引发来自 sktime 的警告

• “off” = 将不会引发来自 sktime 的警告

backend:parallelstr, optional, default=”None”

广播/向量化时用于并行处理的后端，以下之一：

• “None”：顺序执行循环，简单的列表推导

• “loky”、“multiprocessing”和“threading”：使用 joblib.Parallel

• “joblib”：自定义和第三方 joblib 后端，例如 spark

• “dask”：使用 dask，需要环境中安装 dask 包

• “ray”：使用 ray，需要环境中安装 ray 包

backend:parallel:paramsdict, optional, default={} (no parameters passed)

作为配置传递给并行化后端的额外参数。有效键取决于 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”：字符串，默认为“ray”；要使用的日志记录器名称。

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

返回:

selfreference to self.

注意

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

set_params(**params)

设置此对象的参数。

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

参数:

**paramsdict

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

返回:

selfreference to self (after parameters have been set)

对自身的引用（设置参数后）

设置自身的 random_state 伪随机种子参数。

set_random_state(random_state=None, deep=True, self_policy='copy')

通过 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 instance or None, default=None

deepbool, default=True

是否在 skbase 对象类型参数（即组件估计器）中设置随机状态。

• 如果为 False，将仅设置 self 的 random_state 参数（如果存在）。

• 如果为 True，也将设置组件对象中的 random_state 参数。

self_policystr, one of {“copy”, “keep”, “new”}, default=”copy”

• “copy” : 将 self.random_state 设置为输入的 random_state

• “keep” : self.random_state 保持不变

• “new” : 将 self.random_state 设置为新的随机状态，

从输入的 random_state 派生，并且通常与之不同。

返回:

selfreference to self

对自身的引用

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

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

set_tags(**tag_dict)

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

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

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

参数:

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

**tag_dictdict

返回:

Self

对自身的引用。