ShapeletLearningClassifierPyts

class ShapeletLearningClassifierPyts(loss='softmax', n_shapelets_per_size=0.2, min_shapelet_length=0.1, shapelet_scale=3, penalty='l2', tol=0.001, C=1000, learning_rate=1.0, max_iter=1000, multi_class='multinomial', alpha=-100, fit_intercept=True, intercept_scaling=1.0, class_weight=None, n_jobs=None, verbose=0, random_state=None)

学习 Shapelets 算法，来自 pyts。

直接接口到 pyts.classification.LearningShapelets 或 pyts.classification.LearningShapeletsCrossEntropy，接口类的作者是 johannfaouzi。

根据 loss 参数的值，分派到 LearningShapelets 或 LearningShapeletsCrossEntropy。

此估计器包含两个步骤：计算 shapelets 和时间序列之间的距离，然后使用这些距离作为线性特征进行经验风险最小化。风险通过梯度下降最小化；对于 loss="softmax"，这在数学上等同于在 shapelet 特征上进行多项式逻辑回归。此算法学习 shapelets 以及分类的系数。

参数:

lossstr (默认值 = ‘softmax’)，“softmax” 或 “crossentropy”

要使用的损失函数。如果为“softmax”，则损失函数为 softmax 函数（逻辑损失）。分派到 LearningShapelets。如果为“crossentropy”，则损失函数为交叉熵损失。分派到 LearningShapeletsCrossEntropy。

n_shapelets_per_sizeint 或 float (默认值 = 0.2)

每种大小的 shapelets 数量。如果为 float，则表示时间戳数量的一部分，并且每种大小的 shapelets 数量等于 ceil(n_shapelets_per_size * n_timestamps)。

min_shapelet_lengthint 或 float (默认值 = 0.1)

shapelets 的最小长度。如果为 float，则表示时间戳数量的一部分，并且每种大小的 shapelets 的最小长度等于 ceil(min_shapelet_length * n_timestamps)。

shapelet_scaleint (默认值 = 3)

shapelets 长度的不同尺度。shapelets 的长度等于 min_shapelet_length * np.arange(1, shapelet_scale + 1)。shapelets (和特征) 的总数等于 n_shapelets_per_size * shapelet_scale。

penalty‘l1’ 或 ‘l2’ (默认值 = ‘l2’)

用于指定惩罚中使用的范数。

tolfloat (默认值 = 1e-3)

停止标准的容忍度。

Cfloat (默认值 = 1000)

正则化强度的倒数。必须是正浮点数。值越小，正则化越强。

learning_ratefloat (默认值 = 1.)

梯度下降优化的学习率。必须是正浮点数。请注意，如果损失函数没有下降，学习率将自动降低。

max_iterint (默认值 = 1000)

梯度下降算法的最大迭代次数。

multi_class{‘multinomial’, ‘ovr’, ‘ovo’} (默认值 = ‘multinomial’)

多类别分类策略。仅当 loss="softmax" 时使用。选项如下：‘multinomial’ 表示多项式交叉熵损失。‘ovr’ 表示一对多（one-vs-rest）策略。‘ovo’ 表示一对一（one-vs-one）策略。如果分类任务是二元的，则忽略此参数。

alphafloat (默认值 = -100)

softmin 函数中的缩放项。值越低，软最小值越精确。对于标准化时间序列，默认值应该不错。

fit_interceptbool (默认值 = True)

指定是否应将常数（即偏置或截距）添加到决策函数中。

intercept_scalingfloat (默认值 = 1.)

截距的缩放。仅当 fit_intercept=True 时使用。

class_weightdict, None 或 ‘balanced’ (默认值 = None)

与类别相关的权重，形式为 {class_label: weight}。如果未给出，则所有类别的权重都假定为单位权重。“balanced” 模式使用 y 的值自动调整权重，使其与输入数据中类别的频率成反比，计算方式为 n_samples / (n_classes * np.bincount(y))。

