FourierFeatures

class FourierFeatures(sp_list: list[float], fourier_terms_list: list[int], freq: str | None = None, keep_original_columns: bool | None = False)

用于时间序列季节性的傅里叶特征。

傅里叶级数项可用作解释变量，用于处理多个季节周期和/或复杂/长季节周期的情况 [1], [2], [2]. 对于每个季节周期 \(sp\) 和傅里叶项 \(k\) 对，都有 2 个傅里叶项 sin_sp_k 和 cos_sp_k

• sin_sp_k = \(sin(\frac{2 \pi k t}{sp})\)

• cos_sp_k = \(cos(\frac{2 \pi k t}{sp})\)

其中 \(t\) 是自季节周期开始以来的经过时间，\(sp\) 是季节周期总时长。

变换后的输出是一个包含所有请求的傅里叶项的时间序列。

警告：在默认设置下，输出将仅包含傅里叶项，并丢弃输入数据的原始列，以避免在管道或 FeatureUnion 中重复原始数据。要保留原始列，请设置 keep_original_columns=True。

列的名称生成方式如下：额外的列采用上述命名约定（sin_sp_k 和 cos_sp_k）。fourier_terms_list 中傅里叶项 \(K\) 的数量决定了每个季节周期将使用的傅里叶项数量，即对于相同列表索引的季节性 \(sp\)，将生成傅里叶项 \(k = 1\dots K\)（整数）、余弦项和正弦项。例如，考虑 sp_list = [12, “Y”] 和 fourier_terms_list = [2, 1]。这意味着我们将为季节性 12 周期计算 2 个（2 个余弦项，2 个正弦项）傅里叶项，并为年度季节性 “Y” 计算 1 个（1 个余弦项和 1 个正弦项）傅里叶项。变换后的序列将具有以下名称的列：“cos_12_1”、“sin_12_1”、“cos_12_2”、“sin_12_2”、“cos_Y_1”、“sin_Y_1”

该实现基于 R forecast 包中的 fourier 函数 [3]

参数：

sp_listList[float 和/或 str]

季节周期列表。可以使用以下选项定义

• float：定义为自 fit 中看到的数据开始以来的时间步长数量的周期性。
• string：定义为 X 中包含 \(t/sp\) 值的列名的周期性。
• string：定义为 pandas 周期别名的周期性：https://pandas.ac.cn/pandas-docs/stable/user_guide/timeseries.html#period-aliases

fourier_terms_listList[int]

对应 \(sp\) 的傅里叶项数量 (\(K\)) 列表；每个 \(K\) 与 sp_list 中的一个 \(sp\) 对应。例如，如果 sp_list = [7, “Y”] 且 fourier_terms_list = [3, 9]，则 7 个时间步长的季节性将有 3 个 sin_sp_k 和 3 个 cos_sp_k 傅里叶项，年度季节性 “Y” 将有 9 个 sin_sp_k 和 9 个 cos_sp_k 傅里叶项。

freqstr，可选，默认为 None

仅当 X 具有未指定频率的 pd.DatetimeIndex 时使用。指定数据索引的频率。字符串应与 pandas 偏移量别名匹配

https://pandas.ac.cn/pandas-docs/stable/user_guide/timeseries.html#offset-aliases

keep_original_columns布尔值，可选，默认为 False

保留传递给 .transform() 的 X 中的原始列

属性：

is_fitted

是否已调用 fit。

参考文献

[1]

Hyndsight - Forecasting with long seasonal periods: https://robjhyndman.com/hyndsight/longseasonality/

[2]

Hyndman, R.J., & Athanasopoulos, G. (2021) Forecasting: principles and practice, 3rd edition, OTexts: Melbourne, Australia. OTexts.com/fpp3. Accessed on August 14th 2022.

[3]

https://pkg.robjhyndman.com/forecast/reference/fourier.html

示例

>>> from sktime.transformations.series.fourier import FourierFeatures
>>> from sktime.datasets import load_airline
>>> y = load_airline()
>>> transformer = FourierFeatures(sp_list=[12, "Y"], fourier_terms_list=[4, 1])
>>> y_hat = transformer.fit_transform(y)

方法

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])	返回估计器的测试参数设置。
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(parameter_set='default')

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

