KNeighborsTimeSeriesClassifierPyts

class KNeighborsTimeSeriesClassifierPyts(n_neighbors=1, weights='uniform', algorithm='auto', leaf_size=30, p=2, metric='minkowski', metric_params=None, n_jobs=1)

来自 pyts 的 K 近邻时间序列分类器。

直接接口到 pyts.classification.KNeighborsClassifier，接口类的作者是 johannfaouzi。

参数:

n_neighborsint, 可选 (默认 = 1)

要使用的邻居数量。

weightsstr 或 callable, 可选 (默认 = ‘uniform’)

预测中使用的权重函数。可能的值:

• ‘uniform’ : 均匀权重。每个邻域中的所有点都被同等加权。

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

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

algorithm{‘auto’, ‘ball_tree’, ‘kd_tree’, ‘brute’}, 可选

用于计算最近邻的算法。如果 metric 是 ‘dtw’、‘dtw_sakoechiba’、‘dtw_itakura’、‘dtw_multiscale’、‘dtw_fast’ 或 ‘boss’（将使用 ‘brute’），则忽略。

注意: 在稀疏输入上拟合会覆盖此参数的设置，强制使用暴力算法。

leaf_sizeint, 可选 (默认 = 30)

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

metricstring 或 DistanceMetric object (默认 = ‘minkowski’)

用于树的距离度量。默认度量是 minkowski，当 p=2 时等同于标准的欧几里得度量。有关可用度量的列表，请参阅 scikit-learn 中 DistanceMetric 类的文档。对于动态时间规整 (Dynamic Time Warping)，可用度量包括 ‘dtw’、‘dtw_sakoechiba’、‘dtw_itakura’、‘dtw_multiscale’ 和 ‘dtw_fast’。对于 BOSS 度量，可以使用 ‘boss’。

pinteger, 可选 (默认 = 2)

Minkowski 度量的幂参数。当 p = 1 时，这等同于使用 manhattan_distance (l1)，当 p = 2 时等同于 euclidean_distance (l2)。对于任意 p，使用 minkowski_distance (l_p)。

metric_paramsdict, 可选 (默认 = None)

度量函数的附加关键字参数。

n_jobsint, 可选 (默认 = 1)

用于邻居搜索的并行作业数。如果 n_jobs=-1，则作业数设置为 CPU 内核数。不影响 fit 方法。

属性:

classes_array, 形状 = (n_classes,)

分类器已知的类标签数组。

示例

>>> import sktime.classification.distance_based as clf_db  
>>> from clf_db import KNeighborsTimeSeriesClassifierPyts  
>>> from sktime.datasets import load_unit_test  
>>> X_train, y_train = load_unit_test(split="train")  
>>> X_test, y_test = load_unit_test(split="test")  
>>> clf = KNeighborsTimeSeriesClassifierPyts(n_neighbors=1,
...     weights="uniform",
...     algorithm="auto",
...     leaf_size=30,
...     p=2,
...     metric="minkowski",
...     metric_params=None,
...     n_jobs=1,
... )  
>>> clf.fit(X_train, y_train)  
KNeighborsTimeSeriesClassifierPyts(...)
>>> 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” 集。

返回:

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

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

克隆是一个不同的对象，没有共享引用，处于初始化后状态。此函数等同于返回 self 的 sklearn.clone。

等同于构造一个 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.is_fitted 设置为 True。设置以“_”结尾的拟合模型属性。

参数:

Xsktime 兼容的时间序列面板数据容器，类型为 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

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

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对自身的引用。

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

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

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

如果 change_state=True，则写入自身

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

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

参数:

Xsktime 兼容的时间序列面板数据容器，类型为 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

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

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，则不会更改分类器的状态，即拟合/预测序列使用副本运行，自身不会改变

• 如果为 True，则将自身拟合到完整的 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 是单变量（一维）；否则，与拟合时传递的 y 类型相同。

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

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

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

如果 change_state=True，则写入自身

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

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

参数:

Xsktime 兼容的时间序列面板数据容器，类型为 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

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

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，则不会更改分类器的状态，即拟合/预测序列使用副本运行，自身不会改变

• 如果为 True，则将自身拟合到完整的 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)

获取拟合参数。

所需状态

要求状态为“已拟合”。

参数:

deepbool, 默认值=True

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

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

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

返回:

fitted_paramsdict，键为 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，但不包括组件的参数。

返回:

paramsdict，键为 str 类型

参数字典，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) 的结果

返回:

序列化后的自身在 path 处产生的输出，来自 cls.save(path)

classmethod load_from_serial(serial)

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

参数:

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

返回:

序列化后的自身产生的输出 serial，来自 cls.save(None)

predict(X)

预测 X 中序列的标签。

参数:

Xsktime 兼容的时间序列面板数据容器，类型为 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_predsktime 兼容的表格数据容器，类型为 Table scitype

预测的类标签

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

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

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

predict_proba(X)

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

参数:

Xsktime 兼容的时间序列面板数据容器，类型为 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 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，则返回一个内存中的序列化自身；如果 path 是文件位置，则将自身存储在该位置作为 zip 文件。

保存的文件是 zip 文件，包含以下内容: _metadata - 包含自身的类，即 type(self)；_obj - 序列化的自身。此类使用默认序列化方式 (pickle)。

参数:

pathNone 或 文件位置 (str 或 Path)

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

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

• path=”/home/stored/estimator”，则会在 `/home/stored/` 中创建 zip 文件 estimator.zip。

存储在 `/home/stored/` 中。

serialization_format: str, 默认值 = “pickle”

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

返回:

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

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

score(X, y) → float

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

参数:

Xsktime 兼容的时间序列面板数据容器，类型为 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

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

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 kernel 如何显示自身的实例

• “diagram” = html 框图表示

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

print_changed_onlybool, 默认值=True

打印自身时是否仅列出与默认值不同的参数 (False)，或列出所有参数名称和值 (False)。不进行嵌套，即仅影响自身而不影响组件估计器。

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

    在并行化后关闭。

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

  • “mute_warnings”：布尔值，默认值为 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')

设置自身的 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 的引用。