Pipeline#

class Pipeline(steps=None)[source]#

图形化 Pipeline 的实现。

此类是一个广义的图形化 Pipeline。广义意味着它可以包含预测器、分类器等。图形化 Pipeline 意味着结构不是线性的。也就是说，Pipeline 中的每个元素都可以作为多个其他步骤的输入，而不仅仅是一个后续步骤的输入。

fit(y, X, *args) - 通过在所有 sktime 估计器和

Pipeline 中的转换器上运行 fit 来改变状态。请注意，根据添加到 Pipeline 中的 sktime 估计器和转换器，可能需要不同的关键字。例如，如果 Pipeline 中包含预测器，则应提供预测范围 (fh)。

predict(X, *args) - 导致对 Pipeline 中的估计器调用 predict 方法，以及

对 Pipeline 中的其他 skobject 调用 transform 或指定的方法。根据添加到 Pipeline 中的 skobject，您可能需要向 predict 方法传递额外的参数。

predict_interval(X, fh), predict_quantiles(X, fh) - 与 predict(X, fh) 类似，

只是将 predict 替换为 predict_interval 或 predict_quantiles。

predict_var, predict_proba - 目前不受支持 get_params, set_params 使用 sklearn 兼容的嵌套接口 add_step(skobject, name, edges, method, **kwargs) - 将一个 skobject 添加到

Pipeline，并将 name 设置为标识符，将由 edges 指定的步骤作为输入步骤（前驱）。因此，可以使用 method kwarg 覆盖应该调用的方法。提供的其他 kwargs 将在调用 skobject 时直接传递给它。

参数:
steps 参数一个字典列表，用于指定 Pipeline 的步骤。可以通过 add_step 方法添加更多

步骤。该字典需要以下键

  • skobject: sktime 对象，应添加到 Pipeline 的

    中

  • name: str，创建步骤的名称

  • edges: dict，一个以字符串键指向字符串值的字典。用于标识

    前驱步骤。edges 字典的键指定前驱步骤的输出（字典的值指定前驱步骤的名称）应传递给 fit/predict/.. 的哪个参数。

  • method: str，一个可选参数，允许确定应在 Pipeline 调用提供的 skobject 时执行的方法。

    如果未指定，Pipeline 将根据对 Pipeline 调用的方法（例如，predict, transform, ..）来选择方法。

  • kwargs: 其他 kwargs 是在调用 fit/predict/.. 时提供给

    skobject 的参数。

属性:
id_to_true_id 属性一个以整数为键和值的字典，

将 Python 对象 id 映射到 skobject id。

id_to_obj 属性一个以整数为键和 skobject 弱引用为值的字典。

这些值是提供给 add_step 方法的 skobject 的弱引用。我们存储弱引用以避免用户删除对对象的所有引用时，对象的 id 被重新分配。

model_dict 属性一个以整数为键和 skobject 为值的字典。

这是将提供给 add_step 的 skobject 的 id 映射到克隆的 skobject。

counter 属性整数，计算 Pipeline 中的步骤数。
steps 属性一个以字符串为键和 step 对象为值的字典。

键是在将 skobject 添加到 Pipeline 时指定的名称。

kwargs 属性一个以 str 为键和对象为值的字典。存储所有 kwargs

这些 kwargs 已指定，并可能传递给 Pipeline 中的 skobject。

参考文献

[1]

@article{heidrich2021pywatts, title={pyWATTS: Python 工作流自动化时间序列工具}, author={Heidrich, Benedikt and Bartschat, Andreas and Turowski, Marian and

Neumann, Oliver and Phipps, Kaleb and Meisenbacher, Stefan and Schmieder, Kai and Ludwig, Nicole and Mikut, Ralf and Hagenmeyer, Veit},

journal={arXiv preprint arXiv:2106.10157}, year={2021}

}

示例

>>> from sktime.classification.distance_based import KNeighborsTimeSeriesClassifier
>>> from sktime.datasets import load_arrow_head, load_longley
>>> from sktime.split import temporal_train_test_split
>>> from sktime.forecasting.naive import NaiveForecaster
>>> from sktime.pipeline import Pipeline
>>> from sktime.transformations.compose import Id
>>> from sktime.transformations.series.boxcox import BoxCoxTransformer
>>> from sktime.transformations.series.exponent import ExponentTransformer