n_jobsNone 或 int (默认值 = None)

用于计算的作业数。仅当 loss="softmax" 且 multi_class 为“ovr”或“ovo”时使用。

verboseint (默认值 = 0)

控制详细程度。必须是非负整数。如果为正，则打印每次迭代的损失。

random_stateNone, int 或 RandomState 实例 (默认值 = None)

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

属性:

shapelets_数组 shape = (n_tasks, n_shapelets)

学到的 shapelets。此数组的每个元素都是一个学到的 shapelet。

coef_数组, shape = (n_tasks, n_shapelets) 或 (n_classes, n_shapelets)

决策函数中每个 shapelet 的系数。

intercept_数组, shape = (n_tasks,) 或 (n_classes,)

添加到决策函数中的截距（即偏置）。如果 fit_intercept=False，则截距设置为零。

n_iter_数组, shape = (n_tasks,)

实际迭代次数。

注意

任务数（n_tasks）取决于 multi_class 的值和类别数。如果有两个类别，任务数等于 1。如果类别数多于两个，任务数等于

• 1 如果 multi_class='multinomial'

• n_classes 如果 multi_class='ovr'

• n_classes * (n_classes - 1) / 2 如果 multi_class='ovo'

参考文献

[1]

J. Grabocka, N. Schilling, M. Wistuba and L. Schmidt-Thieme, “Learning Time-Series Shapelets”. International Conference on Data Mining, 14, 392-401 (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 或 dict 列表, 默认值 = {}

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

check_is_fitted(method_name=None)

检查估计器是否已拟合。

检查 _is_fitted` attribute that should initialize to ``False 属性是否存在且为 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 个元素是测试中 obj 的第 i 个实例的名称。命名约定是 {cls.__name__}-{i} 如果多于一个实例，否则为 {cls.__name__}

fit(X, y)

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

状态变化

将状态更改为“已拟合”。

写入自身

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

参数:

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

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

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

• pd-multiindex: pd.DataFrame，列为 variables，索引为 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 类型

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

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

• pd-multiindex: pd.DataFrame，列为 variables，索引为 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，将不改变分类器的状态，即，fit/predict 序列使用副本运行，自身不变

• 如果为 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 为单变量（一维）；否则，与 fit 中传入的 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 类型

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

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

• pd-multiindex: pd.DataFrame，列为 variables，索引为 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，将不改变分类器的状态，即，fit/predict 序列使用副本运行，自身不变

• 如果为 True，将用完整的 X 和 y 拟合自身，结束状态将等效于运行 fit(X, y)

返回:

y_pred2D int 类型的 np.array, 形状为 [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)

获取拟合参数。

所需状态

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

• 如果为 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

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

引发:

如果 raise_error 为 True，则为 ValueError。

如果 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) 的结果

返回:

反序列化的 self，其结果位于 path 处，来自 cls.save(path)

classmethod load_from_serial(serial)

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

参数:

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

返回:

反序列化的 self，其结果为 serial，来自 cls.save(None)

predict(X)

预测 X 中序列的标签。

参数:

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

要预测标签的时间序列。

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

• pd-multiindex: pd.DataFrame，列为 variables，索引为 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 为单变量（一维）；否则，与 fit 中传入的 y 类型相同

predict_proba(X)

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

参数:

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

要预测标签的时间序列。

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

• pd-multiindex: pd.DataFrame，列为 variables，索引为 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 int 类型的 np.array, 形状为 [n_instances, n_classes]

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

reset()

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

导致 self 设置为构造函数调用后直接的状态，具有相同的超参数。通过 set_config 设置的配置值也会保留。

reset 调用会删除任何对象属性，除了

• 超参数 = __init__ 的参数，写入 self，例如 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”，则会在当前工作目录创建 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 类型

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

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

• pd-multiindex: pd.DataFrame，列为 variables，索引为 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 内核如何显示 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)

设置此对象的参数。

此方法适用于简单的 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 的引用。