ShapeletTransformClassifier#

class ShapeletTransformClassifier(n_shapelet_samples=10000, max_shapelets=None, max_shapelet_length=None, estimator=None, transform_limit_in_minutes=0, time_limit_in_minutes=0, contract_max_n_shapelet_samples=inf, save_transformed_data=False, n_jobs=1, batch_size=100, random_state=None)[source]#

一个 shapelet 变换分类器 (STC)。

实现了二元 shapelet 变换分类器管道，其思路类似于 [1][2]，但采用了随机 shapelet 采样。它使用可配置的 RandomShapeletTransform 对数据进行变换，然后构建一个 RotationForest 分类器。

由于某些实现和应用仅对变换进行收缩，因此收缩功能可用于仅变换以及分类器和变换两者。

参数:

n_shapelet_samplesint, 默认值=10000: 考虑用于最终变换的候选 shapelet 数量。过滤到 <= max_shapelets 个，保留信息增益最高的 shapelet。
max_shapeletsint 或 None, 默认值=None: 最终变换要保留的最大 shapelet 数量。每个类别值将有自己的最大值，设置为 n_classes_ / max_shapelets。如果为 None，则使用 10 * n_instances_ 和 1000 之间的最小值。
max_shapelet_lengthint 或 None, 默认值=None: 候选 shapelet 长度的下界。如果为 None，则不使用最大长度
estimatorBaseEstimator 或 None, 默认值=None: 集成模型的基估计器，可以提供一个 sklearn BaseEstimator。如果为 None，则使用默认的 RotationForest 分类器。
transform_limit_in_minutesint, 默认值=0: 时间契约，用于限制 shapelet 变换的时间（以分钟为单位），这会覆盖 n_shapelet_samples。值为 0 表示使用 n_shapelet_samples。
time_limit_in_minutesint, 默认值=0: 时间契约，用于限制构建时间（以分钟为单位），这会覆盖 n_shapelet_samples 和 transform_limit_in_minutes。只有当存在 time_limit_in_minutes parameter 参数时，estimator 才会进行收缩。默认值 0 表示使用 n_shapelet_samples 或 transform_limit_in_minutes。
contract_max_n_shapelet_samplesint, 默认值=np.inf: 当使用 transform_limit_in_minutes 或 time_limit_in_minutes 进行变换收缩时，要提取的最大 shapelet 数量。
save_transformed_databool, 默认值=False: 将 fit 中变换后的数据保存在 transformed_data_ 中，以便在 _get_train_probs 中使用。
n_jobsint, 默认值=1: 在 fit 和 predict 中并行运行的作业数。-1 表示使用所有处理器。
batch_sizeint 或 None, 默认值=100: 在变换中合并到最佳 shapelet 集合之前处理的候选 shapelet 数量。
random_stateint, RandomState 实例或 None, 默认值=None: 如果为 int，则 random_state 是随机数生成器使用的种子；如果为 RandomState 实例，则 random_state 是随机数生成器；如果为 None，则随机数生成器是 np.random 使用的 RandomState 实例。

属性:

classes_list: 训练集中的唯一类别标签。
n_classes_int: 训练集中的唯一类别数量。
fit_time_int: fit 运行所需的时间（以毫秒为单位）。
n_instances_int: 训练集中的训练样本数量。
n_dims_int: 训练集中每个样本的维度数量。
series_length_int: 训练集中每个序列的长度。
transformed_data_list of shape (n_estimators) of ndarray: 所有分类器的变换训练数据集。仅当 save_transformed_data 为 True 时保存。

另请参阅

RandomShapeletTransform: 随机采样的 shapelet 变换。
RotationForest: 使用的默认旋转森林分类器。

注意

对于 Java 版本，请参阅 tsml。

参考文献

[1]

Jon Hills 等人，“Classification of time series by shapelet transformation”，Data Mining and Knowledge Discovery，28(4)，851–881，2014。

[2]

A. Bostrom 和 A. Bagnall，“Binary Shapelet Transform for Multiclass Time Series Classification”，Transactions on Large-Scale Data and Knowledge Centered Systems，32，2017。

示例

