KNeighborsTimeSeriesClassifierTslearn#

class KNeighborsTimeSeriesClassifierTslearn(n_neighbors=5, weights='uniform', metric='dtw', metric_params=None, n_jobs=None, verbose=0)[source]#

K 近邻时间序列分类器，来自 tslearn。

直接接口到 tslearn.neighbors.KNeighborsTimeSeriesClassifier。

参数:

n_neighborsint (默认值: 5)

用于决策的最近邻居数量。

weightsstr 或 callable，可选 (默认值: ‘uniform’)

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

‘uniform’ : 统一权重。邻域中的所有点都被等权重处理。
‘distance’ : 按距离的倒数加权。在这种情况下，查询点更近的邻居将比更远的邻居具有更大的影响。
[callable] : 用户定义的函数，接受一个距离数组，并返回一个包含权重的相同形状的数组。

metric{‘dtw’, ‘softdtw’, ‘ctw’, ‘euclidean’, ‘sqeuclidean’, ‘cityblock’, ‘sax’}

默认值: ‘dtw’。用于最近邻过程核心的度量。当提供 'sax' 作为度量时，期望数据已被归一化，使得每个时间序列的均值为零，方差为单位。 'euclidean', 'sqeuclidean', 'cityblock' 在 scipy.spatial.distance 文档中描述。

metric_paramsdict 或 None (默认值: None)

度量参数字典。对于接受交叉距离矩阵计算并行化的度量，metric_params 中传递的 n_jobs 和 verbose 键将被 n_jobs 和 verbose 参数覆盖。对于 'sax' 度量，这些是在创建 SymbolicAggregateApproximation 对象时要传递的超参数。

n_jobsint 或 None，可选 (默认值=None)

用于交叉距离矩阵计算的并行运行的作业数量。如果无法使用并行化计算交叉距离矩阵，则忽略。 None 表示 1，除非在 joblib.parallel_backend 上下文中。 -1 表示使用所有处理器。

verboseint，可选 (默认值=0)

详细程度级别：如果非零，则打印进度消息。高于 50 时，输出发送到 stdout。消息的频率随着详细程度级别增加。如果大于 10，则报告所有迭代。

属性:

is_fitted: 是否已调用 fit 方法。

示例

