TransformerPipeline#

class TransformerPipeline(steps)[source]#

转换器组合器的管道。

The TransformerPipeline 组合器允许链式连接转换器。该管道由一个 sktime 转换器列表构成，即遵循 BaseTransformer 接口的估计器。该列表可以是无名的（一个简单的转换器列表）或字符串命名的（字符串和估计器组成的对的列表）。

对于转换器列表 trafo1, trafo2, …, trafoN，管道的行为如下：

  • fit (拟合)

    通过依次运行 trafo1.fit_transform, trafo2.fit_transform` 等来改变状态，其中 trafo[i] 接收 trafo[i-1] 的输出。

  • transform (转换)

    结果是执行 trafo1.transform, trafo2.transform 等，其中 trafo[i].transform 的输入是 trafo[i-1].transform 的输出，并返回 trafoN.transform 的输出。

  • inverse_transform (逆转换)

    结果是执行 trafo[i].inverse_transform，其中 trafo[i].inverse_transform 的输入是 trafo[i-1].inverse_transform 的输出，并返回 trafoN.inverse_transform 的输出。

  • update (更新)

    通过链式调用 trafo1.update, trafo1.transform, trafo2.update, trafo2.transform, …, trafoN.update` 来改变状态，其中 trafo[i].update 和 trafo[i].transform 的输入是 trafo[i-1].transform 的输出。

对于管道中使用了 y 参数的转换器，传递给 TransformerPipeline.fit 或 transform 的 y 参数会传递给管道中的所有此类转换器。管道中不会对 y 应用转换或逆转换。

如果列表是无名的，则 get_params, set_params 使用 sklearn 兼容的嵌套接口；如果名称不是唯一的，则名称将生成为类名，并在每个名称字符串后附加 f"_{str(i)}"，其中 i 是该非唯一字符串在该名称列表（包括自身）中出现的总计数。

还可以通过对任何转换器使用魔术乘法来创建 TransformerPipeline，例如，任何继承自 BaseTransformer 的估计器，my_trafo1 * my_trafo2 * my_trafo3 将产生与构造函数 TransformerPipeline([my_trafo1, my_trafo2, my_trafo3]) 获得的对象相同的对象。魔术乘法也可以用于 (str, transformer) 对，只要链中的一个元素是转换器即可。

参数:
stepssktime 转换器列表，或

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

属性:
steps_sktime 转换器的元组列表 (str, transformer)

管道中拟合的 steps 中的转换器的克隆始终采用 (str, transformer) 格式，即使 steps 只是一个列表。未在 steps 中传递的字符串将替换为唯一生成的字符串。steps_ 中的第 i 个转换器是 steps 中第 i 个转换器的克隆。

示例

>>> from sktime.transformations.compose import TransformerPipeline
>>> from sktime.transformations.series.exponent import ExponentTransformer
>>> t1 = ExponentTransformer(power=2)
>>> t2 = ExponentTransformer(power=0.5)

示例 1，选项 A：不使用字符串构建（为两个组件 t1 和 t2 生成唯一名称）

>>> pipe = TransformerPipeline(steps = [t1, t2])

示例 1，选项 B：使用字符串为步骤提供自定义名称

>>> pipe = TransformerPipeline(
...         steps = [
...             ("trafo1", t1),
...             ("trafo2", t2),
...         ]
...     )

示例 1，选项 C：为了快速构建，可以使用 * dunder 方法

>>> pipe = t1 * t2

示例 2：可以在管道中使用 sklearn 转换器。如果应用于 Series，则 sklearn 转换器按 Series 实例应用。如果应用于 Table，则 sklearn 转换器应用于整个 Table。

>>> from sklearn.preprocessing import StandardScaler
>>> from sktime.transformations.series.summarize import SummaryTransformer

这将对每个 Series 应用缩放器，然后进行汇总

>>> pipe = StandardScaler() * SummaryTransformer()

这将进行汇总，然后对完整的汇总表进行缩放

>>> pipe = SummaryTransformer() * StandardScaler()

这将对 Series 进行缩放，然后进行汇总，然后对完整的汇总表进行缩放