>>> from sktime.classification.shapelet_based import ShapeletTransformClassifier
>>> from sktime.classification.sklearn import RotationForest
>>> from sktime.datasets import load_unit_test
>>> X_train, y_train = load_unit_test(split="train", return_X_y=True)
>>> X_test, y_test = load_unit_test(split="test", return_X_y=True) 
>>> clf = ShapeletTransformClassifier(
...     estimator=RotationForest(n_estimators=3),
...     n_shapelet_samples=100,
...     max_shapelets=10,
...     batch_size=20,
... ) 
>>> clf.fit(X_train, y_train) 
ShapeletTransformClassifier(...)
>>> 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)	根据 X 上的真实标签评估预测标签的得分。
`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" 集。对于分类器，应提供一组“default”参数用于一般测试，如果通用集无法产生适合比较的概率，则提供一组“results_comparison”用于与先前记录的结果进行比较。

返回:

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

check_is_fitted(method_name=None)[source]#

检查估计器是否已拟合。

检查 _is_fitted 属性是否存在且为 True。is_fitted 属性应在调用对象的 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 或 list of 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.is_fitted 设置为 True。设置以“_”结尾的已拟合模型属性。

参数:

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

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

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

pd-multiindex: pd.DataFrame 格式，列 = 变量，索引 = pd.MultiIndex 格式，第一级索引 = 实例索引，第二级索引 = 时间索引
numpy3D: 3D np.array 格式（任意维数，等长序列），形状为 [n_实例数, n_维数, 序列长度]
或任何其他支持的 Panel mtype 格式

mtypes 列表，参见 datatypes.SCITYPE_REGISTER

具体说明，参见 examples/AA_datatypes_and_datasets.ipynb

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

ysktime 兼容的表格数据容器，类型为 Table scitype

1D 可迭代对象，形状为 [n_实例数]，或 2D 可迭代对象，形状为 [n_实例数, n_维数] 用于拟合的类别标签 0 级索引对应于 X 中的实例索引 1 级索引（如果适用）对应于 X 中的多输出向量索引支持的 sktime 类型：np.ndarray (1D, 2D), pd.Series, pd.DataFrame

返回:

self对自身的引用。

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

对 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_实例数, n_维数, 序列长度]
或任何其他支持的 Panel mtype 格式

mtypes 列表，参见 datatypes.SCITYPE_REGISTER

具体说明，参见 examples/AA_datatypes_and_datasets.ipynb

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

ysktime 兼容的表格数据容器，类型为 Table scitype

1D 可迭代对象，形状为 [n_实例数]，或 2D 可迭代对象，形状为 [n_实例数, n_维数] 用于拟合的类别标签 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，则不会改变分类器的状态，即拟合/预测序列使用副本运行，self 不变
如果为 True，则将 self 拟合到完整的 X 和 y，最终状态将等同于运行 fit(X, y)

返回:

y_predsktime 兼容的表格数据容器，类型为 Table scitype

预测的类别标签

1D 可迭代对象，形状为 [n_实例数]，或 2D 可迭代对象，形状为 [n_实例数, n_维数]。

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.is_fitted 设置为 True。设置以“_”结尾的已拟合模型属性。

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

参数:

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

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

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

pd-multiindex: pd.DataFrame 格式，列 = 变量，索引 = pd.MultiIndex 格式，第一级索引 = 实例索引，第二级索引 = 时间索引
numpy3D: 3D np.array 格式（任意维数，等长序列），形状为 [n_实例数, n_维数, 序列长度]
或任何其他支持的 Panel mtype 格式

mtypes 列表，参见 datatypes.SCITYPE_REGISTER

具体说明，参见 examples/AA_datatypes_and_datasets.ipynb

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

ysktime 兼容的表格数据容器，类型为 Table scitype

1D 可迭代对象，形状为 [n_实例数]，或 2D 可迭代对象，形状为 [n_实例数, n_维数] 用于拟合的类别标签 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，则不会改变分类器的状态，即拟合/预测序列使用副本运行，self 不变
如果为 True，则将 self 拟合到完整的 X 和 y，最终状态将等同于运行 fit(X, y)

返回:

y_pred2D np.array，int 类型，形状为 [n_实例数, n_类别数]: 预测的类别标签概率 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 的配置标志。

Configs 是 self 的键值对，通常用作控制行为的临时标志。

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

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

Configs 在 clone 或 reset 调用下保留。

返回:

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

get_fitted_params(deep=True)[source]#

获取已拟合参数。

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

参数:

deepbool，默认为 True

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

如果为 True，则将返回此对象的参数名称 : 值字典，包括可拟合组件的已拟合参数（= BaseEstimator 类型参数）。
如果为 False，则将返回此对象的参数名称 : 值字典，但不包含组件的已拟合参数。

返回:

fitted_params键为 str 类型的 dict

已拟合参数字典，参数名 : 参数值键值对包含

始终：此对象的所有已拟合参数，通过 get_param_names 获取值为此对象该键的已拟合参数值
如果 deep=True，也包含组件参数的键/值对组件参数索引为 [组件名称]__[参数名称] 组件名称 的所有参数都以 参数名称 及其值的形式出现
如果 deep=True，也包含任意级别的组件递归，例如 [组件名称]__[组件组件名称]__[参数名称] 等

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

参数字典，参数名 : 参数值键值对包含

始终：此对象的所有参数，通过 get_param_names 获取值为此对象该键的参数值值始终与构造时传入的值相同
如果 deep=True，也包含组件参数的键/值对组件参数索引为 [组件名称]__[参数名称] 组件名称 的所有参数都以 参数名称 及其值的形式出现
如果 deep=True，也包含任意级别的组件递归，例如 [组件名称]__[组件组件名称]__[参数名称] 等

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]#

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

参数:

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

返回:

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

predict(X)[source]#

预测 X 中序列的标签。

参数:

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

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

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

pd-multiindex: pd.DataFrame 格式，列 = 变量，索引 = pd.MultiIndex 格式，第一级索引 = 实例索引，第二级索引 = 时间索引
numpy3D: 3D np.array 格式（任意维数，等长序列），形状为 [n_实例数, n_维数, 序列长度]
或任何其他支持的 Panel mtype 格式

mtypes 列表，参见 datatypes.SCITYPE_REGISTER

具体说明，参见 examples/AA_datatypes_and_datasets.ipynb

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

返回:

y_predsktime 兼容的表格数据容器，类型为 Table scitype

预测的类别标签

1D 可迭代对象，形状为 [n_实例数]，或 2D 可迭代对象，形状为 [n_实例数, n_维数]。

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

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

predict_proba(X)[source]#

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

参数:

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

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

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

pd-multiindex: pd.DataFrame 格式，列 = 变量，索引 = pd.MultiIndex 格式，第一级索引 = 实例索引，第二级索引 = 时间索引
numpy3D: 3D np.array 格式（任意维数，等长序列），形状为 [n_实例数, n_维数, 序列长度]
或任何其他支持的 Panel mtype 格式

mtypes 列表，参见 datatypes.SCITYPE_REGISTER

具体说明，参见 examples/AA_datatypes_and_datasets.ipynb

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

返回:

y_pred2D np.array，int 类型，形状为 [n_实例数, n_类别数]: 预测的类别标签概率 0 级索引对应于 X 中的实例索引 1 级索引对应于类别索引，顺序与 self.classes_ 中的顺序相同值为预测类别概率，总和为 1

reset()[source]#

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

结果是将 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')[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”，则将在当前工作目录创建 zip 文件 estimator.zip。
path=”/home/stored/estimator”，则 zip 文件 estimator.zip 将被

存储在 /home/stored/ 中。

serialization_format: str，默认为 “pickle”

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

返回:

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

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

根据 X 上的真实标签评估预测标签的得分。

参数:

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

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

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

pd-multiindex: pd.DataFrame 格式，列 = 变量，索引 = pd.MultiIndex 格式，第一级索引 = 实例索引，第二级索引 = 时间索引
numpy3D: 3D np.array 格式（任意维数，等长序列），形状为 [n_实例数, n_维数, 序列长度]
或任何其他支持的 Panel mtype 格式

mtypes 列表，参见 datatypes.SCITYPE_REGISTER

具体说明，参见 examples/AA_datatypes_and_datasets.ipynb

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

ysktime 兼容的表格数据容器，类型为 Table scitype

1D 可迭代对象，形状为 [n_实例数]，或 2D 可迭代对象，形状为 [n_实例数, n_维数] 用于拟合的类别标签 0 级索引对应于 X 中的实例索引 1 级索引（如果适用）对应于 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 内核如何显示 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对自身的引用。

注意

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

set_params(**params)[source]#

设置此对象的参数。

该方法适用于简单的 skbase 对象以及组合对象。参数键字符串 <component>__<parameter> 可用于组合对象（即包含其他对象的对象），以访问组件 <component> 中的 <parameter>。如果引用 unambiguous，也可以使用不带 <component>__ 的字符串 <parameter>，例如没有两个组件参数具有相同的名称 <parameter>。

参数:

**paramsdict: BaseObject 参数，键必须是 <component>__<parameter> 字符串。如果 `__` 后缀在 get_params 键中是唯一的，则可以作为完整字符串的别名。

返回:

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 中的 random_state 参数，取决于 self_policy，并且当且仅当 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对自身的引用

set_tags(**tag_dict)[source]#

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

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

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

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

set_tags 方法只能在对象的 __init__ 方法中（在构造期间），或通过 __init__ 构造后直接调用。

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

参数:

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

返回:

Self: 对自身的引用。