ClassifierPipeline#

class ClassifierPipeline(classifier, transformers)[source]#

转换器和分类器的流水线。

ClassifierPipeline 合成器将转换器和单个分类器串联起来。流水线由 sktime 转换器列表和一个分类器构成，

即遵循 BaseTransformer 或 BaseClassifier 接口的估计器。

转换器列表可以是不命名的 - 一个简单的转换器列表 -

或字符串命名的 - 一个字符串和估计器对的列表。

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

流水线的行为如下：

fit(X, y) - 通过在 X 上运行 trafo1.fit_transform 来改变状态，

然后依次在 trafo1.fit_transform 的输出上运行 trafo2.fit_transform，等等，其中 trafo[i] 接收 trafo[i-1] 的输出，然后运行 clf.fit，其中 X 是 trafo[N] 的输出，而 y 与 self.fit 的输入相同。

predict(X) - 结果是在 X 上依次执行 trafo1.transform, trafo2.transform 等的结果，

其中 trafo[i].transform 的输入 = trafo[i-1].transform 的输出，然后在 trafoN.transform 的输出上运行 clf.predict，并返回 clf.predict 的输出。

predict_proba(X) - 结果是在 X 上依次执行 trafo1.transform, trafo2.transform 等的结果，

其中 trafo[i].transform 的输入 = trafo[i-1].transform 的输出，然后在 trafoN.transform 的输出上运行 clf.predict_proba，并返回 clf.predict_proba 的输出。

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

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

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

ClassifierPipeline 也可以通过魔法乘法创建，
即在任何分类器上使用魔法乘法，如果 my_clf 继承自 BaseClassifier，

并且 my_trafo1, my_trafo2 继承自 BaseTransformer，那么，例如，my_trafo1 * my_trafo2 * my_clf 将得到与构造函数 ClassifierPipeline(classifier=my_clf, transformers=[my_trafo1, my_trafo2]) 得到的对象相同的对象。

魔法乘法也可以与 (str, transformer) 对一起使用，

只要链中的一个元素是转换器即可。

参数：
classifiersktime 分类器，即继承自 BaseClassifier 的估计器

这是一个“蓝图”分类器，调用 fit 时其状态不会改变

transformerssktime 转换器列表，或

sktime 转换器的元组 (str, transformer) 列表。这些是“蓝图”转换器，调用 fit 时其状态不会改变。

属性：
classifier_sktime 分类器，是 classifier 中的分类器的克隆

调用 fit 时，该克隆在流水线中拟合。

transformers_sktime 转换器的元组 (str, transformer) 列表

transformers 中转换器的克隆，在流水线中拟合，始终采用 (str, transformer) 格式，即使 transformers 只是一个列表。未在 transformers 中传递的字符串是唯一生成的字符串。transformers_ 中的第 i 个转换器是 transformers 中第 i 个转换器的克隆。

示例

>>> from sktime.transformations.panel.pca import PCATransformer
>>> from sktime.classification.interval_based import TimeSeriesForestClassifier
>>> from sktime.datasets import load_unit_test
>>> from sktime.classification.compose import ClassifierPipeline
>>> X_train, y_train = load_unit_test(split="train")
>>> X_test, y_test = load_unit_test(split="test")
>>> pipeline = ClassifierPipeline(
...     TimeSeriesForestClassifier(n_estimators=5), [PCATransformer()]
... )
>>> pipeline.fit(X_train, y_train)
ClassifierPipeline(...)
>>> y_pred = pipeline.predict(X_test)

通过特殊方法（dunder method）的替代构造方式

>>> pipeline = PCATransformer() * TimeSeriesForestClassifier(n_estimators=5)

方法

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

获取 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])

将序列化的对象保存到字节类对象或 (.zip) 文件。

score(X, y)

在 X 上对比预测标签与真实标签进行评分。

set_config(**config_dict)

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

set_params(**kwargs)

设置 transformers 中估计器的参数。

set_random_state([random_state, deep, ...])

设置对象的 pseudo-random 种子参数 random_state。

set_tags(**tag_dict)

将实例级别标签覆盖设置为给定值。
get_params(deep=True)[source]#

获取 transformers 中估计器的参数。

参数：
deep布尔值，可选，默认为 True

如果为 True，将返回此估计器和其中包含的作为估计器的子对象的参数。

返回值：
params字符串到任意值的映射

参数名称与其值的映射。

set_params(**kwargs)[source]#

设置 transformers 中估计器的参数。

