SklearnClassifierPipeline#

class SklearnClassifierPipeline(classifier, transformers)[source]#

由转换器和分类器组成的管道。

SklearnClassifierPipeline 将转换器和一个单一分类器串联起来。: 类似于 ClassifierPipeline，但使用表格型 sklearn 分类器。
该管道由一个 sktime 转换器列表以及一个分类器构成，: 即遵循 BaseTransformer 接口的转换器，分类器遵循 scikit-learn 分类器接口。
转换器列表可以未命名——一个简单的转换器列表——: 或字符串命名——一个由字符串和估计器组成的对的列表。

对于转换器列表 trafo1, trafo2, …, trafoN 和分类器 clf，

该管道的行为如下：

fit(X, y) - 通过对 X 运行 trafo1.fit_transform 来改变状态，: 然后依次对 trafo1.fit_transform 的输出运行 trafo2.fit_transform，以此类推，其中 trafo[i] 接收 trafo[i-1] 的输出，然后使用转换为 numpy 的 trafo[N] 输出作为 X，并使用与 self.fit 输入相同的 y 来运行 clf.fit。如果 X 是 Panel scitype，则 X 会被转换为 numpyflat mtype；如果 X 是 Table scitype，则 X 会被转换为 numpy2D mtype。

predict(X) - 结果是对 X 执行 trafo1.transform, trafo2.transform 等操作，

其中 trafo[i].transform 的输入是 trafo[i-1].transform 的输出，然后对转换为 numpy 的 trafoN.transform 输出运行 clf.predict，并返回 clf.predict 的输出。与 fit 中一样，trafoN.transform 的输出会转换为 numpy。

predict_proba(X) - 结果是对 X 执行 trafo1.transform, trafo2.transform 等操作，

其中 trafo[i].transform 的输入是 trafo[i-1].transform 的输出，然后对 trafoN.transform 的输出运行 clf.predict_proba，并返回 clf.predict_proba 的输出。与 fit 中一样，trafoN.transform 的输出会转换为 numpy。

get_params, set_params 使用 sklearn 兼容的嵌套接口

如果列表未命名，则名称将作为类名生成；如果名称不唯一，则在每个名称字符串后附加 f"_{str(i)}"

其中 i 是非唯一字符串在该名称列表中（包括其自身）出现的总次数

SklearnClassifierPipeline 也可以通过魔术乘法创建，

在 sktime 转换器和 sklearn 分类器之间，: 如果 my_trafo1, my_trafo2 继承自 BaseTransformer，那么例如 my_trafo1 * my_trafo2 * my_clf 将产生与构造函数 SklearnClassifierPipeline(classifier=my_clf, transformers=[t1, t2]) 获得的相同的对象。
魔术乘法也可以用于 (str, transformer) 对，: 只要链中的一个元素是转换器即可。

参数:

classifiersklearn 分类器，即继承自 sklearn ClassifierMixin: 这是一个“蓝图”分类器，调用 fit 时其状态不会改变
transformerssktime 转换器列表，或: sktime 转换器的元组 (str, transformer) 列表。这些是“蓝图”转换器，调用 fit 时其状态不会改变。

属性:

classifier_sklearn 分类器，是 classifier 中分类器的克隆: 调用 fit 时，这个克隆体会在管道中被拟合
transformers_sktime 转换器的元组 (str, transformer) 列表: 是 transformers 中转换器的克隆，它们在管道中被拟合。即使 transformers 只是一个列表，该列表也始终采用 (str, transformer) 格式。未在 transformers 中传递的字符串是唯一生成的字符串。transformers_ 中的第 i 个转换器是 transformers 中第 i 个转换器的克隆。

示例

>>> from sklearn.neighbors import KNeighborsClassifier
>>> from sktime.transformations.series.exponent import ExponentTransformer
>>> from sktime.transformations.series.summarize import SummaryTransformer
>>> from sktime.datasets import load_unit_test
>>> from sktime.classification.compose import SklearnClassifierPipeline
>>> X_train, y_train = load_unit_test(split="train")
>>> X_test, y_test = load_unit_test(split="test")
>>> t1 = ExponentTransformer()
>>> t2 = SummaryTransformer()
>>> pipeline = SklearnClassifierPipeline(KNeighborsClassifier(), [t1, t2])
>>> pipeline = pipeline.fit(X_train, y_train)
>>> y_pred = pipeline.predict(X_test)