示例 1：使用广义非顺序 Pipeline 实现的简单顺序转换器 Pipeline

>>> y, X = load_longley()
>>> general_pipeline = Pipeline()
>>> for step in [
...     {"skobject": ExponentTransformer(), "name": "exp", "edges": {"X": "X"}},
...     {"skobject": BoxCoxTransformer(), "name": "box", "edges": {"X": "exp"}},
...     ]:
...     general_pipeline = general_pipeline.add_step(**step)
>>> general_pipeline.fit(X=X) 
>>> result_general = general_pipeline.transform(X)
示例 2：使用广义非顺序 Pipeline 实现的分类顺序 Pipeline

实现

>>> X, y = load_arrow_head(split="train", return_X_y=True)
>>> general_pipeline = Pipeline()
>>> for step in [
...     {"skobject": ExponentTransformer(), "name": "exp", "edges": {"X": "X"}},
...     {"skobject": KNeighborsTimeSeriesClassifier(),
...      "name": "knnclassifier",
...      "edges": {"X": "exp", "y": "y"}}]:
...     general_pipeline = general_pipeline.add_step(**step)
>>> general_pipeline.fit(X=X, y=y) 
>>> result_general = general_pipeline.predict(X)

示例 3：使用广义非顺序 Pipeline 实现的带外生特征的预测 Pipeline

>>> y, X = load_longley()
>>> y_train, y_test, X_train, X_test = temporal_train_test_split(y, X)
>>> general_pipeline = Pipeline()
>>> for step in [
...     {"skobject": ExponentTransformer(), "name": "exp", "edges": {"X": "X"}},
...     {"skobject": NaiveForecaster(),
...      "name": "SARIMAX",
...      "edges": {"X": "exp", "y": "y"}}]:
...     general_pipeline = general_pipeline.add_step(**step)
>>> general_pipeline.fit(y=y_train, X=X_train, fh=[1, 2, 3, 4]) 
>>> result_general = general_pipeline.predict(X=X_test)

致谢 这个图形化 Pipeline 的灵感来源于 pyWATTS，它由卡尔斯鲁厄理工学院 (Karlsruhe Institute of Technology) 自动化与应用信息学研究所 (IAI) 开发。该实现得到 IAI 的支持，作者 benHeid 由 HelmholtzAI 提供资金。此外，我们还要感谢 @ViktorKaz 独立的 Pipeline 设计，它与本设计相似。

方法

add_step(skobject, name, edges[, method])

向 Pipeline 添加一个新的 skobject。

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

将图形化 Pipeline 拟合到训练数据。

fit_transform(X[, y])

将图形化 Pipeline 拟合到训练数据，然后调用 transform。

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

获取 Pipeline 的参数。

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

执行预测。

predict_interval(X[, y])

执行区间预测。

predict_quantiles(X[, y])

执行分位数预测。

predict_residuals(X[, y])

执行残差预测。

reset()

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

save([path, serialization_format])

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

set_config(**config_dict)

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

set_params(**params)

设置此估计器的参数。

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

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

set_tags(**tag_dict)

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

transform(X[, y])

在图形化 Pipeline 中的每个元素上调用 transform。
get_params(deep=True)[source]#

获取 Pipeline 的参数。

参数:
deep布尔值，可选，默认值=True

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

返回值:
paramsdict，参数名称映射到其值的字典。
set_params(**params)[source]#

设置此估计器的参数。

有效的参数键可以使用 get_params() 列出。注意，如果提供了 steps，则其他参数将被忽略。

参数:
paramsdict，参数名称映射到其值的字典。
返回值:
selfPipeline，此估计器
add_step(skobject, name, edges, method=None, **kwargs)[source]#

向 Pipeline 添加一个新的 skobject。

此方法改变 Pipeline 的结构。它会查找克隆的 skobject 是否已存在。如果不存在，则克隆 skobject。之后，使用克隆的 skobject 创建一个新的 Pipeline 步骤，并使用提供的 name。新步骤的输入由 edges 字典指定。

