ColumnEnsembleTransformer#

class ColumnEnsembleTransformer(transformers, remainder=None, feature_names_out='auto')[source]#

按列应用变换器。

将变换应用于数组或 pandas DataFrame 的列。它简单地采用 sklearn 中的列变换器，并增加了处理 pandas DataFrame 的能力。

该估计器允许对输入的不同的列或列子集分别进行变换，并且每个变换器生成的特征将被串联起来形成一个单一的特征空间。这对于异构或列式数据非常有用，可以将多种特征提取机制或变换组合到一个单一的变换器中。

注意：此估计器的效果与将 FeatureUnion 与 ColumnSelect 组合起来相同，但可能更方便或更紧凑。

参数:
transformerssktime trafo，或元组列表 (str, estimator, int 或 pd.index)

如果是元组，name = str，estimator 是 transformer，index 是 int 或 index。如果最后一个元素是 index，它必须是 int、str 或 pd.Index 可强制转换类型。如果最后一个元素是 int x，并且不在 columns 中，则解释为第 x 列。所有列必须存在于索引中。

如果是单个 transformer，则将其克隆应用于所有列。如果是元组列表，则元组中的 transformer 应用于具有 int/str 索引的列。

remainder{"drop", "passthrough"} 或 estimator，默认 "drop"

默认情况下，只有 transformations 中指定的列会被变换并合并到输出中，未指定的列会被丢弃（默认值为 "drop"）。通过指定 remainder="passthrough"，所有未在 transformations 中指定的剩余列将自动通过。这部分列将与变换的输出串联起来。通过将 remainder 设置为一个 estimator，剩余未指定的列将使用 remainder 估计器。该估计器必须支持 fit 和 transform 方法。

feature_names_outstr，以下之一：“auto”（默认）、“flat”、“multiindex”、“original”

确定返回 DataFrame 的列如何命名。如果返回 mtype 没有列名，则此参数无效。“flat”：列名是平坦的，例如，“transformername__variablename”；“multiindex”：列名是 MultiIndex，例如，(transformername, variablename)；“original”：列名与 transformer 产生的相同，例如，variablename

如果这导致非唯一的索引，则会引发 ValueError 异常

“auto”：对于“original”下的任何唯一列，与“original”相同，

否则列名为“flat”

属性:
transformers_列表

拟合后的变换集合，以元组 (name, fitted_transformer, column) 的形式表示。fitted_transformer 可以是 estimator、“drop”或“passthrough”。如果没有选择任何列，这将是未拟合的 transformer。如果存在剩余列，则最后一个元素是一个形式为：(“remainder”, transformer, remaining_columns) 的元组，对应于 remainder 参数。如果存在剩余列，则 len(transformers_)==len(transformations)+1，否则 len(transformers_)==len(transformations)。

示例

>>> import pandas as pd
>>> from sktime.transformations.compose import ColumnEnsembleTransformer
>>> from sktime.transformations.series.detrend import Detrender
>>> from sktime.transformations.series.difference import Differencer
>>> from sktime.datasets import load_longley

使用整数（列的 iloc 引用）进行索引

>>> y = load_longley()[1][["GNP", "UNEMP"]]
>>> transformer = ColumnEnsembleTransformer([("difference", Differencer(), 1),
...                                 ("trend", Detrender(), 0),
...                                 ])
>>> y_transformed = transformer.fit_transform(y)

使用字符串进行索引

>>> df = pd.DataFrame({"a": [1, 2, 3], "b": [4, 5, 6]})
>>> transformer = ColumnEnsembleTransformer(
...     [("foo", Differencer(), "a"), ("bar", Detrender(), "b")]
... )
>>> transformed_df = transformer.fit_transform(df)

将一个 transformer 应用于多列，多元情况

>>> df = pd.DataFrame({"a": [1, 2, 3], "b": [4, 5, 6], "c": [7, 8, 9]})
>>> transformer = ColumnEnsembleTransformer(
...    [("ab", Differencer(), ["a", 1]), ("c", Detrender(), 2)]
... )
>>> transformed_df = transformer.fit_transform(df)

方法

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

将 transformer 拟合到 X，可选地拟合到 y。

fit_transform(X[, y])

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

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

获取估计器的参数。

get_tag(tag_name[, tag_value_default, ...])

从实例中获取标签值，并考虑标签级别继承和覆盖。

get_tags()

从实例中获取标签，并考虑标签级别继承和覆盖。

get_test_params()

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

inverse_transform(X[, y])

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

is_composite()

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

load_from_path(serial)

从文件位置加载对象。

load_from_serial(serial)

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

reset()

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

save([path, serialization_format])

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

set_config(**config_dict)

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

set_params(**kwargs)

设置估计器的参数。

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

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

set_tags(**tag_dict)

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

transform(X[, y])

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

update(X[, y, update_params])

使用 X 更新 transformer，可选地使用 y。
classmethod get_test_params()[source]#

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

返回:
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_namestr，可选

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

引发:
NotFittedError

如果估计器尚未拟合。

clone()[source]#

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

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

