KNeighborsTimeSeriesClassifier

class KNeighborsTimeSeriesClassifier(n_neighbors=1, weights='uniform', algorithm='brute', distance='dtw', distance_params=None, distance_mtype=None, pass_train_distances=False, leaf_size=30, n_jobs=None)

K 近邻时间序列分类器。

这是 scikit-learn 的 KNeighborsClassifier 的一个改编版本，适用于时间序列数据。

此类是一个支持时间序列距离度量的 KNN 分类器。

时间序列距离通过 distance argument 传入，可以是

• 一个字符串。这将替代 sktime.distances 中硬编码的距离度量。这些默认距离旨在提供高性能，但无法处理长度不等或多元时间序列。

• 一个 sktime 成对转换器。这些转换器可在 sktime.dists_kernels 中找到，通过搜索 pairwise-transformer 类型，使用 registry.all_estimators 可以发现它们。它们是 sktime 框架中可组合的一等公民。可以处理长度不等或多元时间序列的距离度量可用，这些可以通过 capability:unequal_length 和 capability:multivariate 标签发现。

• 一个可调用对象。可调用对象的精确签名如下所述。

参数：

n_neighborsint 类型，可选，默认值 = 1

“k 近邻”中的 k

weights{‘uniform’, ‘distance’} 或 callable，默认值=’uniform’

预测中使用的权重函数。

可能的值

• ‘uniform’ : 统一权重。每个邻域中的所有点权重相等。

• ‘distance’ : 按距离的倒数加权点。在这种情况下，查询点较近的邻居将比离得远的邻居具有更大的影响。

• [callable] : 用户定义的函数，接受一个距离数组，并返回一个具有相同形状的包含权重的数组。

algorithmstr 类型，可选，默认值 = ‘brute’

搜索邻居的方法，以下之一：{‘ball_tree’, ‘brute’, ‘brute_incr’}

• ‘brute’ 会预先计算距离矩阵，并直接应用 sklearn KNeighborsClassifier。此算法对内存不高效，因为它随着距离矩阵的大小而扩展，但运行时可能更高效。

• ‘brute_incr’ 将距离传递给 sklearn KNeighborsClassifier，使用 algorithm='brute'。这对大型数据集很有用，可以提高内存效率，因为距离是递增使用的，无需预计算。然而，这可能导致运行时效率较低。

• ‘ball_tree’ 使用球树来查找最近邻，使用 sklearn 中的 KNeighborsClassifier。对于中大型数据集，运行时和内存可能更高效，然而距离计算可能较慢。

distancestr 类型，sktime 成对转换器，或 callable，可选，默认值 =’dtw’

时间序列之间的距离度量

• 如果为 str 类型，必须是以下字符串之一：‘euclidean’, ‘squared’, ‘dtw’, ‘ddtw’, ‘wdtw’, ‘wddtw’, ‘lcss’, ‘edr’, ‘erp’, ‘msm’, ‘twe’。这将替代 sktime.distances 中硬编码的距离度量

• 如果为 sktime 成对转换器，必须实现 pairwise-transformer 接口。sktime 转换器可在 sktime.dists_kernels 中找到，通过搜索 pairwise-transformer 类型，使用 registry.all_estimators 可以发现它们。

• 如果为非类可调用对象，可以通过 distance_params 传递参数。示例：knn_dtw = KNeighborsTimeSeriesClassifier( distance=’dtw’, distance_params={‘epsilon’:0.1})

• 如果为任何可调用对象，必须具有签名 (X: Panel, X2: Panel) -> np.ndarray。如果 X 是包含 m 个 Series 的 Panel，X2 是包含 n 个 Series 的 Panel，则输出必须是 mxn 数组；如果未设置 distance_mtype，则必须能够接受 pd_multiindex 和 numpy3D mtype 类型的 X, X2。

distance_paramsdict 类型，可选，默认值 = None。

距离参数的字典，当 distance 为 str 或 callable 时使用

distance_mtypestr 类型，或 str 列表，可选，默认值 = None。

distance 期望 X 和 X2 使用的 mtype 类型，如果为可调用对象，仅当 distance 不是 BasePairwiseTransformerPanel 的后代时才设置此参数

pass_train_distancesbool 类型，可选，默认值 = False。

是否计算训练点之间的距离并将其传递给 sklearn。对于 algorithm=’brute’，传递是多余的，但对于其他情况可能产生影响。

leaf_sizeint 类型，可选，默认值=30

传递给 BallTree 或 KDTree 的叶子大小。这会影响构建和查询的速度，以及存储树所需的内存。最佳值取决于问题的性质。

n_jobsint 类型，可选，默认值=None

用于邻居搜索的并行作业数量。None 表示 1，除非处于 joblib.parallel_backend 上下文中。-1 表示使用所有处理器。不影响 fit 方法。

属性：

is_fitted

是否已调用 fit。