有效的参数键可以通过 get_params() 列出。

返回值：
self返回 self 的一个实例。
classmethod get_test_params(parameter_set='default')[source]#

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

参数：
parameter_set字符串，默认为“default”

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

返回值：
params字典或字典列表，默认为 {}

用于创建类测试实例的参数。每个字典都是构造一个“有趣”测试实例的参数，即 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_name字符串，可选

调用此方法的方法的名称。如果提供，错误消息将包含此信息。

抛出：
NotFittedError

如果估计器尚未拟合。

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。
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_names字符串或字符串列表，默认为 None

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

返回值：
self

对 self 的引用。

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

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

参数：
parameter_set字符串，默认为“default”

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

返回值：
instance具有默认参数的类实例
classmethod create_test_instances_and_names(parameter_set='default')[source]#

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

参数：
parameter_set字符串，默认为“default”

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

返回值：
objscls 实例列表

第 i 个实例是 cls(**cls.get_test_params()[i])

names字符串列表，长度与 objs 相同

第 i 个元素是测试中 obj 的第 i 个实例的名称。如果实例多于一个，命名约定为 {cls.__name__}-{i}，否则为 {cls.__name__}

fit(X, y)[source]#

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

状态改变

将状态改为“已拟合”。

写入自身

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

参数：
X兼容 sktime 的 Panel scitype 时间序列面板数据容器

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

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

  • pd-multiindex：pandas DataFrame，列为变量，索引为 pandas MultiIndex，第一层为实例索引，第二层为时间索引

  • numpy3D：3D numpy 数组（任意维度，等长序列），形状为 [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：pandas DataFrame，列为变量，索引为 pandas MultiIndex，第一层为实例索引，第二层为时间索引

  • numpy3D：3D numpy 数组（任意维度，等长序列），形状为 [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_state布尔值，可选（默认为 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 中的多输出向量索引。

1D numpy 数组，如果 y 是单变量（一维）；否则，与 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：pandas DataFrame，列为变量，索引为 pandas MultiIndex，第一层为实例索引，第二层为时间索引

  • numpy3D：3D numpy 数组（任意维度，等长序列），形状为 [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_state布尔值，可选（默认为 True）

  • 如果为 False，将不改变分类器的状态，即拟合/预测序列使用一个副本运行，self 不改变

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

返回值：
y_pred2D numpy int 数组，形状为 [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 的标签的值，考虑标签覆盖，按以下降序优先级：

  1. 类 _tags 属性中设置的标签。

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

按继承顺序。

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

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

参数：
tag_name字符串

标签值的名称。

tag_value_default任意类型

如果未找到标签，则为默认/备用值。

返回值：
tag_value

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

classmethod get_class_tags()[source]#

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

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

标签是特定于实例 self 的键值对，它们是静态标志，在对象构造后不会改变。

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

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

值是相应的标签值，覆盖按以下降序优先级：

  1. 类 _tags 属性中设置的标签。

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

按继承顺序。

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

要检索可能包含实例覆盖的标签，请改用 get_tags 方法。

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

对于包含动态标签的覆盖，使用 get_tags。

collected_tags字典

标签名称 : 标签值 对的字典。通过嵌套继承从 _tags 类属性收集。不受通过 set_tags 或 clone_tags 设置的动态标签覆盖。

get_config()[source]#

获取对象的配置标志。

配置是 self 的键值对，通常用作控制行为的瞬时标志。

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

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

配置在 clone 或 reset 调用下保留。

返回值：
config_dict字典

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

get_fitted_params(deep=True)[source]#

获取拟合参数。

所需状态

要求状态为“已拟合”。

参数：
deep布尔值，默认为 True

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

  • 如果为 True，将返回此对象的参数名称 : 值字典，包括可拟合组件（= BaseEstimator 值参数）的拟合参数。

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

返回值：
fitted_params键为字符串的字典

拟合参数字典，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]#

获取对象的参数名称。

参数：
sort布尔值，默认为 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 的单个标签的值，考虑标签覆盖，按以下降序优先级：

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

在实例构造时设置。

  1. 类 _tags 属性中设置的标签。

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

按继承顺序。

参数：
tag_name字符串

要检索的标签名称

tag_value_default任意类型，可选；默认为 None

如果未找到标签，则为默认/备用值

raise_error布尔值

未找到标签时是否引发 ValueError

返回值：
tag_value任意类型

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 设置的标签。

值是相应的标签值，覆盖按以下降序优先级：

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

在实例构造时设置。

  1. 类 _tags 属性中设置的标签。

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

按继承顺序。

返回值：
collected_tags字典

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

is_composite()[source]#

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

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

返回值：
composite: bool，self 是否包含一个参数是 BaseObject
property is_fitted[source]#

fit 是否已被调用。

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

返回值：
布尔值

估计器是否已 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 中的序列的标签。

参数：
X兼容 sktime 的 Panel scitype 时间序列面板数据容器

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

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

  • pd-multiindex：pandas DataFrame，列为变量，索引为 pandas MultiIndex，第一层为实例索引，第二层为时间索引

  • numpy3D：3D numpy 数组（任意维度，等长序列），形状为 [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 中的多输出向量索引。

1D numpy 数组，如果 y 是单变量（一维）；否则，与 fit 中传递的 y 类型相同。

predict_proba(X)[source]#

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

参数：
X兼容 sktime 的 Panel scitype 时间序列面板数据容器

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

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

  • pd-multiindex：pandas DataFrame，列为变量，索引为 pandas MultiIndex，第一层为实例索引，第二层为时间索引

  • numpy3D：3D numpy 数组（任意维度，等长序列），形状为 [n_instances, n_dimensions, series_length]

  • 或任何其他支持的 Panel mtype

mtype 列表，请参阅 datatypes.SCITYPE_REGISTER

详细规范，请参阅 examples/AA_datatypes_and_datasets.ipynb

并非所有估计器都支持包含多元或不等长序列的面板，详情请参阅标签参考。

返回值：
y_pred2D numpy int 数组，形状为 [n_instances, n_classes]

预测的类标签概率。第 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]#

将序列化的对象保存到字节类对象或 (.zip) 文件。

行为：如果 path 为 None，则返回内存中的序列化 self；如果 path 是文件位置，则将 self 以 zip 文件形式存储在该位置。

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

参数：
pathNone 或文件位置（字符串或 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 上对比预测标签与真实标签进行评分。

参数：
X兼容 sktime 的 Panel scitype 时间序列面板数据容器

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

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

  • pd-multiindex：pandas DataFrame，列为变量，索引为 pandas MultiIndex，第一层为实例索引，第二层为时间索引

  • numpy3D：3D numpy 数组（任意维度，等长序列），形状为 [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

返回值：
浮点数，predict(X) 与 y 相比的准确率得分
set_config(**config_dict)[source]#

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

参数：
config_dict字典

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

display字符串，“diagram”（默认）或“text”

jupyter 内核如何显示 self 的实例

  • “diagram” = html 框图表示

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

print_changed_only布尔值，默认为 True

打印 self 时是否只列出与默认值不同的 self 参数（False），或所有参数名称和值（False）。不嵌套，即只影响 self，不影响组件估计器。

warnings字符串，“on”（默认）或“off”

是否发出警告，仅影响来自 sktime 的警告

  • “on” = 将发出来自 sktime 的警告

  • “off” = 将不发出来自 sktime 的警告

backend:parallel字符串，可选，默认为“None”

广播/向量化时用于并行化的后端，可选：

  • “None”：顺序执行循环，简单的列表推导式

  • “loky”, “multiprocessing” 和 “threading”：使用 joblib.Parallel

  • “joblib”：自定义和第三方 joblib 后端，例如 spark

  • “dask”：使用 dask，需要环境中安装 dask 包

  • “ray”：使用 ray，需要环境中安装 ray 包

backend:parallel:params字典，可选，默认为 {}（不传递参数）

作为配置传递给并行化后端的附加参数。有效键取决于 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”：布尔值，默认为 True；False 阻止 ray 在

      并行化后关闭。

    • “logger_name”：字符串，默认为“ray”；要使用的日志记录器名称。

    • “mute_warnings”：布尔值，默认为 False；如果为 True，则抑制警告

返回值：
self对 self 的引用。

注意事项

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

set_random_state(random_state=None, deep=True, self_policy='copy')[source]#

设置对象的 pseudo-random 种子参数 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 以实现跨多个函数调用的可重现输出。

deep布尔值，默认为 True

是否在 skbase 对象值参数（即组件估计器）中设置随机状态。

  • 如果为 False，则仅设置 self 的 random_state 参数（如果存在）。

  • 如果为 True，则也会设置组件对象中的 random_state 参数。

self_policy字符串，{“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_dict字典

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

返回值：
Self

对 self 的引用。