ShapeDTW

class ShapeDTW(n_neighbors=1, subsequence_length=30, shape_descriptor_function='raw', shape_descriptor_functions=None, metric_params=None)

ShapeDTW 分类器。

ShapeDTW[1] 的工作原理是首先提取描述时间序列中每个数据点周围局部邻域的子序列集。然后将这些子序列传递给形状描述符函数，该函数将这些局部邻域转换为新的表示。然后将这种新的表示发送到 DTW 中进行 1-NN 分类。

参数:

n_neighborsint, int, 设置 KNN 中的 k (默认 =1)。

subsequence_lengthint, 定义子序列的长度

(默认=sqrt(n_timepoints))。

shape_descriptor_functionstring, 定义描述函数

子序列集 (默认 = ‘raw’)。

可能的形状描述符函数如下

• ‘raw’使用原始子序列作为

  形状描述符函数。

  • params = None

• ‘paa’使用 PAA 作为形状描述符函数。

  • params = num_intervals_paa (default=8)

• ‘dwt’使用 DWT (离散小波变换)

  作为形状描述符函数。

  • params = num_levels_dwt (default=3)

• ‘slope’使用每个子序列的梯度

  由总最小二乘回归拟合，作为形状描述符函数。

  • params = num_intervals_slope (default=8)

• ‘derivative’使用每个子序列的导数

  作为形状描述符函数。

  • params = None

• ‘hog1d’使用一维梯度直方图作为

  形状描述符函数。

  • params = num_intervals_hog1d

    (default=2)

    = num_bins_hod1d

    (default=8)

    = scaling_factor_hog1d

    (default=0.1)

• ‘compound’同时使用两个形状描述符的组合。

  descriptors simultaneously.

  • params = weighting_factor

    (default=None)

    定义如何缩放形状描述符的值。如果未给出值，则通过训练数据上的 10 折交叉验证来调整此值。

shape_descriptor_functionsstring 列表，仅当以下情况适用时使用

shape_descriptor_function 设置为 ‘compound’。同时使用形状描述符函数列表。(默认 = [‘raw’,’derivative’])

metric_params用于度量参数的字典

(默认 = None)。

属性:

is_fitted

是否已调用 fit 方法。

注意

[1]

Jiaping Zhao and Laurent Itti, “shapeDTW: Shape Dynamic Time Warping”, Pattern Recognition, 74, pp 171-184, 2018 http://www.sciencedirect.com/science/article/pii/S0031320317303710,

示例

>>> from sktime.classification.distance_based import ShapeDTW
>>> 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 = ShapeDTW(n_neighbors=1,
...     subsequence_length=30,
...     shape_descriptor_function="raw",
...     shape_descriptor_functions=None,
...     metric_params=None,
... )  
>>> clf.fit(X_train, y_train)  
ShapeDTW(...)
>>> 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()	检查对象是否由其他 BaseObjects 组成。
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)	根据 X 上的真实标签对预测标签进行评分。
set_config(**config_dict)	将配置标志设置为给定值。
set_params(**params)	设置此对象的参数。
set_random_state([random_state, deep, ...])	设置 self 的 random_state 伪随机种子参数。
set_tags(**tag_dict)	将实例级标签覆盖设置为给定值。

check_is_fitted(method_name=None)

检查估计器是否已拟合。

检查 _is_fitted 属性是否存在且为 True。对象的 fit 方法调用中应将 is_fitted 属性设置为 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)

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

状态更改

将状态更改为“fitted”。

写入 self

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

参数:

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

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

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

• pd-multiindex: pd.DataFrame with columns = variables, index = pd.MultiIndex with first level = instance indices, second level = time indices

• numpy3D: 3D np.array (any number of dimensions, equal length series) of shape [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对 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 with columns = variables, index = pd.MultiIndex with first level = instance indices, second level = time indices

• numpy3D: 3D np.array (any number of dimensions, equal length series) of shape [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，将不会更改分类器的状态，即 fit/predict 序列使用副本运行，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 with columns = variables, index = pd.MultiIndex with first level = instance indices, second level = time indices

• numpy3D: 3D np.array (any number of dimensions, equal length series) of shape [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，将不会更改分类器的状态，即 fit/predict 序列使用副本运行，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

tag_name 标签在 self 中的值。如果未找到，则返回 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 类型的字典

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

tag_name 标签在 self 中的值。如果未找到，且 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 对象属性的任何覆盖和新标签。

classmethod get_test_params(parameter_set='default')

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

参数:

parameter_setstr, 默认=”default”

要返回的测试参数集的名称，用于测试。如果未为某个值定义特殊参数，将返回 "default" 集。

返回:

paramsdict 或 dict 列表，默认 = {}

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

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 with columns = variables, index = pd.MultiIndex with first level = instance indices, second level = time indices

• numpy3D: 3D np.array (any number of dimensions, equal length series) of shape [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 是一元（一维）；否则，与 fit 中传入的 y 类型相同

predict_proba(X)

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

参数:

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

需要预测标签的时间序列。

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

• pd-multiindex: pd.DataFrame with columns = variables, index = pd.MultiIndex with first level = instance indices, second level = time indices

• numpy3D: 3D np.array (any number of dimensions, equal length series) of shape [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')

将序列化的 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, default = “pickle”

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

返回:

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

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

score(X, y) → float

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

参数:

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

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

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

• pd-multiindex: pd.DataFrame with columns = variables, index = pd.MultiIndex with first level = instance indices, second level = time indices

• numpy3D: 3D np.array (any number of dimensions, equal length series) of shape [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 内核如何显示 self 实例。

• “diagram” = html 框图表示。

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

print_changed_onlybool，默认=True

打印 self 时是否只列出与默认值不同的参数 (True)，或列出所有参数名称和值 (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，则抑制警告。

  • 。如果为 True，则抑制警告。

返回:

self对 self 的引用。

注意

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

set_params(**params)

设置此对象的参数。

此方法适用于简单的 skbase 对象以及复合对象。对于复合对象，即包含其他对象的对象，可以使用参数键字符串 <component>__<parameter> 来访问组件 <component> 中的 <parameter>。如果引用明确，例如没有两个组件参数同名为 <parameter>，也可以使用字符串 <parameter> 而不带 <component>__。

参数:

**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 的参数，并使用链式哈希通过 sample_dependent_seed 将它们设置为从 random_state 派生的整数。这些整数保证了伪随机生成器的种子独立性。

根据 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 的引用。