FourierTransform#

类 FourierTransform[源码]#

用于时间序列的简单傅里叶变换。

该实现基于 numpy.fft.rfft 的实快速傅里叶变换。返回整数范围频率的振幅 pd.Series。假定数据是均匀采样的，频率范围转换为整数。

属性：
is_fitted

是否已调用 fit。

示例

>>> from sktime.transformations.series.fourier import FourierTransform
>>> from sktime.datasets import load_airline
>>> X = load_airline()
>>> transformer = FourierTransform()
>>> X_ft = transformer.fit_transform(X)

方法

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

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

inverse_transform(X[, y])

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

is_composite()

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

load_from_path(serial)

从文件位置加载对象。

load_from_serial(serial)

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

reset()

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

save([path, serialization_format])

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

set_config(**config_dict)

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

set_params(**params)

设置此对象的参数。

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

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

set_tags(**tag_dict)

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

transform(X[, y])

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

update(X[, y, update_params])

使用 X 更新变换器，可选使用 y。
check_is_fitted(method_name=None)[源码]#

检查估计器是否已拟合。

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

如果不是，则抛出 NotFittedError。

参数：
method_namestr，可选

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

抛出：
NotFittedError

如果估计器尚未拟合。

clone()[源码]#

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

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

等同于使用 self 的参数构造一个 type(self) 的新实例，即 type(self)(**self.get_params(deep=False))。

如果在 self 上设置了 configs，克隆也将具有与原始对象相同的 configs，等同于调用 cloned_self.set_config(**self.get_config())。

在值上也等同于调用 self.reset，但不同之处在于 clone 返回一个新对象，而不是像 reset 那样修改 self。

抛出：
如果克隆不符合要求，则抛出 RuntimeError，原因是 __init__ 有误。
classmethod clone_tags(estimator, tag_names=None)[源码]#

从另一个对象克隆标签作为动态覆盖。

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

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

clone_tags 从另一个对象 estimator 设置动态标签覆盖。

The clone_tags method should be called only in the __init__ method of an object, during construction, or directly after construction via __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')[源码]#

使用第一个测试参数集构建类的实例。

参数：
parameter_setstr，默认为 “default”

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

返回：
instance具有默认参数的类实例
classmethod create_test_instances_and_names(parameter_set='default')[源码]#

创建所有测试实例的列表和它们的名称列表。

参数：
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)[源码]#

将变换器拟合到 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")。

参数：
X符合 sktime 数据容器格式的时间序列

用于拟合变换的数据。

sktime 中的个体数据格式称为 mtype 规范，每种 mtype 实现一种抽象的 scitype。

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

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

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

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

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

额外数据，例如用于变换的标签。有些变换器需要此参数，非可选，必须在 fit 中传入。有关所需格式，请参阅类文档字符串了解详细信息。

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

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

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

状态更改

将状态更改为 “fitted”。

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

可能在可能的情况下通过引用强制转换为内部类型或 update_data 兼容类型

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

参数：
X符合 sktime 数据容器格式的时间序列

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

sktime 中的个体数据格式称为 mtype 规范，每种 mtype 实现一种抽象的 scitype。

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

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

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

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

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

额外数据，例如用于变换的标签。有些变换器需要此参数，非可选，必须在 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)[源码]#

从类获取类标签值，具有来自父类的标签级别继承。

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

get_class_tag 方法是一个类方法，它检索标签的值，仅考虑类级别的标签值和覆盖。

它从对象中返回名称为 tag_name 的标签值，考虑标签覆盖，按以下降序优先级：

  1. 在类的 _tags 属性中设置的标签。

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

按继承顺序。

不考虑在实例上设置的动态标签覆盖，即通过 set_tags 或 clone_tags 定义在实例上的。

要检索具有潜在实例覆盖的标签值，请改用 get_tag 方法。

参数：
tag_namestr

标签值的名称。

tag_value_default任意类型，可选；默认为 None

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

返回：
tag_value

self 中 tag_name 标签的值。如果未找到，并且 raise_error 为 True，则抛出错误，否则返回 tag_value_default。

classmethod get_class_tags()[源码]#

从类获取类标签，具有来自父类的标签级别继承。

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

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

get_class_tags 方法是一个类方法，它检索标签的值，仅考虑类级别的标签值和覆盖。

它返回一个字典，其键是类或其任何父类中设置的 _tags 属性的任何键。

值是相应的标签值，覆盖按以下降序优先级：

  1. 在类的 _tags 属性中设置的标签。

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

按继承顺序。

实例可以根据超参数覆盖这些标签。

要检索具有潜在实例覆盖的标签，请改用 get_tags 方法。

不考虑在实例上设置的动态标签覆盖，即通过 set_tags 或 clone_tags 定义在实例上的。

For including overrides from dynamic tags, use get_tags.

collected_tagsdict

