ProximityTree

class ProximityTree(random_state=None, distance_measure=None, max_depth=inf, is_leaf=<function pure>, verbosity=0, n_jobs=1, n_stump_evaluations=5)

邻近树类。

一个使用距离度量来划分数据的决策树。

参数:

random_state: int 或 np.RandomState, 默认=0

随机数生成器的随机种子

distance_measure: ``None`` (默认) 或 str; 如果是 str, 必须是以下之一

euclidean, dtw, ddtw, wdtw, wddtw, msm, lcss, erp 要使用的距离度量；如果为 None，则从可用距离列表中随机选择距离

max_depth: int 或 math.inf, 默认=math.inf

树的最大深度

is_leaf函数, 默认=pure

决定何时将节点标记为叶节点

verbosity: 0 或 1

反映日志详细程度的数字 0 = 无日志，1 = 详细日志

n_jobs: int 或 None, 默认=1

构建时使用的并行线程数

n_stump_evaluations: 如果 find_stump 方法为 None，要执行的树桩评估次数

属性:

is_fitted

fit 方法是否已被调用。

示例

>>> from sktime.classification.distance_based import ProximityTree
>>> 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 = ProximityTree(max_depth=2, n_stump_evaluations=1) 
>>> clf.fit(X_train, y_train) 
ProximityTree(...)
>>> 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])	创建所有测试实例的列表以及它们的名称列表。
find_stump()	找到最佳的树桩。
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_exemplars()	从数据框和类值列表中提取示例。
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)	从序列化内存容器加载对象。
pick_distance_measure()	选择一个距离度量。
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)	将实例级别标签覆盖设置为给定值。

pick_distance_measure()

选择一个距离度量。

参数:

selfProximityStump 对象。

返回:

距离度量

find_stump()

找到最佳的树桩。

返回:

stumpProximityStump

n 次尝试中最佳的树桩/数据分割。

get_exemplars()

从数据框和类值列表中提取示例。

参数:

selfProximityTree

邻近树对象。

返回:

ret: 每个类一个示例

classmethod get_test_params(parameter_set='default')

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

参数:

parameter_setstr, 默认=”default”

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

返回:

paramsdict 或 list of dict，默认={}

用于创建类的测试实例的参数。每个 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()

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

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

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

状态变化

将状态更改为“fitted”。

写入 self

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

参数:

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

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

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

• pd-multiindex: pd.DataFrame，列 = 变量，索引 = 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 的引用。

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

对 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: 形状为 [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

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-fold 交叉验证的样本外预测，其中 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)

对 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: 形状为 [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

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-fold 交叉验证的样本外预测，其中 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 的 dict

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

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 中序列的标签。

参数:

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

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

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

• pd-multiindex: pd.DataFrame，列 = 变量，索引 = 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

预测的类标签

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

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

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

predict_proba(X)

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

参数:

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

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

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

• pd-multiindex: pd.DataFrame，列 = 变量，索引 = 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_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，返回一个内存中的序列化 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"，则将在

/home/stored/ 中存储一个 zip 文件 estimator.zip。

serialization_format: str，默认 = “pickle”

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

返回:

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

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

score(X, y) → float

根据 X 上的真实标签评估预测标签。

参数:

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

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

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

• pd-multiindex: pd.DataFrame，列 = 变量，索引 = 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

返回:

float，predict(X) 与 y 相比的准确度得分

set_config(**config_dict)

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

参数:

config_dictdict

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

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

jupyter 内核如何显示 self 的实例

• “diagram”= html 框图表示

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

print_changed_onlybool，默认=True

打印 self 时是仅列出与默认值不同的 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 对象以及复合对象。可以使用参数键字符串 `__` 来访问复合对象（即包含其他对象的对象）中组件 `` 中的 ``。如果引用是明确的，也可以使用字符串 ``，不带 `__`，例如组件中没有两个参数同名 ``。

参数:

**paramsdict

BaseObject 参数，键必须是 `__` 字符串。`__` 后缀可以作为完整字符串的别名，如果它们在 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 中指定的值，键是标签名称，字典值是要设置的标签值。

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

可以使用 get_tags 或 get_tag 检查当前标签值。

参数:

**tag_dictdict

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

返回:

Self

对 self 的引用。