>>> import sktime.classification.distance_based as db_clf  
>>> from db_clf import KNeighborsTimeSeriesClassifierTslearn  
>>> 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 = KNeighborsTimeSeriesClassifierTslearn(
...     n_neighbors=5,
...     weights="uniform",
...     metric="dtw",
...     metric_params=None,
...     n_jobs=None,
...     verbose=0,
... )  
>>> clf.fit(X_train, y_train)  
KNeighborsTimeSeriesClassifierTslearn(...)
>>> 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_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)	从序列化内存容器加载对象。
`predict`(X)	预测 X 中序列的标签。
`predict_proba`(X)	预测 X 中序列的标签概率。
`reset`()	将对象重置为干净的初始化后状态。
`save`([path, serialization_format])	将序列化的 self 保存到字节类对象或 (.zip) 文件。
`score`(X, y) → float[source]#	用于对预测标签进行评分的时间序列。
`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')[source]#

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

参数:

parameter_setstr, 默认值=”default”: 要返回的测试参数集名称，用于测试中。如果没有为某个值定义特殊参数，将返回 "default" 集。

返回:

paramsdict 或 list of dict，默认值 = {}: 用于创建类测试实例的参数。每个 dict 都是构造一个“有趣的”测试实例的参数，即 MyClass(**params) 或 MyClass(**params[i]) 创建一个有效的测试实例。create_test_instance 使用 params 中的第一个（或唯一一个）字典。

check_is_fitted(method_name=None)[source]#

检查估计器是否已拟合。

检查估计器是否已拟合。_is_fitted 属性应在对象构造期间初始化为 True，并在调用对象的 fit 方法时设置为 True。

如果未拟合，则引发 NotFittedError。

参数:

method_namestr，可选: 调用此方法的函数名称。如果提供，错误消息将包含此信息。

引发:

NotFittedError: 如果估计器尚未拟合。

clone()[source]#

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

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

从另一个对象克隆标签作为动态覆盖。

每个 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')[source]#

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

参数:

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

返回:

instance具有默认参数的类实例

classmethod create_test_instances_and_names(parameter_set='default')[source]#

创建所有测试实例的列表及其名称列表。

参数:

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)[source]#

使用训练数据拟合时间序列分类器。

状态变化: 将状态更改为“已拟合”。
写入 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-th 索引对应于 X 中的实例索引 1-st 索引（如果适用）对应于 X 中的多输出向量索引支持的 sktime 类型：np.ndarray (1D, 2D), pd.Series, pd.DataFrame

返回:

self对 self 的引用。

fit_predict(X, y, cv=None, change_state=True)[source]#

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

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

如果 change_state=True，写入 self: 将 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-th 索引对应于 X 中的实例索引 1-st 索引（如果适用）对应于 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 兼容的表格数据容器，属于表格 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)[source]#

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

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

如果 change_state=True，写入 self: 将 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-th 索引对应于 X 中的实例索引 1-st 索引（如果适用）对应于 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)[source]#

从类获取类标签值，具有从父类的标签级别继承。

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

`get_class_tag` 方法是一个类方法，它只考虑类级别的标签值和覆盖来检索标签的值。

它返回对象中名称为 tag_name 的标签值，同时考虑标签覆盖，优先级按以下降序排列

设置在类的 _tags 属性中的标签。
设置在父类 _tags 属性中的标签，

按继承顺序排列。

不考虑实例上通过 set_tags 或 clone_tags 设置的动态标签覆盖，这些覆盖是针对实例定义的。

要检索可能包含实例覆盖的标签值，请改用 get_tag 方法。

参数:

tag_namestr: 标签值的名称。
tag_value_default任意类型: 如果未找到标签，则使用的默认/备用值。

返回:

tag_value: `self` 中 tag_name 标签的值。如果未找到，则返回 tag_value_default。

classmethod get_class_tags()[source]#

从类获取类标签，具有从父类的标签级别继承。

每个 scikit-base 兼容对象都有一个标签字典。标签可用于存储对象的元数据或控制对象的行为。

标签是特定于实例 self 的键值对，它们是对象构造后不会更改的静态标志。

`get_class_tags` 方法是一个类方法，它只考虑类级别的标签值和覆盖来检索标签的值。

它返回一个字典，其键是类或其任何父类中设置的任何 _tags 属性的键。

值是相应的标签值，覆盖优先级按以下降序排列

设置在类的 _tags 属性中的标签。
设置在父类 _tags 属性中的标签，

按继承顺序排列。

实例可以根据超参数覆盖这些标签。

要检索可能包含实例覆盖的标签，请改用 get_tags 方法。

不考虑实例上通过 set_tags 或 clone_tags 设置的动态标签覆盖，这些覆盖是针对实例定义的。

对于包含来自动态标签的覆盖，请使用 get_tags。

collected_tagsdict: 标签名称：标签值对的字典。通过嵌套继承从 _tags 类属性收集。不会被 set_tags 或 clone_tags 设置的动态标签覆盖。

get_config()[source]#

获取 self 的配置标志。

配置是 self 的键值对，通常用作控制行为的瞬态标志。

`get_config` 返回动态配置，这些配置会覆盖默认配置。

默认配置在类或其父类的类属性 _config 中设置，并被通过 set_config 设置的动态配置覆盖。

配置在 clone 或 reset 调用中保留。

返回:

config_dictdict: 配置名称：配置值对的字典。通过嵌套继承从 _config 类属性收集，然后从 _onfig_dynamic 对象属性获取任何覆盖和新标签。

get_fitted_params(deep=True)[source]#

获取已拟合参数。

所需状态: 要求状态为“已拟合”。

参数:

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()[source]#

获取对象的默认参数。

返回:

default_dict: dict[str, Any]: 键是 cls 中所有在 __init__ 中定义了默认值的参数。值是 __init__ 中定义的默认值。

classmethod get_param_names(sort=True)[source]#

获取对象的参数名称。

参数:

sortbool，默认为 True: 是否按字母顺序返回参数名称 (True)，或按它们在类 __init__ 中出现的顺序返回 (False)。

返回:

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

get_params(deep=True)[source]#

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

参数:

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)[source]#

从实例获取标签值，具有标签级别继承和覆盖。

每个 scikit-base 兼容对象都有一个标签字典。标签可用于存储对象的元数据或控制对象的行为。

标签是特定于实例 self 的键值对，它们是对象构造后不会更改的静态标志。

`get_tag` 方法从实例中检索名称为 tag_name 的单个标签值，同时考虑标签覆盖，优先级按以下降序排列

通过 set_tags 或 clone_tags 在实例上设置的标签，

在实例构造时。

设置在类的 _tags 属性中的标签。
设置在父类 _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()[source]#

从实例获取标签，具有标签级别继承和覆盖。

每个 scikit-base 兼容对象都有一个标签字典。标签可用于存储对象的元数据或控制对象的行为。

标签是特定于实例 self 的键值对，它们是对象构造后不会更改的静态标志。

`get_tags` 方法返回一个标签字典，其键是类或其任何父类中设置的任何 _tags 属性的键，或者通过 set_tags 或 clone_tags 设置的标签。

值是相应的标签值，覆盖优先级按以下降序排列

通过 set_tags 或 clone_tags 在实例上设置的标签，

在实例构造时。

设置在类的 _tags 属性中的标签。
设置在父类 _tags 属性中的标签，

按继承顺序排列。

返回:

collected_tagsdict: 标签名称：标签值对的字典。通过嵌套继承从 _tags 类属性收集，然后从 _tags_dynamic 对象属性获取任何覆盖和新标签。

is_composite()[source]#

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

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

返回:

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

property is_fitted[source]#

是否已调用 fit 方法。

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

返回:

bool: 估计器是否已 fit（拟合）。

classmethod load_from_path(serial)[source]#

从文件位置加载对象。

参数:

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

返回:

反序列化的 self，结果输出到 path，这是 cls.save(path) 的输出。

classmethod load_from_serial(serial)[source]#

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

参数:

serial`cls.save(None)` 输出的第一个元素

返回:

反序列化的 self，结果输出 serial，这是 cls.save(None) 的输出。

predict(X)[source]#

预测 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_predsktime 兼容的表格数据容器，属于表格 scitype

预测的类别标签

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

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

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

predict_proba(X)[source]#

预测 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()[source]#

将对象重置为干净的初始化后状态。

结果是将 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')[source]#

将序列化的 self 保存到字节类对象或 (.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”，则 estimator.zip zip 文件将

存储在 /home/stored/ 中。

serialization_format: str，默认为 “pickle”

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

返回:

如果 path 为 None - 内存中的序列化 self
如果 path 是文件位置 - 引用该文件的 ZipFile

score(X, y) → float[source]#

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

参数:

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-th 索引对应于 X 中的实例索引 1-st 索引（如果适用）对应于 X 中的多输出向量索引支持的 sktime 类型：np.ndarray (1D, 2D), pd.Series, pd.DataFrame

返回:

float，predict(X) 对比 y 的准确率得分

set_config(**config_dict)[source]#

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

参数:

config_dictdict

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

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

jupyter kernel 如何显示 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)[source]#

设置此对象的参数。

该方法适用于简单的 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')[source]#

设置 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)[source]#

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

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

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

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

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

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

参数:

**tag_dictdict: 标签名称：标签值对的字典。

返回:

Self: 对 self 的引用。