参数：

parameter_setstr, 默认为“default”

要返回的测试参数集的名称，用于测试。如果未为某个值定义特殊参数，将返回 "default" 集。当前没有为变换器保留的值。

返回值：

params字典或字典列表，默认为 {}

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

check_is_fitted(method_name=None)

检查估计器是否已拟合。

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

如果不是，则引发 NotFittedError。

参数：

method_namestr，可选

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

引发：

NotFittedError

如果估计器尚未拟合。

clone()

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

克隆是一个没有共享引用、处于初始化后状态的不同对象。此函数等同于返回 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)

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

每个与 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')

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

参数：

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 个元素是测试中对象第 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")。

参数：

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), Series 类型的 pd.DataFrame list

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

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

将变换器拟合到 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), Series 类型的 pd.DataFrame list

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

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

每个与 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()

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

每个与 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()

获取对象的配置标志。

配置是 self 的键值对，通常用作控制行为的瞬态标志。

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

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

配置在调用 clone 或 reset 后仍然保留。

返回值：

config_dictdict

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

get_fitted_params(deep=True)

获取拟合参数。

所需状态

要求状态为“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()

获取对象的默认参数。

返回值：

default_dict: dict[str, Any]

键是 cls 中在 __init__ 中定义了默认值的所有参数。值是在 __init__ 中定义的默认值。

classmethod get_param_names(sort=True)

获取对象的参数名称。

参数：

sort布尔值，默认为 True

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

返回值：

param_names: list[str]

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

get_params(deep=True)

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

参数：

deep布尔值，默认为 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)

从实例中获取标签值，具有标签级别继承和覆盖。

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

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

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

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

在实例构建时设置。

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

3. 在父类的 _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()

从实例中获取标签，具有标签级别继承和覆盖。

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

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

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

值是相应的标签值，按以下优先级降序排列

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

在实例构建时设置。

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

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

按继承顺序排列。

返回值：

collected_tags字典

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

inverse_transform(X, y=None)

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

目前假设只有带有以下标签的转换器

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

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

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

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

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

返回值：

X 的逆转换版本

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

is_composite()

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

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

返回值：

composite: 布尔值

对象是否有任何参数，其值是 BaseObject 的后代实例。

property is_fitted

是否已调用 fit。

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

返回值：

布尔值

估计器是否已 fit。

classmethod load_from_path(serial)

从文件位置加载对象。

参数：

serialZipFile(path).open(“object) 的结果

返回值：

反序列化的 self，产生 cls.save(path) 在 path 处的输出

classmethod load_from_serial(serial)

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

参数：

serialcls.save(None) 输出的第一个元素

返回值：

反序列化的 self，产生 cls.save(None) 的输出 serial

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: str，默认值 = “pickle”

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

返回值：

如果 path 为 None - 内存中的序列化 self

如果 path 是文件位置 - 引用该文件的 ZipFile

set_config(**config_dict)

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

参数：

config_dictdict

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

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

jupyter 内核如何显示 self 的实例

• “diagram” = html 框图表示

• “text” = 字符串输出

print_changed_only布尔值，默认值=True

打印 self 时是否仅列出与默认值不同的 self 参数（False），还是列出所有参数名称和值（False）。不嵌套，即仅影响 self 而不影响组件估计器。

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”：布尔值，默认值=True；False 可阻止 ray 在并行化后

    关闭。

  • “logger_name”：str，默认值=”ray”；要使用的日志记录器名称。

  • “mute_warnings”：布尔值，默认值=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)

设置此对象的参数。

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

参数：

**params字典

BaseObject 参数，键必须是 <component>__<parameter> 字符串。如果 __ 后缀在 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_stateint，RandomState 实例或 None，默认值=None

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

deep布尔值，默认为 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指向 self 的引用

set_tags(**tag_dict)

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

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

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

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

set_tags 方法只能在对象的 __init__ 方法中调用，即在构建期间或通过 __init__ 直接构建之后。

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

参数：

**tag_dict字典

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

返回值：

Self

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

• Hierarchical scitype = 分层时间序列集合。pd.DataFrame，带有 3 级或更多级行 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	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)

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

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

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

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

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

返回值：

self估计器的拟合实例