参数:
skobject: sktime 对象，应添加到 Pipeline 的 skobject
name: str，创建步骤的名称
edges: dict，一个以字符串键指向字符串值的字典。用于标识
前驱步骤。edges 字典的键指定应传递给

fit/predict/.. 的哪个参数，前驱步骤的输出（字典的值指定前驱步骤的名称）应传递给该参数。

method: str，一个可选参数，允许确定应在 Pipeline 调用提供的 skobject 时执行的方法。

如果未指定，Pipeline 将根据对 Pipeline 调用的方法（例如，predict, transform, ..）来选择方法。

kwargs: 其他 kwargs 是在调用 fit/predict/.. 时提供给

skobject 的参数。

fit(X=None, y=None, **kwargs)[source]#

将图形化 Pipeline 拟合到训练数据。

参数:
Xsktime 兼容格式的时间序列，可选（默认值=None）

用于拟合的外生时间序列

ysktime 兼容数据容器格式的时间序列

用于拟合 Pipeline 的时间序列。

kwargs可能传递给 Pipeline 中 skobject 的额外关键字参数，如果它们有与 kwargs 的键对应的参数。

中

注意

通过创建已拟合模型来改变状态，该模型更新 Pipeline 中 skobject 中以“_”结尾的属性，并将 is_fitted 标志设置为 True。

fit_transform(X, y=None, **kwargs)[source]#

将图形化 Pipeline 拟合到训练数据，然后调用 transform。

参数:
Xsktime 兼容格式的时间序列，可选（默认值=None）

用于拟合的外生时间序列

ysktime 兼容数据容器格式的时间序列

用于拟合 Pipeline 的时间序列。

kwargs可能传递给 Pipeline 中 skobject 的额外关键字参数，如果它们有与 kwargs 的键对应的参数。

中

引发异常:
如果 Pipeline 中的步骤未实现 transform 方法，则引发 MethodNotImplementedError 异常
transform

注意

通过创建已拟合模型来改变状态，该模型更新 Pipeline 中 skobject 中以“_”结尾的属性，并将 is_fitted 标志设置为 True。

transform(X, y=None, **kwargs)[source]#

在图形化 Pipeline 中的每个元素上调用 transform。

参数:
Xsktime 兼容格式的时间序列，可选（默认值=None）

用于拟合的外生时间序列

ysktime 兼容数据容器格式的时间序列

用于拟合 Pipeline 的时间序列。

kwargs可能传递给 Pipeline 中 skobject 的额外关键字参数，如果它们有与 kwargs 的键对应的参数。

中

引发异常:
如果 Pipeline 中的步骤未实现 transform 方法，则引发 MethodNotImplementedError 异常

transform

predict(X=None, y=None, **kwargs)[source]#

执行预测。

即，对图形化 Pipeline 中的每个元素调用 predict 或 transform 方法。

参数:
Xsktime 兼容格式的时间序列，可选（默认值=None）

用于拟合的外生时间序列

ysktime 兼容数据容器格式的时间序列

用于拟合 Pipeline 的时间序列。

kwargs可能传递给 Pipeline 中 skobject 的额外关键字参数，如果它们有与 kwargs 的键对应的参数。

中

引发异常:
如果 Pipeline 中的步骤未实现 transform 方法，则引发 MethodNotImplementedError 异常
transform 或 predict
predict_interval(X, y=None, **kwargs)[source]#

执行区间预测。

即，对图形化 Pipeline 中的每个元素调用 predict、predict_interval 或 transform 方法。

参数:
Xsktime 兼容格式的时间序列，可选（默认值=None）

用于拟合的外生时间序列

ysktime 兼容数据容器格式的时间序列

用于拟合 Pipeline 的时间序列。

kwargs可能传递给 Pipeline 中 skobject 的额外关键字参数，如果它们有与 kwargs 的键对应的参数。

中

引发异常:
如果 Pipeline 中的步骤未实现 transform 方法，则引发 MethodNotImplementedError 异常
transform, predict, 或 predict_interval
predict_quantiles(X, y=None, **kwargs)[source]#

执行分位数预测。

即，对图形化 Pipeline 中的每个元素调用 predict、predict_quantiles 或 transform 方法。

