STLBootstrapTransformer#

class STLBootstrapTransformer(n_series: int = 10, sp: int = 12, block_length: int = None, sampling_replacement: bool = False, return_actual: bool = True, lambda_bounds: tuple = None, lambda_method: str = 'guerrero', seasonal: int = 7, trend: int = None, low_pass: int = None, seasonal_deg: int = 1, trend_deg: int = 1, low_pass_deg: int = 1, robust: bool = False, seasonal_jump: int = 1, trend_jump: int = 1, low_pass_jump: int = 1, inner_iter: int = None, outer_iter: int = None, random_state: int | RandomState = None)[source]#

创建一组相似的时间序列。

此方法利用引导程序（bootstrapping）的一种形式来生成一组与输入时间序列相似的时间序列 [1], [2]。

首先，对观察到的时间序列使用 Box-Cox 变换进行转换，以稳定方差。然后，使用 statsmodels (statsmodels.tsa.api.STL) 中的 STL 实现将其分解为季节性、趋势和残差时间序列 [4]。接着，我们使用移动块引导程序 (MBB) 方法 [3] 从残差时间序列中采样块，创建模仿观察到的时间序列自相关模式的合成残差序列。最后，将这些引导程序生成的残差添加到季节性和趋势分量中，并使用 Box-Cox 逆变换返回一个相似时间序列的面板。输出可用于 bagging 预测、预测区间和数据增强。

返回的面板将是一个多索引数据框 (pd.DataFrame)，其中 series_id 和 time_index 作为索引，时间序列值作为单列。series_id 的值为原始序列的“actual”和生成序列的“synthetic_n”（其中 n 是一个整数）。有关示例输出，请参阅示例章节。

参数:

n_seriesint, 可选: 将生成的引导程序时间序列的数量，默认为 10。
spint, 可选: 数据的季节周期性，整数形式，默认为 12。必须是大于等于 2 的整数。
block_lengthint, 可选: MBB 方法中的块长度，默认为 None。如果未提供，则使用以下启发式方法：块长度将是 2*sp 和 len(X) - sp 中的最小值。
sampling_replacementbool, 可选: MBB 采样是否带回放，默认为 False。
return_actualbool, 可选: 如果为 True，输出将包含实际时间序列，默认为 True。实际时间序列将被标记为“<series_name>_actual”（如果系列名称为 None，则标记为“actual”）。
lambda_boundsTuple, 可选: BoxCox 参数：用于限制求解 lambda 值时的可行范围的下限和上限，默认为 None。
lambda_methodstr, 可选: BoxCox 参数：{“pearsonr”, “mle”, “all”, “guerrero”}，默认为“guerrero”。用于确定 Box-Cox 变换中使用的 lambda 值的优化方法。
seasonalint, 可选: STL 参数：季节平滑器的长度。必须是奇数，通常应大于等于 7，默认为 7。
trendint, 可选: STL 参数：趋势平滑器的长度，默认为 None。必须是奇数。如果未提供，则按照原始实现的建议，使用大于 1.5 * period / (1 - 1.5 / seasonal) 的最小奇数。
low_passint, 可选: STL 参数：低通滤波器的长度，默认为 None。必须是大于等于 3 的奇数。如果未提供，则使用大于 period 的最小奇数。
seasonal_degint, 可选: STL 参数：季节 LOESS 的度数。0 (常数) 或 1 (常数和趋势)，默认为 1。
trend_degint, 可选: STL 参数：趋势 LOESS 的度数。0 (常数) 或 1 (常数和趋势)，默认为 1。
low_pass_degint, 可选: STL 参数：低通 LOESS 的度数。0 (常数) 或 1 (常数和趋势)，默认为 1。
robustbool, 可选: STL 参数：标志指示是否使用对某些形式的异常值具有鲁棒性的加权版本，默认为 False。
seasonal_jumpint, 可选: STL 参数：正整数，确定线性插值的步长，默认为 1。如果大于 1，则每隔 seasonal_jump 点使用 LOESS，并在拟合点之间进行线性插值。值越大，估计时间越短。
trend_jumpint, 可选: STL 参数：正整数，确定线性插值的步长，默认为 1。如果大于 1，则每隔 trend_jump 点使用 LOESS，并在两点之间的值进行线性插值。值越大，估计时间越短。
low_pass_jumpint, 可选: STL 参数：正整数，确定线性插值的步长，默认为 1。如果大于 1，则每隔 low_pass_jump 点使用 LOESS，并在两点之间的值进行线性插值。值越大，估计时间越短。
inner_iterint, 可选: STL 参数：在内循环中执行的迭代次数，默认为 None。如果未提供，则在 robust 为 True 时使用 2，否则使用 5。此参数传递给 statsmodels 中的 STL.fit()。
outer_iterint, 可选: STL 参数：在外循环中执行的迭代次数，默认为 None。如果未提供，则在 robust 为 True 时使用 15，否则使用 0。此参数传递给 statsmodels 中的 STL.fit()。
random_stateint, np.random.RandomState 或 None, 默认为 None: 控制评估器的随机性