>>> pipe = StandardScaler() * SummaryTransformer() * StandardScaler()

方法

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

将转换器拟合到 X，可选地拟合到 y。

fit_transform(X[, y])

拟合数据，然后对其进行转换。

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

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

inverse_transform(X[, y])

对 X 进行逆转换并返回逆转换后的版本。

is_composite()

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

load_from_path(serial)

从文件位置加载对象。

load_from_serial(serial)

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

reset (重置)()

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

save([path, serialization_format])

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

set_config(**config_dict)

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

set_params(**kwargs)

设置估计器的参数。

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

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

set_tags(**tag_dict)

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

transform(X[, y])

转换 X 并返回转换后的版本。

update(X[, y, update_params])

使用 X 更新转换器，可选地使用 y。
classmethod get_test_params(parameter_set='default')[source]#

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

参数:
parameter_setstr，默认值：“default”

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

返回:
paramsdict 或 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 个元素是测试中第 i 个 obj 实例的名称。如果实例多于一个，命名约定是 {cls.__name__}-{i}，否则是 {cls.__name__}。

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

将转换器拟合到 X，可选地拟合到 y。

状态变更

将状态更改为“fitted”。

写入 self

  • 设置以“_”结尾的拟合模型属性，可以通过 get_fitted_params 检查拟合属性。

  • 将 self.is_fitted 标志设置为 True。

  • 如果 self.get_tag("remember_data") 为 True，则将 X 记为 self._X，并强制转换为 self.get_tag("X_inner_mtype")。

参数:
Xsktime 兼容数据容器格式的时间序列

用于拟合转换的数据。

sktime 中的各种数据格式是所谓的 mtype 规范，每种 mtype 实现一种抽象 scitype。

  • Series scitype = 单个时间序列。pd.DataFrame、pd.Series 或 np.ndarray (1D 或 2D)

  • Panel scitype = 时间序列集合。pd.DataFrame，带有 2 级行 MultiIndex (instance, time)；3D np.ndarray (instance, variable, time)；list，包含 Series 类型的 pd.DataFrame

  • Hierarchical scitype = 分层时间序列集合。pd.DataFrame，带有 3 级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)

有关数据格式的更多详细信息，请参阅 mtype 术语表。有关用法，请参阅转换器教程 examples/03_transformers.ipynb

y可选，sktime 兼容数据格式的数据，默认值 = None

附加数据，例如用于转换的标签。如果 self.get_tag("requires_y") 为 True，则必须在 fit 中传递，不是可选的。所需格式请参阅类文档字符串中的详细信息。

返回:
self估计器的拟合实例
fit_transform(X, y=None)[source]#

拟合数据，然后对其进行转换。

将转换器拟合到 X 和 y，并返回 X 的转换版本。

状态变更

将状态更改为“fitted”。

写入 self：_is_fitted：标志设为 True。_X：X，X 的强制复制，如果 remember_data 标签为 True

如果可能，通过引用强制转换为内部类型或 update_data 兼容类型

模型属性（以“_”结尾）：取决于估计器

参数:
Xsktime 兼容数据容器格式的时间序列

用于拟合转换的数据，以及要转换的数据。

sktime 中的各种数据格式是所谓的 mtype 规范，每种 mtype 实现一种抽象 scitype。

  • Series scitype = 单个时间序列。pd.DataFrame、pd.Series 或 np.ndarray (1D 或 2D)

  • Panel scitype = 时间序列集合。pd.DataFrame，带有 2 级行 MultiIndex (instance, time)；3D np.ndarray (instance, variable, time)；list，包含 Series 类型的 pd.DataFrame

  • Hierarchical scitype = 分层时间序列集合。pd.DataFrame，带有 3 级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)

有关数据格式的更多详细信息，请参阅 mtype 术语表。有关用法，请参阅转换器教程 examples/03_transformers.ipynb

y可选，sktime 兼容数据格式的数据，默认值 = None

附加数据，例如用于转换的标签。如果 self.get_tag("requires_y") 为 True，则必须在 fit 中传递，不是可选的。所需格式请参阅类文档字符串中的详细信息。