示例

>>> from sktime.classification.distance_based import KNeighborsTimeSeriesClassifier
>>> from sktime.datasets import load_unit_test
>>> X_train, y_train = load_unit_test(return_X_y=True, split="train")
>>> X_test, y_test = load_unit_test(return_X_y=True, split="test")
>>> classifier = KNeighborsTimeSeriesClassifier(distance="euclidean")
>>> classifier.fit(X_train, y_train)
KNeighborsTimeSeriesClassifier(...)
>>> y_pred = classifier.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_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 组成。
kneighbors(X[, n_neighbors, return_distance])	查找点的 K 近邻。
load_from_path(serial)	从文件位置加载对象。
load_from_serial(serial)	从序列化内存容器加载对象。
predict(X)	预测 X 中序列的标签。
predict_proba(X)	预测 X 中序列的标签概率。
reset()	将对象重置为干净的后初始化状态。
save([path, serialization_format])	将序列化的 self 保存到 bytes-like 对象或 (.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 列表，默认值={}

创建类测试实例的参数。每个 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 个实例的名称。如果实例多于一个，命名约定为 {cls.__name__}-{i}，否则为 {cls.__name__}

fit(X, y)

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

状态变更

将状态更改为“fitted”。

写入 self

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

参数：

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

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

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

• pd-multiindex: pd.DataFrame，其中 columns = variables，index = pd.MultiIndex，第一级 = 实例索引，第二级 = 时间索引

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

• 或任何其他支持的 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，其中 columns = variables，index = pd.MultiIndex，第一级 = 实例索引，第二级 = 时间索引

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

• 或任何其他支持的 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 折交叉验证的样本外预测，其中 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 个索引对应于 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，其中 columns = variables，index = pd.MultiIndex，第一级 = 实例索引，第二级 = 时间索引

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

• 或任何其他支持的 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 折交叉验证的样本外预测，其中 random_state x 如果存在则取自 self，否则 x=None

change_statebool 类型，可选（默认值=True）

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

• 如果为 True，将使用完整的 X 和 y 拟合 self，最终状态将等同于运行 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)

获取已拟合参数。

所需状态

要求状态为“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`-valued parameters）的参数。

• 如果为 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_value任意类型

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: 布尔

对象是否有任何参数的值是 BaseObject 的派生实例。

属性 is_fitted

是否已调用 fit。

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

返回：

布尔

评估器是否已 fit。

kneighbors(X, n_neighbors=None, return_distance=True)

查找点的 K 近邻。

返回每个点的邻居的索引和距离。

参数：

Xsktime 兼容数据格式，Panel 或 Series，包含 n_samples 个序列

n_neighbors整型

要获取的邻居数量（默认为传递给构造函数的值）。

return_distance布尔值，可选。默认为 True。

如果为 False，则不返回距离

返回：

dist数组

表示点之间距离的数组，仅在 return_distance=True 时存在

ind数组

总体矩阵中最接近的点的索引。

类方法 load_from_path(serial)

从文件位置加载对象。

参数：

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

返回：

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

类方法 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，其中 columns = variables，index = pd.MultiIndex，第一级 = 实例索引，第二级 = 时间索引

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

• 或任何其他支持的 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，其中 columns = variables，index = pd.MultiIndex，第一级 = 实例索引，第二级 = 时间索引

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

• 或任何其他支持的 Panel mtype 类型

有关 mtypes 列表，请参阅 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 保存到 bytes-like 对象或 (.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 文件并

存储在 /home/stored/ 中。

serialization_format: str，默认为“pickle”

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

返回：

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

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

score(X, y) → 浮点型

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

参数：

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

要计算预测标签得分的时间序列。

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

• pd-multiindex: pd.DataFrame，其中 columns = variables，index = pd.MultiIndex，第一级 = 实例索引，第二级 = 时间索引

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

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

返回：

浮点型，predict(X) 对比 y 的准确率得分

set_config(**config_dict)

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

参数：

config_dictdict 类型

配置名称: 配置值对的字典。有效的配置、值及其含义如下所示

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

Jupyter 内核如何显示 self 的实例

• “diagram” = html 框图表示

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

print_changed_only布尔值，默认为 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”：布尔值，默认为 True；False 会阻止 ray 在并行化后关闭。

    shutting down after parallelization.

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

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

返回：

selfself 的引用。

注意

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

set_params(**params)

设置此对象的参数。

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

参数：

**paramsdict

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

返回：

selfself 的引用（设置参数后）

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_state整型，RandomState 实例或 None，默认为 None

伪随机数生成器，用于控制随机整数的生成。传递整型值可在多次函数调用中获得可复现的输出。

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 派生，并且通常与它不同

返回：

selfself 的引用

set_tags(**tag_dict)

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

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

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

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

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

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

参数：

**tag_dictdict

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

返回：

Self

self 的引用。