属性:

is_fitted: 是否已调用 fit 方法。

另请参阅

sktime.transformations.bootstrap.MovingBlockBootstrapTransformer: 应用移动块引导程序方法创建合成时间序列面板的转换器。

参考文献

[1]

Bergmeir, C., Hyndman, R. J., & Benítez, J. M. (2016). Bagging exponential smoothing methods using STL decomposition and Box-Cox transformation. International Journal of Forecasting, 32(2), 303-312

[2]

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

[3]

Kunsch HR (1989) The jackknife and the bootstrap for general stationary observations. Annals of Statistics 17(3), 1217-1241

[4]

https://statsmodels.cn/dev/generated/statsmodels.tsa.seasonal.STL.html

示例

>>> from sktime.transformations.bootstrap import STLBootstrapTransformer
>>> from sktime.datasets import load_airline
>>> from sktime.utils.plotting import plot_series  
>>> y = load_airline()  
>>> transformer = STLBootstrapTransformer(10)  
>>> y_hat = transformer.fit_transform(y)  
>>> series_list = []  
>>> names = []  
>>> for group, series in y_hat.groupby(level=0, as_index=False):
...     series.index = series.index.droplevel(0)
...     series_list.append(series)
...     names.append(group)  
>>> plot_series(*series_list, labels=names)  
(...)
>>> print(y_hat.head())  
                      Number of airline passengers
series_id time_index
actual    1949-01                            112.0
          1949-02                            118.0
          1949-03                            132.0
          1949-04                            129.0
          1949-05                            121.0

方法

`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')[source]#

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

参数:

parameter_setstr, 默认为“default”: 要返回的测试参数集的名称，用于测试。如果某个值没有定义特殊参数，则将返回 "default" 集。

返回:

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

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 或 list of 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 个元素是测试中第 i 个对象实例的名称。如果实例多于一个，则命名约定为 {cls.__name__}-{i}，否则为 {cls.__name__}

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

用 X 拟合转换器，可选地用 y 拟合。

状态变化: 将状态更改为“已拟合” (fitted)。

写入自身

设置以“_”结尾的已拟合模型属性，已拟合属性可通过 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)[source]#

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

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

状态变化: 将状态更改为“已拟合” (fitted)。

写入自身：_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，则返回的是行数与 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 的标签值，考虑标签覆盖，按以下降序优先级排列

在类的 _tags 属性中设置的标签。
在父类的 _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 的任何属性的键。

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

在类的 _tags 属性中设置的标签。
在父类的 _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]#

获取已拟合参数。

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

参数:

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()[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，但不包括组件的参数。

返回:

paramskeys 为 str 类型的 dict

参数字典，参数名 : 参数值键值对包含

始终包含：此对象的所有参数，通过 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 的单个标签的值，同时考虑标签覆盖，优先级降序如下：

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

在实例构建时设置的标签。

在类的 _tags 属性中设置的标签。
在父类的 _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 设置的标签。

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

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

在实例构建时设置的标签。

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

按继承顺序排列。

返回:

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

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

对 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()[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，得到在 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”，则将在当前工作目录创建一个名为 estimator.zip 的 zip 文件。
path=”/home/stored/estimator”，则将在

/home/stored/ 中存储一个名为 estimator.zip 的 zip 文件。

serialization_format: str, 默认 = “pickle”

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

返回:

如果 path 为 None - 内存中的序列化 self
如果 path 为文件位置 - 引用文件的 ZipFile

set_config(**config_dict)[source]#

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

参数:

config_dictdict

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

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

jupyter 内核如何显示 self 的实例

“diagram” = html 框图表示
“text” = 字符串打印输出

print_changed_onlybool, 默认=True

打印 self 时是仅列出与默认值不同的 self 参数 (True)，还是列出所有参数名称和值 (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”: bool, 默认=True；False 防止 ray 在并行化后
  关闭。
- “logger_name”: str, 默认=”ray”；要使用的 logger 名称。
- “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对 self 的引用。

Notes

更改对象状态，将 config_dict 中的配置复制到 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, 默认=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对 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 并返回转换后的版本。

所需状态: 需要状态为“已拟合” (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-row)
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 更新。

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

在 self 中访问

以 "_" 结尾的已拟合模型属性。

self.is_fitted，必须为 True

写入自身

以 "_" 结尾的已拟合模型属性。

如果 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 (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评估器的已拟合实例