返回:
X 的转换版本
类型取决于 X 的类型和 scitype:transform-output 标签
X | tf-output | 返回类型 |

|----------|————–|------------------------| | Series | 基本特征 | pd.DataFrame (1行) | | Panel | 基本特征 | pd.DataFrame | | Series | Series | Series | | Panel | Series | Panel | | Series | Panel | Panel |

返回中的实例对应于 X 中的实例
表格中未列出的组合目前不受支持
明确说明，并举例

  • 如果 X 是 Series (例如，pd.DataFrame)

并且 transform-output 是 Series，则返回类型是相同 mtype 的单个 Series。示例：对单个序列进行去趋势

  • 如果 X 是 Panel (例如，pd-multiindex) 并且 transform-output

是 Series，则返回类型是实例数量与 X 相同的 Panel (转换器应用于每个输入 Series 实例)。示例：面板中的所有序列都单独进行去趋势

  • 如果 X 是 Series 或 Panel 并且 transform-output 是

基本特征，则返回类型是 pd.DataFrame，其行数与 X 中的实例数量相同。示例：返回值的第 i 行包含第 i 个序列的均值和方差

  • 如果 X 是 Series 并且 transform-output 是 Panel，

则返回类型是 pd-multiindex 类型的 Panel 对象。示例：输出的第 i 个实例是在 X 上运行的第 i 个窗口

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任意类型

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

返回:
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_params(deep=True)[source]#

获取估计器的参数。

参数:
deepboolean，可选

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

返回:
params字符串到任意类型的映射

参数名称映射到其值。

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 对象属性的任何覆盖和新标签。

inverse_transform(X, y=None)[source]#

对 X 进行逆转换并返回逆转换后的版本。

目前假定只有带有标签

“scitype:transform-input”=”Series”，“scitype:transform-output”=”Series”，

的转换器才有 inverse_transform 方法。

所需状态

要求状态为“fitted”。

在 self 中访问

  • 以“_”结尾的拟合模型属性。

  • self.is_fitted，必须为 True

参数:
Xsktime 兼容数据容器格式的时间序列

用于拟合转换的数据。

sktime 中的各种数据格式是所谓的 mtype 规范，每种 mtype 实现一种抽象 scitype。

  • Series scitype = 单个时间序列。pd.DataFrame、pd.Series 或 np.ndarray (1D 或 2D)

  • Panel scitype = 时间序列集合。pd.DataFrame，带有 2 级行 MultiIndex (instance, time)；3D np.ndarray (instance, variable, time)；list，包含 Series 类型的 pd.DataFrame

  • Hierarchical scitype = 分层时间序列集合。pd.DataFrame，带有 3 级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)

有关数据格式的更多详细信息，请参阅 mtype 术语表。有关用法，请参阅转换器教程 examples/03_transformers.ipynb

y可选，sktime 兼容数据格式的数据，默认值 = None

附加数据，例如用于转换的标签。某些转换器需要此项，详细信息请参阅类文档字符串。

返回:
X 的逆转换版本

与 X 类型相同，并符合 mtype 格式规范

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) 的结果
返回:
反序列化的 self，其输出位于 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”，则将在

/home/stored/ 中存储 zip 文件 estimator.zip。

serialization_format: str，默认值 = “pickle”

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

返回:
如果 path 为 None - 内存中的序列化 self
如果 path 是文件位置 - 带有文件引用的 ZipFile
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，则抑制警告

input_conversionstr，以下之一：“on”（默认）、“off”或有效的 mtype 字符串

控制输入检查和转换，用于 _fit、_transform、_inverse_transform、_update

  • "on" - 执行输入检查和转换

  • "off" - 在将数据传递给内部方法之前不执行输入检查和转换

  • 有效的 mtype 字符串 - 假定输入为指定的 mtype，执行转换但不进行检查

output_conversionstr，以下之一：“on”、“off”、有效的 mtype 字符串

控制 _transform、_inverse_transform 的输出转换

  • "on" - 如果 input_conversion 为“on”，则执行输出转换

  • "off" - 直接返回 _transform、_inverse_transform 的输出

  • 有效的 mtype 字符串 - 输出转换为指定的 mtype

