Tabularizer#

class Tabularizer[source]#

一个将时间序列/面板数据转换为表格数据的转换器。

该估计器将包含时间序列/面板数据的嵌套 pandas DataFrame（其中单元格包含 numpy 数组或 pandas Series）转换为仅在单元格中包含基本类型的表格 pandas DataFrame。这对于将时间序列/面板数据转换为标准验证学习算法（如 sklearn）接受的格式非常有用。

属性:
is_fitted

是否已调用 fit。

方法

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

获取对象的配置标志。

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

返回 skbase 对象的测试参数设置。

inverse_transform(X[, y])

将表格 pandas DataFrame 转换为嵌套 DataFrame。

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。
inverse_transform(X, y=None)[source]#

将表格 pandas DataFrame 转换为嵌套 DataFrame。

参数:
Xpandas DataFrame

单元格中包含基本类型的表格 DataFrame。

yarray-like，可选（默认=None）
返回值:
Xtpandas DataFrame

单元格中包含序列的转换后的 DataFrame。

check_is_fitted(method_name=None)[source]#

检查估计器是否已拟合。

检查 _is_fitted 属性是否存在且为 True。is_fitted 属性应在调用对象的 fit 方法时设置为 True。

如果不是，则引发 NotFittedError。

参数:
method_namestr，可选

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

引发:
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_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。

状态更改

将状态更改为“已拟合”。

写入 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 词汇表。有关用法，请参阅转换器教程 examples/03_transformers.ipynb

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

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

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

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

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

状态更改

将状态更改为“已拟合”。

写入 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 词汇表。有关用法，请参阅转换器教程 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，则返回值为具有与 X 中实例数量相同行数的 pd.DataFrame。示例：返回值的第 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 的键值对，通常用作控制行为的临时标志。

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

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

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

返回值:
config_dictdict

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

get_fitted_params(deep=True)[source]#

获取已拟合的参数。

所需状态

需要状态为“已拟合”。

参数:
deepbool，默认=True

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

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

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

返回值:
fitted_params带有 str 值键的 dict

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

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

参数:
deepbool，默认=True

是否返回组件的参数。

  • 如果为 True，将返回此对象的参数名称 : 值 dict，包括组件参数（= BaseObject 值参数）。

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

返回值:
params带有 str 值键的 dict

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

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

  • 如果 deep=True，还包含组件参数的键/值对，组件参数按 [componentname]__[paramname] 索引，componentname 的所有参数都显示为 paramname 及其值

  • 如果 deep=True，还包含任意级别的组件递归，例如 [componentname]__[componentcomponentname]__[paramname] 等

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

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

返回 skbase 对象的测试参数设置。

get_test_params 是一个统一的接口点，用于存储用于测试目的的参数设置。此函数也用于 create_test_instance 和 create_test_instances_and_names 中以构建测试实例。

get_test_params 应返回一个单独的 dict，或一个 dict 的 list。

每个 dict 都是用于测试的参数配置，可用于构建一个“有趣的”测试实例。对于 get_test_params 返回中所有的字典 params，调用 cls(**params) 都应是有效的。

无需返回固定的字典列表，get_test_params 也可以返回动态或随机的参数设置。

参数:
parameter_setstr，默认=”default”

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

返回值:
paramsdict 或 list of dict，默认 = {}

用于创建类测试实例的参数。每个 dict 都是用于构建“有趣的”测试实例的参数，即 MyClass(**params) 或 MyClass(**params[i]) 创建一个有效的测试实例。create_test_instance 使用 params 中的第一个（或唯一的）字典。

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) 输出的第一个元素
返回值:
反序列化的自身，其输出为 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_dictdict

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

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

jupyter 内核如何显示自身的实例

  • “diagram” = html 框图表示

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

print_changed_onlybool，默认=True

打印自身时是仅列出自参数中与默认值不同的参数 (False)，还是列出所有参数名称和值 (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>。如果引用是明确的（例如，没有两个组件的参数具有相同的名称 <parameter>），也可以使用不带 <component>__ 的字符串 <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 派生的整数。这些整数通过链式哈希 (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，默认=None

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

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对自身的引用
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 并返回转换后的版本。

所需状态

需要状态为“已拟合”。

自身访问

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

  • 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 词汇表。有关用法，请参阅转换器教程 examples/03_transformers.ipynb

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

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

返回值:
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，则返回值为具有与 X 相同数量实例的 Panel（转换器应用于每个输入 Series 实例）。示例：面板中的所有序列都单独进行去趋势

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

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

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

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

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

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

所需状态

需要状态为“已拟合”。

自身访问

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

  • self.is_fitted，必须为 True

写入 self

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

  • 如果 remember_data 标签为 True，则通过 update_data 写入 self._X，使用 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 词汇表。有关用法，请参阅转换器教程 examples/03_transformers.ipynb

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

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

返回值:
self估计器的一个已拟合实例