参数:
Xsktime 兼容格式的时间序列，可选（默认值=None）

用于拟合的外生时间序列

ysktime 兼容数据容器格式的时间序列

用于拟合 Pipeline 的时间序列。

kwargs可能传递给 Pipeline 中 skobject 的额外关键字参数，如果它们有与 kwargs 的键对应的参数。

中

引发异常:
如果 Pipeline 中的步骤未实现 transform 方法，则引发 MethodNotImplementedError 异常
transform, predict, 或 predict_quantiles
predict_residuals(X, y=None, **kwargs)[source]#

执行残差预测。

即，对图形化 Pipeline 中的每个元素调用 predict、predict_residuals 或 transform 方法。

参数:
Xsktime 兼容格式的时间序列，可选（默认值=None）

用于拟合的外生时间序列

ysktime 兼容数据容器格式的时间序列

用于拟合 Pipeline 的时间序列。

kwargs可能传递给 Pipeline 中 skobject 的额外关键字参数，如果它们有与 kwargs 的键对应的参数。

中

引发异常:
如果 Pipeline 中的步骤未实现 transform 方法，则引发 MethodNotImplementedError 异常

transform, predict, 或 predict_residuals

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

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

参数:
parameter_setstr，默认值="default"

要返回的测试参数集的名称，用于测试。如果未为某个值定义特殊参数，将返回 "default" 集。预测器目前没有保留值。

返回值:
paramsdict 或 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 设置动态标签覆盖。

The 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__}。

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_namestr

标签值的名称。

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

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

返回值:
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_tagsdict

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

get_config()[source]#

获取 self 的配置标志。

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

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

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

配置在 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 的单个标签的值，考虑标签覆盖，按以下降序优先级排列：

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

在构造实例时设置的标签。

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

  2. 在父类的 _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 设置的标签。

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

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

在构造实例时设置的标签。

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

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

按继承顺序。

返回值:
collected_tagsdict

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

is_composite()[source]#

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

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

返回值:
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) 的结果
返回值:
反序列化自身后，产生的输出位于 path，该输出是 cls.save(path) 的结果。
classmethod load_from_serial(serial)[source]#

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

参数:
serialcls.save(None) 输出的第一个元素
返回值:
反序列化 self，得到输出 serial，即 cls.save(None) 的输出
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”，则会在当前工作目录创建一个 zip 文件 estimator.zip。

  • path=”/home/stored/estimator”，则 zip 文件 estimator.zip 将

存储在 /home/stored/ 中。

serialization_format: str, default = “pickle”

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

返回值:
如果 path 为 None - 内存中的序列化 self
如果 path 是文件位置 - 引用该文件的 ZipFile
set_config(**config_dict)[source]#

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

参数:
config_dictdict

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

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

jupyter kernel 如何显示 self 的实例

  • “diagram” = html 框图表示

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

print_changed_onlybool, default=True

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

warningsstr，“on”（默认）或“off”

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

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

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

backend:parallelstr, optional, default="None"

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

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

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

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

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

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

backend:parallel:paramsdict, optional, default={} (未传递参数)

作为配置传递给并行后端附加参数。有效键取决于 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, default=True；False 会阻止 ray 在并行化后

      关闭。

    • “logger_name”：str, default="ray"；要使用的日志记录器名称。

    • “mute_warnings”：bool, default=False；如果为 True，则抑制警告

返回值:
selfself 的引用。

注意

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

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

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

通过 self.get_params 查找名为 random_state 的参数，并通过 set_params 将其设置为从 random_state 通过链式哈希（chain hashing）经由 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, default=None

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

deepbool，默认值=True

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

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

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

self_policystr, {“copy”, “keep”, “new”} 之一, default=”copy”

  • “copy”：self.random_state 设置为输入的 random_state

  • “keep”：self.random_state 保持不变

  • “new”：self.random_state 设置为一个新的随机状态，

从输入的 random_state 派生，通常与它不同

返回值:
selfself 的引用
set_tags(**tag_dict)[source]#

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

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

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

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

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

当前的标签值可以通过 get_tags 或 get_tag 进行检查。

参数:
**tag_dictdict

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

返回值:
Self

self 的引用。