返回:
self对 self 的引用。

注释

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

set_params(**kwargs)[source]#

设置估计器的参数。

有效的参数键可以使用 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

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

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 的引用。

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

转换 X 并返回转换后的版本。

所需状态

要求状态为“fitted”。

在 self 中访问

  • 以“_”结尾的拟合模型属性。

  • self.is_fitted，必须为 True

参数:
Xsktime 兼容数据容器格式的时间序列

要转换的数据。

sktime 中的各种数据格式是所谓的 mtype 规范，每种 mtype 实现一种抽象 scitype。

  • Series scitype = 单个时间序列。pd.DataFrame、pd.Series 或 np.ndarray (1D 或 2D)

  • Panel scitype = 时间序列集合。pd.DataFrame，带有 2 级行 MultiIndex (instance, time)；3D np.ndarray (instance, variable, time)；list，包含 Series 类型的 pd.DataFrame

  • Hierarchical scitype = 分层时间序列集合。pd.DataFrame，带有 3 级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)

有关数据格式的更多详细信息，请参阅 mtype 术语表。有关用法，请参阅转换器教程 examples/03_transformers.ipynb

y可选，sktime 兼容数据格式的数据，默认值 = None

附加数据，例如用于转换的标签。某些转换器需要此项，详细信息请参阅类文档字符串。

返回:
X 的转换版本
类型取决于 X 的类型和 scitype:transform-output 标签

transform (转换)

X

-输出

返回类型

Series

基本特征

pd.DataFrame (1行)

Panel

基本特征

pd.DataFrame

Series

Series

Series

Panel

Series

Panel

Series

Panel

Panel
返回中的实例对应于 X 中的实例
表格中未列出的组合目前不受支持
明确说明，并举例

  • 如果 X 是 Series (例如，pd.DataFrame)

并且 transform-output 是 Series，则返回类型是相同 mtype 的单个 Series。示例：对单个序列进行去趋势

  • 如果 X 是 Panel (例如，pd-multiindex) 并且 transform-output

是 Series，则返回类型是实例数量与 X 相同的 Panel (转换器应用于每个输入 Series 实例)。示例：面板中的所有序列都单独进行去趋势

  • 如果 X 是 Series 或 Panel 并且 transform-output 是

基本特征，则返回类型是 pd.DataFrame，其行数与 X 中的实例数量相同。示例：返回值的第 i 行包含第 i 个序列的均值和方差

  • 如果 X 是 Series 并且 transform-output 是 Panel，

则返回类型是 pd-multiindex 类型的 Panel 对象。示例：输出的第 i 个实例是在 X 上运行的第 i 个窗口

update(X, y=None, update_params=True)[source]#

使用 X 更新转换器，可选地使用 y。

所需状态

要求状态为“fitted”。

在 self 中访问

  • 以“_”结尾的拟合模型属性。

  • self.is_fitted，必须为 True

写入 self

  • 以“_”结尾的拟合模型属性。

  • 如果 remember_data 标签为 True，则通过 update_data 将 X 中的值写入并更新到 self._X。

参数:
Xsktime 兼容数据容器格式的时间序列

用于更新转换的数据

sktime 中的各种数据格式是所谓的 mtype 规范，每种 mtype 实现一种抽象 scitype。

  • Series scitype = 单个时间序列。pd.DataFrame、pd.Series 或 np.ndarray (1D 或 2D)

  • Panel scitype = 时间序列集合。pd.DataFrame，带有 2 级行 MultiIndex (instance, time)；3D np.ndarray (instance, variable, time)；list，包含 Series 类型的 pd.DataFrame

  • Hierarchical scitype = 分层时间序列集合。pd.DataFrame，带有 3 级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)

有关数据格式的更多详细信息，请参阅 mtype 术语表。有关用法，请参阅转换器教程 examples/03_transformers.ipynb

y可选，sktime 兼容数据格式的数据，默认值 = None

附加数据，例如用于转换的标签。某些转换器需要此项，详细信息请参阅类文档字符串。

返回:
self估计器的拟合实例