ShapeletLearningClassifierTslearn

class ShapeletLearningClassifierTslearn(n_shapelets_per_size=None, max_iter=10000, batch_size=256, optimizer='sgd', weight_regularizer=0.0, shapelet_length=0.15, total_lengths=3, max_size=None, scale=False, verbose=0, random_state=None)

学习时间序列 Shapelets 分类器，来自 tslearn。

直接对接 tslearn.shapelets.shapelets.LearningShapelets。

学习时间序列 Shapelets 最初发表于 [1]。

参数:

n_shapelets_per_size: 字典 (默认值: None)

一个字典，其中每个 shapelet 大小（key）对应要训练的此类 shapelet 的数量（value）。如果为 None，则使用 grabocka_params_to_shapelet_size_dict，用于计算大小的时间序列是 fit 时传入的最短时间序列。

max_iter: int (默认值: 10,000)

训练的 epoch 数量。

batch_size: int (默认值: 256)

要使用的批量大小。

optimizer: str 或 keras.optimizers.Optimizer (默认值: “sgd”)

用于训练的 keras 优化器。

weight_regularizer: float 或 None (默认值: 0.)

用于训练分类（softmax）层的 L2 正则化强度。如果为 0，则不执行正则化。

shapelet_length: float (默认值: 0.15)

Shapelets 的长度，表示为时间序列长度的一部分。仅在 n_shapelets_per_size 为 None 时使用。

total_lengths: int (默认值: 3)

不同 shapelet 长度的数量。对于 [1, total_lengths] 中的 i，将提取长度为 i * shapelet_length 的 shapelets。仅在 n_shapelets_per_size 为 None 时使用。

max_size: int 或 None (默认值: None)

馈入模型的最大时间序列大小。如果为 None，则设置为训练时间序列的大小（时间戳数量）。

scale: bool (默认值: False)

是否应缩放每个时间序列的每个特征，使其值位于 [0-1] 区间。在版本 0.4 中，此参数的默认值设置为 False 以确保向后兼容，但在未来版本中可能会更改。

verbose: {0, 1, 2} (默认值: 0)

keras 详细级别。

random_stateint 或 None, 可选 (默认值: None)

用于打乱数据时使用的伪随机数生成器的种子。如果为 int，random_state 是随机数生成器使用的种子；如果为 None，随机数生成器是 np.random 使用的 RandomState 实例。

属性:

shapelets_numpy.ndarray 对象数组，每个对象是一个时间序列

时间序列 shapelets 的集合。

shapelets_as_time_series_形状为 (n_shapelets, sz_shp, d) 的 numpy.ndarray

其中 sz_shp 是所有 shapelet 大小的最大值。格式化为 tslearn 时间序列数据集的时间序列 shapelets 集合。

transformer_model_keras.Model

将输入的时间序列数据集转换为与学习到的 shapelets 的距离。

locator_model_keras.Model

返回每个 shapelet 在输入数据集中每个时间序列中的位置索引（最小距离）。

model_keras.Model

直接预测输入时间序列的类别概率。

history_字典

拟合过程中记录的损失和指标字典。

参考文献

[1]

10. Grabocka et al. Learning Time-Series Shapelets. SIGKDD 2014.

方法

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, 默认值 = {}

用于创建类的测试实例的参数。每个字典都是构造一个“有趣的”测试实例的参数，例如 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 兼容对象都有一个标签字典。标签可用于存储对象的元数据，或控制对象的行为。

clone_tags 从另一个对象 estimator 设置动态标签覆盖。

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

动态标签设置为 estimator 中标签的值，名称由 tag_names 指定。

tag_names 的默认值将 estimator 中的所有标签写入 self。

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

estimator :class:BaseObject 或派生类的实例

参数:

tag_namesstr 或 list of str, 默认值 = None

要克隆的标签名称。默认值 (None) 克隆 estimator 中的所有标签。

self

返回:

self 的引用。

classmethod create_test_instance(parameter_set='default')

要返回的测试参数集的名称，用于测试。如果某个值没有定义特殊参数，则返回 “default” 集。

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

参数:

parameter_setstr, 默认值=”default”

instance具有默认参数的类实例

返回:

classmethod create_test_instances_and_names(parameter_set='default')

objscls 实例列表

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

参数:

parameter_setstr, 默认值=”default”

instance具有默认参数的类实例

返回:

第 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。

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

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

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

参数:

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

cvNone, int, 或 sklearn 交叉验证对象, 可选, 默认值=None

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

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 中的多输出向量索引。

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

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

y_predint 的 2D np.array, 形状为 [n_instances, n_classes]

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

写入自身，如果 change_state=True。

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

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

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

参数:

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

cvNone, int, 或 sklearn 交叉验证对象, 可选, 默认值=None

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

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

返回:

预测的类别标签概率。第 0 个索引对应 X 中的实例索引，第 1 个索引对应类别索引，顺序与 self.classes_ 中的条目顺序相同。条目是预测的类别概率，总和为 1。

classmethod get_class_tag(tag_name, tag_value_default=None)

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

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

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

它返回名称为 tag_name 的标签在对象中的值，考虑标签覆盖，优先级从高到低如下：

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

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