标签名称：标签值 对的字典。通过嵌套继承从 _tags 类属性收集，然后包含来自 _tags_dynamic 对象属性的任何覆盖和新标签。（Note: Correcting typo from `_onfig_dynamic` to `_tags_dynamic` based on context and likely intent). -> 标签名称：标签值 对的字典。通过嵌套继承从 _tags 类属性收集，然后包含来自 _tags_dynamic 对象属性的任何覆盖和新标签。

get_config()[source]#

获取 self 的配置标志。

Configs 是 self 的键值对，通常用作控制行为的临时标志。

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

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

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

返回：
config_dictdict

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

get_fitted_params(deep=True)[source]#

获取拟合参数。

所需状态

需要状态为“已拟合 (fitted)”。

参数：
deepbool, default=True

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

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

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

返回：
fitted_paramsdict with str-valued keys

拟合参数字典，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, default=True

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

返回：
param_names: list[str]

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

get_params(deep=True)[source]#

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

参数：
deepbool, default=True

是否返回组件的参数。

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

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

返回：
paramsdict with str-valued keys

参数字典，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 或 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 方法。

所需状态

需要状态为“已拟合 (fitted)”。

访问 self 中的属性

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

  • self.is_fitted，必须为 True。

参数：
X符合 sktime 数据容器格式的时间序列

用于拟合变换的数据。

sktime 中的个体数据格式称为 mtype 规范，每种 mtype 实现一种抽象的 scitype。

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

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

  • Hierarchical scitype = 分层时间序列集合。pd.DataFrame 具有三级或更多级行 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”) 的结果
返回：
反序列化的 self，生成 cls.save(path) 在 path 位置的输出。
classmethod load_from_serial(serial)[source]#

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

参数：
serialcls.save(None) 输出的第一个元素
返回：
反序列化的 self，生成 cls.save(None) 的输出 serial。
reset()[source]#

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

导致将 self 设置为构造函数调用后直接处于的状态，并保持相同的超参数。set_config 设置的配置值也会保留。

reset 调用会删除任何对象属性，除了：

  • 超参数 = __init__ 的参数写入 self 的属性，例如 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”，则 zip 文件 estimator.zip 将

存储在 /home/stored/ 中。

serialization_format: str, default = “pickle”

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

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

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

参数：
config_dictdict

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

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

jupyter kernel 显示 self 实例的方式。

  • “diagram” = html 框图表示

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

print_changed_onlybool, default=True

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

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

是否引发警告，仅影响来自 sktime 的警告。

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

  • “off” = 不会引发来自 sktime 的警告

backend:parallelstr, optional, default=”None”

广播/矢量化时用于并行化的后端，以下之一：

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

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

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

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

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

backend:parallel:paramsdict, optional, 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”; 要使用的 logger 名称。

    • “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 中的配置复制到 self._config_dynamic。

set_params(**params)[source]#

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

设置此对象的参数。

**paramsdict

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

self对 self 的引用（设置参数后）。

返回：
set_random_state(random_state=None, deep=True, self_policy='copy')[source]#
通过 self.get_params 查找名为 random_state 的参数，并通过 set_params 将它们设置为从 random_state 派生的整数。这些整数通过 sample_dependent_seed 进行链式哈希采样，保证了种子随机生成器的伪随机独立性。

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

根据 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 可在多次函数调用中获得可重现的输出。

是否在 skbase 对象值参数（即组件估计器）中设置随机状态。

deepbool, default=True

如果为 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]#
标签是特定于实例 self 的键值对，它们是静态标志，在对象构造后不会更改。它们可用于元数据检查或控制对象的行为。

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

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

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

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

**tag_dictdict

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

参数：
标签名称 : 标签值 对的字典。

Self

返回：
对 self 的引用。

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

要转换的数据。

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

所需状态

需要状态为“已拟合 (fitted)”。

访问 self 中的属性

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

  • self.is_fitted，必须为 True。

参数：
X符合 sktime 数据容器格式的时间序列

转换

sktime 中的个体数据格式称为 mtype 规范，每种 mtype 实现一种抽象的 scitype。

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

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

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

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

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

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

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

X

-输出

返回类型

Series

Primitives

pd.DataFrame (1行)

Panel

pd.DataFrame

pd.DataFrame (1行)

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

Primitives

Primitives

Primitives

pd.DataFrame

Primitives

pd.DataFrame

Primitives

pd.DataFrame

pd.DataFrame
返回中的实例对应于 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 个窗口。

如果 remember_data 标签为 True，则通过 update_data 将数据写入 self._X，并根据 X 中的值进行更新。

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

所需状态

需要状态为“已拟合 (fitted)”。

访问 self 中的属性

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

  • self.is_fitted，必须为 True。

写入 self

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

  • 用于更新转换的数据。

参数：
X符合 sktime 数据容器格式的时间序列

在此页面上

sktime 中的个体数据格式称为 mtype 规范，每种 mtype 实现一种抽象的 scitype。

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

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

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

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

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

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

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