ColumnConcatenator#

class ColumnConcatenator[source]#

将多元序列连接成一个长单变量序列。

一种变换器，通过将每个单独的序列从左到右堆叠起来，将多元时间序列/面板数据连接成单个单变量时间序列/面板数据。

使用 pandas 的 stack() 方法进行连接

属性:
is_fitted

是否已调用 fit 方法。

示例

>>> from sktime.transformations.panel.compose import ColumnConcatenator # noqa: E501
>>> import numpy as np
>>> data = np.array([[1, 2, 3],
...                  [4, 5, 6],
...                  [7, 8, 9]])
>>> concatenator = ColumnConcatenator()
>>> concatenator.fit_transform(data)
array([[1.],
       [4.],
       [7.],
       [2.],
       [5.],
       [8.],
       [3.],
       [6.],
       [9.]])

面板数据的另一个示例。

>>> from sktime.utils._testing.panel import _make_panel
>>> panel_data = _make_panel(n_columns = 2,
...                          n_instances = 2,
...                          n_timepoints = 3)
>>> panel_data = concatenator.fit_transform(panel_data)

方法

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

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

is_composite()

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

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。
check_is_fitted(method_name=None)[source]#

检查估计器是否已拟合。

检查 _is_fitted 属性是否存在且为 True。在调用对象的 fit 方法时，is_fitted 属性应设置为 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 个元素是测试中 obj 的第 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 = 时间序列集合。pd.DataFrame 具有 2 级行 MultiIndex (实例, 时间), 3D np.ndarray (实例, 变量, 时间), list 类型的 Series 的 pd.DataFrame

  • Hierarchical scitype = 分层时间序列集合。pd.DataFrame 具有 3 级或更多级行 MultiIndex (层次_1, ..., 层次_n, 时间)

有关数据格式的更多详细信息，请参见 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 = 时间序列集合。pd.DataFrame 具有 2 级行 MultiIndex (实例, 时间), 3D np.ndarray (实例, 变量, 时间), list 类型的 Series 的 pd.DataFrame

  • Hierarchical scitype = 分层时间序列集合。pd.DataFrame 具有 3 级或更多级行 MultiIndex (层次_1, ..., 层次_n, 时间)

有关数据格式的更多详细信息，请参见 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 类型的字典

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

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

参数:
deepbool，默认值=True

是否返回组件的参数。

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

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

返回:
params键为 str 类型的 dict

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

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

  • 如果 deep=True，还包含组件参数的键/值对，组件参数索引为 [组件名称]__[参数名称]，组件名称 的所有参数以 参数名称 及其值出现

  • 如果 deep=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_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_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 或 dict 列表，默认值 = {}

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

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

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

目前假设只有具有以下标签的变换器

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

具有 inverse_transform 方法。

所需状态

要求状态为“已拟合”。

访问 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 (实例, 时间), 3D np.ndarray (实例, 变量, 时间), list 类型的 Series 的 pd.DataFrame

  • Hierarchical scitype = 分层时间序列集合。pd.DataFrame 具有 3 级或更多级行 MultiIndex (层次_1, ..., 层次_n, 时间)

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

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

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

返回:
X 的逆变换版本

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

is_composite()[source]#

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

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

返回:
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) 的结果
返回:
反序列化的 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]#

将序列化的自身保存到字节类对象或 (.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, default = “pickle”

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

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

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

参数:
config_dictdict

config 名称：config 值 对的字典。有效的 config、值及其含义如下所述

displaystr, “diagram” (默认), 或 “text”

jupyter kernel 如何显示 self 的实例

  • “diagram” = html 框图表示

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

print_changed_onlybool, default=True

打印 self 时是只列出与默认值不同的参数 (True)，还是列出所有参数名称和值 (False)。不进行嵌套，即只影响 self，不影响组件 estimator。

warningsstr, “on” (默认), 或 “off”

是否发出警告，只影响来自 sktime 的警告

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

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

backend:parallelstr, 可选, default=”None”

广播/向量化时用于并行处理的后端，可选值之一：

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

  • “loky”, “multiprocessing” 和 “threading”: 使用 joblib.Parallel

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

  • “dask”: 使用 dask，需要环境中安装 dask 包

  • “ray”: 使用 ray，需要环境中安装 ray 包

backend:parallel:paramsdict, 可选, 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，则抑制警告。

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 中的 config 复制到 self._config_dynamic。

set_params(**params)[source]#

设置此对象的参数。

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

参数:
**paramsdict

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

返回:
self对 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_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 对象值参数（即组件 estimator）中设置随机状态。

  • 如果为 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 派生，通常与其不同

返回:
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 并返回变换后的版本。

所需状态

要求状态为“已拟合”。

访问 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 (实例, 时间), 3D np.ndarray (实例, 变量, 时间), list 类型的 Series 的 pd.DataFrame

  • Hierarchical scitype = 分层时间序列集合。pd.DataFrame 具有 3 级或更多级行 MultiIndex (层次_1, ..., 层次_n, 时间)

有关数据格式的更多详细信息，请参见 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，则返回的是行数与 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 中的

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

  • 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 = 时间序列集合。pd.DataFrame 具有 2 级行 MultiIndex (实例, 时间), 3D np.ndarray (实例, 变量, 时间), list 类型的 Series 的 pd.DataFrame

  • Hierarchical scitype = 分层时间序列集合。pd.DataFrame 具有 3 级或更多级行 MultiIndex (层次_1, ..., 层次_n, 时间)

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

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

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

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