Aggregator#

class Aggregator(flatten_single_levels=True)[source]#

从底层准备包含聚合层级的层次化数据。

此转换器通过求和为具有多级索引的 DataFrame 添加聚合层级。聚合层级在索引中包含特殊标记“__total”。聚合节点从输入数据多级索引中由上到下发现。

参数:

flatten_single_level布尔值 (默认为 True): 移除只有一个子节点的聚合节点，即 (“__total”)

属性:

is_fitted: fit 方法是否已被调用。

另请参阅

ReconcilerForecaster
Reconciler

参考资料

[1]

https://otexts.com/fpp3/hierarchical.html

示例

>>> from sktime.transformations.hierarchical.aggregate import Aggregator
>>> from sktime.utils._testing.hierarchical import _bottom_hier_datagen
>>> agg = Aggregator()
>>> y = _bottom_hier_datagen(
...     no_bottom_nodes=3,
...     no_levels=1,
...     random_seed=123,
... )
>>> y = agg.fit_transform(y)

方法

`check_is_fitted`([方法名])	检查估计器是否已拟合。
`clone`()	获取具有相同超参数和配置的对象的克隆。
`clone_tags`(estimator[, tag_names])	从另一个对象克隆标签作为动态覆盖。
`create_test_instance`([参数集])	使用第一个测试参数集构造类的实例。
`create_test_instances_and_names`([参数集])	创建所有测试实例及其名称列表。
`fit`(X[, y])	将转换器拟合到 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`()	检查对象是否由其他 BaseObjects 组成。
`load_from_path`(serial)	从文件位置加载对象。
`load_from_serial`(serial)	从序列化内存容器加载对象。
`reset`()	将对象重置到干净的初始化后状态。
`save`([path, serialization_format])	将序列化的对象保存到类字节对象或 (.zip) 文件。
`set_config`(**config_dict)	将配置标志设置为给定值。
`set_params`(**params)	设置此对象的参数。
`set_random_state`([random_state, deep, ...])	为对象设置 random_state 伪随机种子参数。
`set_tags`(**tag_dict)	将实例级别标签覆盖设置为给定值。
`transform`(X[, y])	变换 X 并返回一个变换后的版本。
`update`(X[, y, update_params])	使用 X 更新转换器，可选使用 y。

classmethod get_test_params()[source]#

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

返回:

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

将转换器拟合到 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 | 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，则返回是与 X 具有相同实例数量的 Panel（转换器应用于每个输入的 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 的标签值，并考虑标签覆盖，优先级降序排列如下：

在类的 _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 在实例上定义的标签。

collected_tagsdict

标签名: 标签值对的字典。通过嵌套继承从 _tags 类属性收集。不被通过 set_tags 或 clone_tags 设置的动态标签覆盖。: get_config()[source]#

配置是 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 类型的 dict

返回:

拟合参数字典，paramname : paramvalue 键值对包括

始终包含：此对象的所有拟合参数，如通过 get_param_names 获取的值是此对象该键的拟合参数值

如果 deep=True，还包含组件参数的键/值对，组件的参数索引为 [组件名]__[参数名]，组件名的所有参数以参数名及其值出现
如果 deep=True，还包含任意级别的组件递归，例如 [组件名]__[组件组件名]__[参数名] 等
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]#

是否返回组件的参数。

获取此对象的参数值字典。

参数:

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

如果 True，将返回此对象的参数名: 参数值字典，包括组件（= BaseObject 类型参数）的参数。

如果 False，将返回此对象的参数名: 参数值字典，但不包括组件的参数。
params键为 str 类型的 dict

返回:

参数字典，paramname : paramvalue 键值对包括

始终包含：此对象的所有参数，如通过 get_param_names 获取的值是此对象该键的参数值，值始终与构造时传入的值相同

如果 deep=True，还包含组件参数的键/值对，组件的参数索引为 [组件名]__[参数名]，组件名 的所有参数以 参数名 及其值出现
如果 deep=True，还包含任意级别的组件递归，例如 [组件名]__[组件组件名]__[参数名] 等
get_tag(tag_name, tag_value_default=None, raise_error=True)[source]#

get_tag 方法从实例中检索名称为 tag_name 的单个标签的值，并考虑标签覆盖，优先级降序排列如下：

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

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

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

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

在实例构造时。

要检索的标签名称

在类的 _tags 属性中设置的标签。
在父类的 _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]#

get_tags 方法返回一个标签字典，其键是类或其任何父类中设置的 _tags 的任何属性的键，或者通过 set_tags 或 clone_tags 设置的标签。

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

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

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

collected_tagsdict

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

在实例构造时。

要检索的标签名称

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

按继承顺序。

返回:

标签名: 标签值对的字典。通过嵌套继承从 _tags 类属性收集，然后收集来自 _tags_dynamic 对象属性的任何覆盖和新标签。: inverse_transform(X, y=None)[source]#

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

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

目前假定只有带有以下标签的转换器: “scitype:transform-input”=”Series”, “scitype:transform-output”=”Series”,

具有 inverse_transform 方法。

要求状态为“fitted”（已拟合）。: deepbool，默认为 True

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

检查对象是否由其他 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]#

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

参数:

serial输出的第一个元素，由 cls.save(None) 生成。

返回:

反序列化的自身，结果输出为 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]#

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

行为：如果 path 为 None，返回一个内存中的序列化对象；如果 path 是文件位置，则将自身在该位置存储为 zip 文件。

保存的文件是包含以下内容的 zip 文件：_metadata - 包含自身类的信息，即 type(self)；_obj - 序列化后的自身。此类使用默认的序列化方法 (pickle)。

参数:

pathNone 或文件位置 (str 或 Path)

如果为 None，自身被保存到一个内存对象中；如果是文件位置，自身被保存到该文件位置。如果

path=”estimator”，则会在当前工作目录 (cwd) 创建一个 zip 文件 estimator.zip。
path=”/home/stored/estimator”，则会创建一个 zip 文件 estimator.zip 并

存储在 /home/stored/ 中。

serialization_format: str，默认为 “pickle”

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

返回:

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

set_config(**config_dict)[source]#

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

参数:

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

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

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

jupyter 内核如何显示自身实例

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

print_changed_onlybool，默认为 True

打印自身时是否仅列出与默认值不同的自身参数 (True)，还是打印所有参数名称和值 (False)。不嵌套，即只影响自身，不影响组件估计器。

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

注意

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

set_params(**params)[source]#

设置此对象的参数。

该方法适用于简单的 skbase 对象以及复合对象。参数键字符串 <component>__<parameter> 可用于复合对象（即包含其他对象的对象），以访问组件 <component> 中的 <parameter>。不带 <component>__ 的字符串 <parameter> 也可以使用，如果这使得引用没有歧义的话，例如没有两个组件的参数同名为 <parameter>。

参数:

**paramsdict: BaseObject 参数，键必须是 <component>__<parameter> 字符串。如果 __ 后缀在 get_params 键中是唯一的，则可以作为完整字符串的别名。

返回:

self自身的引用 (参数设置后)

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

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

通过 self.get_params 查找名为 random_state 的参数，并通过 set_params 将它们设置为从 random_state 派生的整数。这些整数通过 sample_dependent_seed 从链式哈希中采样，并保证种子随机生成器的伪随机独立性。

应用于 self 中的 random_state 参数（取决于 self_policy），并且仅当 deep=True 时应用于剩余的组件对象。

注意：即使 self 没有 random_state 参数，或没有一个组件有 random_state 参数，也会调用 set_params。因此，set_random_state 会重置任何 scikit-base 对象，即使是那些没有 random_state 参数的对象。

参数:

random_stateint，RandomState 实例或 None，默认为 None

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

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

是否在 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自身的引用

set_tags(**tag_dict)[source]#

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

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

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

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

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

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

参数:

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

返回:

自身: 自身的引用。

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

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

要求状态为“fitted”（已拟合）。: deepbool，默认为 True

访问 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	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，则返回是与 X 具有相同实例数量的 Panel（转换器应用于每个输入的 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)[source]#

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

要求状态为“fitted”（已拟合）。: deepbool，默认为 True

访问 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估计器的一个已拟合实例