ProximityForest

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

Proximity Forest 分类器。

使用距离度量分割数据的决策树森林 [1]。内部使用 ProximityTree。

参数：

random_state: int or np.RandomState, default=None

随机数生成器的随机种子

n_estimators: int, default=100

森林中的树木数量。

distance_measure: ``None``（默认）或字符串；如果是字符串，则为以下之一

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

verbosity: 0 or 1

表示日志详细程度的数字 0 = 无日志，1 = 详细日志

max_depth: int or math.inf, default=math.inf

树的最大深度

is_leaf: function, default=pure

用于决定何时将节点标记为叶节点的函数

n_jobs: int, default=1

并行运行的作业数量（跨线程）

n_stump_evaluations: int, default=5

如果 find_stump 方法为 None，要进行的桩（stump）评估数量

属性：

is_fitted

是否已调用 fit。

参考文献

[1]

Ben Lucas 等人，“Proximity Forest：一种有效且可扩展的基于距离的时间序列分类器”，数据挖掘与知识发现，33(3): 607-635, 2019 https://arxiv.org/abs/1808.10594

作者原始 uea-machine-learning/tsml classifiers/distance_based/ProximityForestWrapper.java 的 Java 包装器 Java 版本 uea-machine-learning/tsml classifiers/distance_based/proximity/ProximityForest.java

示例

>>> from sktime.classification.distance_based import ProximityForest
>>> 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 = ProximityForest(
...     n_estimators=2, max_depth=2, n_stump_evaluations=1
... ) 
>>> clf.fit(X_train, y_train) 
ProximityForest(...)
>>> 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()	获取 self 的配置标志。
get_exemplars()	从数据帧和类值列表中提取代表性样本（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()	检查对象是否由其他 BaseObject 组成。
load_from_path(serial)	从文件位置加载对象。
load_from_serial(serial)	从序列化的内存容器加载对象。
pick_distance_measure()	选择一个距离度量。
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)	将实例级别标签覆盖设置为给定值。

pick_distance_measure()

选择一个距离度量。

参数：

selfProximityStump 对象。

返回：

ret: 距离度量

get_exemplars()

从数据帧和类值列表中提取代表性样本（exemplars）。

参数：

selfProximityForest

Proximity Forest 对象。

返回：

ret: 每个类一个代表性样本

classmethod get_test_params(parameter_set='default')

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

参数：

parameter_setstr，默认值=“default”

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

返回：

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

fit(X, y)

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

状态改变

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

写入 self

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

参数：

X与 sktime 兼容的时间序列面板数据容器，Panel scitype

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

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

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

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

• 或任何其他受支持的 Panel mtype

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

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

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

y与 sktime 兼容的表格数据容器，Table scitype

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

返回：

selfself 的引用。

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

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

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

写入 self，如果 change_state=True

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

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

参数：

X与 sktime 兼容的时间序列面板数据容器，Panel scitype

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

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

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

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

• 或任何其他受支持的 Panel mtype

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

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

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

y与 sktime 兼容的表格数据容器，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_pred与 sktime 兼容的表格数据容器，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 中序列的标签概率。

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

写入 self，如果 change_state=True

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

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

参数：

X与 sktime 兼容的时间序列面板数据容器，Panel scitype

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

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

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

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

• 或任何其他受支持的 Panel mtype

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

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

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

y与 sktime 兼容的表格数据容器，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 的 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 的配置标志。

配置是 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 类型的 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()

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

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

返回：

composite: bool

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

property is_fitted

是否已调用 fit。

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

返回：

bool

估计器是否已 拟合。

classmethod load_from_path(serial)

从文件位置加载对象。

参数：

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

返回：

反序列化的 self，其输出位于 path，来自 cls.save(path)

classmethod load_from_serial(serial)

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

参数：

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

返回：

反序列化的 self，其输出为 serial，来自 cls.save(None)

predict(X)

预测 X 中序列的标签。

参数：

X与 sktime 兼容的时间序列面板数据容器，Panel scitype

要预测标签的时间序列。

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

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

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

• 或任何其他受支持的 Panel mtype

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

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

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

返回：

y_pred与 sktime 兼容的表格数据容器，Table scitype

预测的类标签

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

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

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

predict_proba(X)

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

参数：

X与 sktime 兼容的时间序列面板数据容器，Panel scitype

要预测标签的时间序列。

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

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

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

• 或任何其他受支持的 Panel mtype

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

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

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

返回：

y_pred2D np.array 的 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')

将序列化的 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 上的真实标签对预测标签进行评分。

参数：

X与 sktime 兼容的时间序列面板数据容器，Panel scitype

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

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

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

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

• 或任何其他受支持的 Panel mtype

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

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

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

y与 sktime 兼容的表格数据容器，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>。如果引用明确，即没有两个组件参数具有相同名称 <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 的引用。