2. 按继承顺序。

不考虑在实例上通过 set_tags 或 clone_tags 设置的动态标签覆盖。

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

tag_namestr

参数:

标签值的名称。

tag_value_default任意类型

未找到标签时的默认/回退值。

tag_value

返回:

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

classmethod get_class_tags()

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

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

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

clone_tags 从另一个对象 estimator 设置动态标签覆盖。

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

值是对应的标签值，覆盖优先级从高到低如下：

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

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

2. 按继承顺序。

不考虑在实例上通过 set_tags 或 clone_tags 设置的动态标签覆盖。

要检索可能带有实例覆盖的标签，请使用 get_tags 方法。

要包含动态标签的覆盖，请使用 get_tags。

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

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

是否返回组件的参数。

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

参数:

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

如果为 True，将返回此对象的参数名称: 值 dict，包括组件（= BaseObject 类型参数）的参数。

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

• params键为 str 的 dict

返回:

参数字典，键值对为 paramname : paramvalue 包括

始终包含：此对象的所有参数，通过 get_param_names 获取，值为此键对应的参数值。值始终与构造时传入的值相同。

• get_tag(tag_name, tag_value_default=None, raise_error=True)

• 如果 deep=True，还包含任意级别的组件递归，例如 [componentname]__[componentcomponentname]__[paramname] 等。

• classmethod get_param_defaults()

get_tag 方法从实例中检索名称为 tag_name 的单个标签的值，考虑标签覆盖，优先级从高到低如下：

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

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

clone_tags 从另一个对象 estimator 设置动态标签覆盖。

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

1. 在实例构造时。

要检索的标签名称。

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

3. 按继承顺序。

不考虑在实例上通过 set_tags 或 clone_tags 设置的动态标签覆盖。

参数:

标签值的名称。

tag_value_default任意类型, 可选; 默认值=None

未找到标签时的默认/回退值。

raise_errorbool

未找到标签时是否引发 ValueError。

tag_valueAny

返回:

self 中 tag_name 标签的值。如果未找到，并且 raise_error 为 True，则引发错误；否则返回 tag_value_default。

ValueError, 如果 raise_error 为 True。

引发:

ValueError，如果 raise_error 为 True。

如果 tag_name 不在 self.get_tags().keys() 中，则会引发 ValueError。

get_tags()

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

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

clone_tags 从另一个对象 estimator 设置动态标签覆盖。

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

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

1. 在实例构造时。

要检索的标签名称。

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

3. 按继承顺序。

不考虑在实例上通过 set_tags 或 clone_tags 设置的动态标签覆盖。

返回:

collected_tagsdict

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

is_composite()

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

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

返回:

composite: bool

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

属性 is_fitted

是否已调用 fit。

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

返回:

bool

估计器是否已 fit。

类方法 load_from_path(serial)

从文件位置加载对象。

参数:

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

返回:

路径下 cls.save(path) 的反序列化结果 self

类方法 load_from_serial(serial)

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

参数:

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

返回:

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

predict(X)

预测 X 中序列的标签。

参数:

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

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

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 中的多输出向量索引。

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

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

predict_proba(X)

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

参数:

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

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

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

返回:

预测的类别标签概率。第 0 个索引对应 X 中的实例索引，第 1 个索引对应类别索引，顺序与 self.classes_ 中的条目顺序相同。条目是预测的类别概率，总和为 1。

预测的类别标签概率 0-th 索引对应于 X 中的实例索引 1-st 索引对应于类别索引，顺序与 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，则返回一个内存中的序列化 self；如果 path 是文件位置，则将 self 作为 zip 文件存储在该位置

保存的文件是 zip 文件，包含以下内容： _metadata - 包含 self 的类，即 type(self) _obj - 序列化的 self。此类别使用默认序列化（pickle）。

参数:

pathNone 或文件位置 (str 或 Path)

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

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

• path=”/home/stored/estimator”，则将在

存储在 /home/stored/ 中。

serialization_format: str, 默认值 = “pickle”

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

返回:

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

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

score(X, y) → float

根据 X 上的地面真值标签评分预测标签。

参数:

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

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

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

返回:

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

set_config(**config_dict)

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

参数:

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

配置名称 : 配置值 对的字典。有效的配置、值及其含义列于下方

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

jupyter 内核如何显示 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 由 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')

为自身设置 random_state 伪随机种子参数。

通过 self.get_params 找到名为 random_state 的参数，并通过 set_params 将其设置为从 random_state 派生的整数。这些整数通过 sample_dependent_seed 从链式哈希中采样，并保证种子随机生成器的伪随机独立性。

仅当 deep=True 时，根据 self_policy，适用于 self 中的 random_state 参数以及剩余的组件对象。

注意：即使 self 没有 random_state 或任何组件没有 random_state 参数，也会调用 set_params。因此，set_random_state 将重置任何 scikit-base 对象，甚至那些没有 random_state 参数的对象。

参数:

random_stateint, RandomState 实例或 None, 默认值=None

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

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

是否在 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)

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

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

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

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

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

estimator :class:BaseObject 或派生类的实例

参数:

**tag_dictdict

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

返回:

Self

对 self 的引用。