等同于构造一个 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 或 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 个元素是测试中 objs 中第 i 个实例的名称。如果实例多于一个，命名约定为 {cls.__name__}-{i}，否则为 {cls.__name__}。

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

将 transformer 拟合到 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 = 时间序列集合。具有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，或者 Series 类型 pd.DataFrame 的 list

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

有关数据格式的更多详细信息，请参阅 mtype 词汇表。有关用法，请参阅 transformer 教程 examples/03_transformers.ipynb

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

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

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

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

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

状态变化

将状态更改为“fitted”。

写入 self: _is_fitted : 标志设置为 True。 _X : X，如果 remember_data 标签为 True，则是 X 的强制转换副本

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

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

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

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

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

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

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

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

有关数据格式的更多详细信息，请参阅 mtype 词汇表。有关用法，请参阅 transformer 教程 examples/03_transformers.ipynb

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

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

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

|----------|————–|------------------------| | Series | Primitives | pd.DataFrame (1-row) | | Panel | Primitives | 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，则返回是 Panel，其实例数量与 X 相同（transformer 应用于每个输入的 Series 实例）。示例：面板中的所有序列都被单独去趋势

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

Primitives，则返回是 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_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]#

获取拟合后的参数。

所需状态

要求状态为“fitted”。

参数:
deep布尔值，默认为 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]#

获取对象的参数名称。

参数:
sort布尔值，默认为 True

是否按字母顺序（True）或按它们在类 __init__ 中出现的顺序（False）返回参数名称。

返回:
param_names: list[str]

cls 的参数名称列表。如果 sort=False，则按它们在类 __init__ 中出现的相同顺序排列。如果 sort=True，则按字母顺序排列。

get_params(deep=True)[source]#

获取估计器的参数。

参数:
deep布尔值，可选

如果为 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_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 对象属性中获取任何覆盖和新标签。

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

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

目前假定只有带有标签的 transformer

“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 = 时间序列集合。具有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，或者 Series 类型 pd.DataFrame 的 list

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

有关数据格式的更多详细信息，请参阅 mtype 词汇表。有关用法，请参阅 transformer 教程 examples/03_transformers.ipynb

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

附加数据，例如用于变换的标签。某些 transformer 需要此数据，详情请参阅类文档字符串。

返回:
X 的逆变换版本

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

is_composite()[来源]#

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

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

返回:
composite: 布尔值，指示 self 是否包含一个参数，该参数是 BaseObject
property is_fitted[来源]#

指示是否已调用 fit 方法。

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

返回:
布尔值

指示估计器是否已 拟合。

classmethod load_from_path(serial)[来源]#

从文件位置加载对象。

参数:
serialZipFile(path).open(“object) 的结果
返回:
反序列化后的 self，其结果输出到 path，与 cls.save(path) 的输出相同。
classmethod load_from_serial(serial)[来源]#

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

参数:
serialcls.save(None) 输出的第一个元素
返回:
反序列化后的 self，其结果输出为 serial，与 cls.save(None) 的输出相同。
reset()[来源]#

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

将 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')[来源]#

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

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

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

参数:
pathNone 或 文件位置 (str 或 Path)

如果为 None，则将 self 保存到内存对象中；如果是文件位置，则将 self 保存到该文件位置。如果

  • path=”estimator” 则会在当前工作目录 (cwd) 中创建一个 zip 文件 estimator.zip。

  • path=”/home/stored/estimator” 则会创建一个 zip 文件 estimator.zip 并

存储在 /home/stored/ 中。

serialization_format: 字符串，默认 = “pickle”

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

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

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

参数:
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，则抑制警告

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

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

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

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

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

output_conversion字符串，“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)[来源]#

设置估计器的参数。

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

返回:
self返回 self 的一个实例。
set_random_state(random_state=None, deep=True, self_policy='copy')[来源]#

为自身设置 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_state整数、RandomState 实例或 None，默认=None

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

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)[来源]#

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

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

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

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

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

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

参数:
**tag_dict字典

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

返回:
自身

对 self 的引用。

transform(X, y=None)[来源]#

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

所需状态

要求状态为“fitted”。

访问 self

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

  • self.is_fitted，必须为 True

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

要转换的数据。

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

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

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

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

有关数据格式的更多详细信息，请参阅 mtype 词汇表。有关用法，请参阅 transformer 教程 examples/03_transformers.ipynb

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

附加数据，例如用于变换的标签。某些 transformer 需要此数据，详情请参阅类文档字符串。

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

转换

X

-输出

返回类型

Series

Primitives

pd.DataFrame (1 行)

Panel

Primitives

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，则返回是 Panel，其实例数量与 X 相同（transformer 应用于每个输入的 Series 实例）。示例：面板中的所有序列都被单独去趋势

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

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

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

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

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

使用 X 更新 transformer，可选地使用 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 = 时间序列集合。具有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，或者 Series 类型 pd.DataFrame 的 list

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

有关数据格式的更多详细信息，请参阅 mtype 词汇表。有关用法，请参阅 transformer 教程 examples/03_transformers.ipynb

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

附加数据，例如用于变换的标签。某些 transformer 需要此数据，详情请参阅类文档字符串。

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