通过 dunder 方法的替代构造

>>> pipeline = t1 * t2 * KNeighborsClassifier()

方法

`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])	获取 `transformers` 中估计器的参数。
`get_tag`(tag_name[, tag_value_default, ...])	从实例获取标签值，具有标签级别继承和覆盖。
`get_tags`()	从实例获取标签，具有标签级别继承和覆盖。
`get_test_params`([parameter_set])	返回估计器的测试参数设置。
`is_composite`()	检查对象是否是复合对象。
`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`(**kwargs)	设置 `transformers` 中估计器的参数。
`set_random_state`([random_state, deep, ...])	为 self 设置 random_state 伪随机种子参数。
`set_tags`(**tag_dict)	将实例级别标签覆盖设置为给定值。

clone()[source]#

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

克隆是一个没有共享引用，处于初始化后状态的不同对象。此函数等同于返回 self 的 sklearn.clone。

等同于构造一个具有 self 参数的新 type(self) 实例，即 type(self)(**self.get_params(deep=False))。

如果在 self 上设置了配置，克隆体也将具有与原始对象相同的配置，等同于调用 cloned_self.set_config(**self.get_config())。

其值也等同于调用 self.reset，不同之处在于 clone 返回一个新对象，而不是像 reset 那样改变 self。

引发:

如果克隆体由于错误的 __init__ 而不符合要求，则引发 RuntimeError。

get_params(deep=True)[source]#

获取 transformers 中估计器的参数。

参数:

deep布尔值，可选，默认为 True: 如果为 True，将返回此估计器以及其中包含的估计器子对象的参数。

返回:

params字符串到任意类型的映射: 参数名称映射到它们的值。

check_is_fitted(method_name=None)[source]#

检查估计器是否已拟合。

检查 _is_fitted 属性是否存在且为 True。`is_fitted` 属性应在调用对象的 `fit` 方法时设置为 True。

如果不是，则引发 NotFittedError。

参数:

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

引发:

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

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

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

状态变化: 将状态更改为“fitted”（已拟合）。
写入 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 个索引对应于 X 中的实例索引，第 1 个索引（如果适用）对应于 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 个索引对应于 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_pred与 sktime 兼容的表格数据容器，类型为 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)[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 个索引对应于 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_predint 类型的 2D np.array，形状为 [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 的配置标志。

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

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

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

Configs 在 clone 或 reset 调用下保留。

返回:

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

get_fitted_params(deep=True)[source]#

获取拟合参数。

所需状态: 要求状态为“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()[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_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]#

检查对象是否是复合对象。

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

返回:

composite: bool，表示 self 是否包含一个类型为 BaseObject 的参数

property is_fitted[source]#

fit 是否已被调用。

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

返回:

bool: 估计器是否已进行 fit。

classmethod load_from_path(serial)[source]#

从文件位置加载对象。

参数:

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

返回:

cls.save(path) 在 path 处产生输出的反序列化 self

classmethod load_from_serial(serial)[source]#

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

参数:

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

返回:

cls.save(None) 产生输出 serial 的反序列化 self

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_pred与 sktime 兼容的表格数据容器，类型为 Table scitype

预测的类别标签

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

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

如果 y 是单变量（一维），则为 1D np.npdarray；否则，类型与 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_predint 类型的 2D np.array，形状为 [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) 中创建一个 estimator.zip 文件。
path=”/home/stored/estimator”，则 estimator.zip 文件将

存储在 /home/stored/ 中。

serialization_format: str，默认值 = “pickle”

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

返回:

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

score(X, y) → float[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与 sktime 兼容的表格数据容器，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)[source]#

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

参数:

config_dictdict

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

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

jupyter kernel 如何显示 self 的实例

“diagram” = html 框图表示
“text” = 字符串打印输出

print_changed_onlybool，默认值=True

打印 self 时是否仅列出与默认值不同的 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，则抑制警告

返回:

self对 self 的引用。

注意事项

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

set_params(**kwargs)[source]#

设置 transformers 中估计器的参数。

有效的参数键可以通过 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 的引用。

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

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

参数:

parameter_setstr，默认值="default": 要返回的测试参数集的名称，用于测试。如果未为某个值定义特殊参数，将返回 "default" 集。对于分类器，应提供一组“default”参数用于一般测试，并提供一组“results_comparison”参数用于与先前记录的结果进行比较（如果一般集未产生适合比较的概率）。

返回:

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