HPFilter

class HPFilter(lamb=1600)

使用 Hodrick-Prescott 滤波器过滤时间序列。

这是 statsmodels 中 hpfilter 函数的包装器。（参见 statsmodels.tsa.filters.hp_filter.hpfilter）。

参数:

lambfloat

Hodrick-Prescott 平滑参数。季度数据建议使用 1600。Ravn 和 Uhlig 建议年度数据使用 6.25 (1600/4**4)，月度数据使用 129600 (1600*3**4)。

属性:

is_fitted

是否已调用 fit。

备注

HP 滤波器去除平滑趋势

Hodrick, R.J, and E. C. Prescott. 1980. “Postwar U.S. Business Cycles: An

Empirical Investigation.” Carnegie Mellon University discussion paper no. 451.

Ravn, M.O and H. Uhlig. 2002. “Notes On Adjusted the Hodrick-Prescott

Filter for the Frequency of Observations.” The Review of Economics and Statistics, 84(2), 371-80.

示例

>>> from sktime.transformations.series.hpfilter import HPFilter 
>>> import pandas as pd 
>>> import statsmodels.api as sm 
>>> dta = sm.datasets.macrodata.load_pandas().data 
>>> index = pd.period_range('1959Q1', '2009Q3', freq='Q') 
>>> dta.set_index(index, inplace=True) 
>>> hp = HPFilter(1600) 
>>> cycles = hp.fit_transform(X=dta[['realinv']]) 

方法

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" 集。当前变换器没有保留值。

返回:

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

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

check_is_fitted(method_name=None)

检查估计器是否已拟合。

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

如果不是，则引发 NotFittedError。

参数:

method_namestr，可选

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

引发:

NotFittedError

如果估计器尚未拟合。

clone()

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

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

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

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

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

引发:

如果由于 __init__ 错误导致克隆不符合要求，则引发 RuntimeError。

clone_tags(estimator, tag_names=None)

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

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

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

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

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

动态标签被设置为 estimator 中标签的值，名称在 tag_names 中指定。

tag_names 的默认值是将 estimator 中的所有标签写入 self。

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

参数:

estimator:class:BaseObject 或派生类的实例

tag_namesstr 或 list of 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 个 obj 实例的名称。如果多于一个实例，命名约定是 {cls.__name__}-{i}，否则是 {cls.__name__}

fit(X, y=None)

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

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

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

状态变化

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

写入 self: _is_fitted : 标志设置为 True。 _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 (实例, 时间), 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)

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

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

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

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

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

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

按继承顺序。

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

要检索可能包含实例覆盖的标签值，请改用 get_tag 方法。

参数:

tag_namestr

标签值的名称。

tag_value_default任意类型

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

返回:

tag_value

对象中 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()

获取对象的配置标志。

配置是对象的键值对，通常用作控制行为的临时标志。

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

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

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

返回:

config_dictdict

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

get_fitted_params(deep=True)

获取已拟合参数。

所需状态

需要状态为“已拟合”。

参数:

deepbool，默认值=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)

获取对象的参数名称。

参数:

sortbool，默认值=True

是否按字母顺序返回参数名称 (True)，或者按它们在类 __init__ 中出现的顺序返回 (False)。

返回:

param_names: list[str]

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

get_params(deep=True)

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

参数:

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)

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

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

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

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

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

在实例构造时。

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

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

按继承顺序。

参数:

tag_namestr

要检索的标签名称

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

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

raise_errorbool

未找到标签时是否引发 ValueError

返回:

tag_valueAny

对象中 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_tagsdict

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

inverse_transform(X, y=None)

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

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

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

具有 inverse_transform 方法。

所需状态

需要状态为“已拟合”。

访问对象自身

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

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

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

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

返回:

composite: bool

对象的任何参数值是否是 BaseObject 的派生类实例。

property is_fitted

是否已调用 fit。

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

返回:

bool

估计器是否已 fit。

classmethod load_from_path(serial)

从文件位置加载对象。

参数:

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

返回:

反序列化的对象，结果输出到 path，是 cls.save(path) 的输出

classmethod load_from_serial(serial)

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

参数:

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

返回:

反序列化的对象，结果输出为 serial，是 cls.save(None) 的输出

reset()

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

结果是将对象设置为构造函数调用后立即拥有的状态，具有相同的超参数。通过 set_config 设置的配置值也会保留。

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

• 超参数 = 写入对象的 __init__ 的参数，例如 self.paramname，其中 paramname 是 __init__ 的参数

• 包含双下划线的对象属性，即字符串“__”。例如，名为“__myattr”的属性会被保留。

• 配置属性，配置保持不变。也就是说，在 reset 之前和之后调用 get_config 的结果是相同的。

类和对象方法，以及类属性也不受影响。

等效于 clone，不同之处在于 reset 修改对象本身，而不是返回一个新对象。

在调用 self.reset() 后，对象在值和状态上与构造函数调用``type(self)(self.get_params(deep=False))`` 后获得的 对象相等。

返回:

self

类实例重置到干净的初始状态后，但保留当前超参数值。

save(path=None, serialization_format='pickle')

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

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

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

参数:

pathNone 或文件位置 (str 或 Path)

如果为 None，对象保存到内存对象中；如果是文件位置，则将对象保存到该文件位置。如果

• path=”estimator”，则会在当前工作目录创建 estimator.zip 文件。

• path=”/home/stored/estimator”，则会在 /home/stored/ 中创建 estimator.zip 文件。

存储在 /home/stored/ 中。

serialization_format: str，默认值 = “pickle”

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

返回:

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

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

set_config(**config_dict)

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

参数:

config_dictdict

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

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

jupyter kernel 如何显示对象实例

• “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”：布尔值，默认=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对自身的引用。

备注

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

set_params(**params)

设置此对象的参数。

此方法适用于简单的 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')

为对象设置 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 值以实现多次函数调用之间的可重现输出。

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)

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

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

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

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

set_tags 方法只能在对象的 __init__ 方法中（构造期间）或通过 __init__ 直接构造后调用。

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

参数:

**tag_dictdict

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

返回:

Self

对自身的引用。

transform(X, y=None)

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

所需状态

需要状态为“已拟合”。

访问对象自身

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

• 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 标签

	转换
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)

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

所需状态

需要状态为“已拟合”。

访问对象自身

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

• self.is_fitted，必须为 True

写入 self

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

• 如果 remember_data 标签为 True，则写入 self._X，通过 update_data 用 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估计器的已拟合实例