STLBootstrapTransformer#

class STLBootstrapTransformer(n_series: int = 10, sp: int = 12, block_length: int | None = None, sampling_replacement: bool = False, return_actual: bool = True, lambda_bounds: tuple | None = None, lambda_method: str = 'guerrero', seasonal: int = 7, trend: int | None = None, low_pass: int | None = 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 = None, outer_iter: int | None = None, random_state: int | RandomState | None = None)[源代码][源代码]#

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

此方法利用一种自举法来生成与输入时间序列相似的时间序列群体 [1][2]

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

返回的面板将是一个多索引数据框(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_bounds元组,可选

BoxCox 参数:用于限制 lambda 值求解时可行范围的下限和上限,默认为 None。

lambda_methodstr, 可选

BoxCox 参数: {“pearsonr”, “mle”, “all”, “guerrero”},默认值为 “guerrero”。用于确定 Box-Cox 变换中使用的 lambda 值的优化方法。

季节性int, 可选

STL 参数:季节平滑器的长度。必须是奇数,通常应 >= 7,默认值为 7。

趋势int, 可选

STL 参数:趋势平滑器的长度,默认为 None。必须是奇数。如果未提供,则使用大于 1.5 * 周期 / (1 - 1.5 / 季节性) 的最小奇数,遵循原始实现的建议。

低通int, 可选

STL 参数:低通滤波器的长度,默认为 None。必须是 >=3 的奇数。如果未提供,则使用大于周期的最小奇数。

seasonal_degint, 可选

STL 参数: 季节性 LOESS 的度数。0(常数)或 1(常数和趋势),默认值为 1。

trend_degint, 可选

STL 参数:趋势 LOESS 的度数。0(常数)或 1(常数和趋势),默认值为 1。

low_pass_degint, 可选

STL 参数:低通 LOESS 的阶数。0(常数)或 1(常数和趋势),默认值为 1。

稳健bool, 可选

STL 参数:标志,指示是否使用加权版本,该版本对某些形式的异常值具有鲁棒性,默认为 False。

季节性跳跃int, 可选

STL 参数:确定线性插值步长的正整数,默认为1。如果大于1,则每隔 seasonal_jump 点使用LOESS,并在拟合点之间进行线性插值。较高的值减少估计时间。

趋势跳跃int, 可选

STL 参数:确定线性插值步长的正整数,默认为 1。如果大于 1,则每 trend_jump 点使用 LOESS,两点之间的值进行线性插值。较高的值减少估计时间。

低通跳变int, 可选

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). 使用STL分解和Box-Cox变换的Bagging指数平滑方法。国际预测杂志, 32(2), 303-312

[2]

Hyndman, R.J., & Athanasopoulos, G. (2021) 预测:原理与实践,第三版,OTexts: 墨尔本,澳大利亚。OTexts.com/fpp3,第12.5章。访问于2022年2月13日。

[3]

Kunsch HR (1989) 对于一般平稳观测的刀切法和自助法。统计年鉴 17(3), 1217-1241

示例

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

检查估计器是否已被拟合。

clone()

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

clone_tags(estimator[, tag_names])

从另一个估计器克隆标签作为动态覆盖。

create_test_instance([parameter_set])

如果可能,构造 Estimator 实例。

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

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

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

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

set_tags(**tag_dict)

将动态标签设置为给定值。

transform(X[, y])

转换 X 并返回一个转换后的版本。

update(X[, y, update_params])

使用 X 更新转换器,可选地使用 y。

classmethod get_test_params(parameter_set='default')[源代码][源代码]#

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

参数:
参数集str, 默认值=”default”

要返回的测试参数集的名称,用于测试。如果没有为某个值定义特殊参数,将返回 "default" 集。

返回:
参数dict 或 dict 列表,默认 = {}

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

check_is_fitted()[源代码]#

检查估计器是否已被拟合。

引发:
NotFittedError

如果估计器尚未拟合。

clone()[源代码]#

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

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

引发:
如果克隆不符合规范,由于 __init__ 存在错误,将引发 RuntimeError。

注释

如果成功,值等于 type(self)(**self.get_params(deep=False))

clone_tags(estimator, tag_names=None)[源代码]#

从另一个估计器克隆标签作为动态覆盖。

参数:
估计器继承自 BaseEstimator 的估计器
标签名称str 或 str 列表,默认 = None

要克隆的标签名称。如果为 None,则使用估计器中的所有标签作为 tag_names

返回:
自我

自我引用。

注释

通过在 tag_set 中设置来自估计器的标签值,将对象状态更改为 self 中的动态标签。

classmethod create_test_instance(parameter_set='default')[源代码]#

如果可能,构造 Estimator 实例。

参数:
参数集str, 默认值=”default”

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

返回:
实例使用默认参数的类实例

注释

get_test_params 可以返回字典或字典列表。此函数获取 get_test_params 返回的第一个或单个字典,并使用该字典构建对象。

classmethod create_test_instances_and_names(parameter_set='default')[源代码]#

创建所有测试实例的列表及其名称列表。

参数:
参数集str, 默认值=”default”

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

返回:
objscls 实例列表

第 i 个实例是 cls(**cls.get_test_params()[i])

名称list of str, 与 objs 长度相同

第 i 个元素是 obj 在测试中的第 i 个实例的名称,约定为 {cls.__name__}-{i} 如果存在多个实例,否则为 {cls.__name__}

fit(X, y=None)[源代码]#

将变换器拟合到 X,可选地拟合到 y。

状态变化:

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

写给自己:

  • 设置以“_”结尾的拟合模型属性,拟合属性可以通过 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 类型 = 单个时间序列。pd.DataFramepd.Series``np.ndarray``(1D 或 2D)

  • Panel 类型 = 时间序列集合。pd.DataFrame 具有 2 级行 MultiIndex (实例, 时间)3D np.ndarray (实例, 变量, 时间)list 类型的 Series pd.DataFrame

  • Hierarchical 类型 = 时间序列的分层集合。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 的转换版本。

状态变化:

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

写入自身:_is_fitted : 标志设置为 True。_X : X,如果 remember_data 标签为 True,则为 X 的强制复制。

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

模型属性(以“_”结尾):依赖于估计器

参数:
X : sktime 兼容数据容器格式的时间序列时间序列在

要拟合变换的数据,以及要变换的数据。

sktime 中的单个数据格式被称为 mtype 规范,每个 mtype 实现了一个抽象的 scitype

  • Series 类型 = 单个时间序列。pd.DataFramepd.Series``np.ndarray``(1D 或 2D)

  • Panel 类型 = 时间序列集合。pd.DataFrame 具有 2 级行 MultiIndex (实例, 时间)3D np.ndarray (实例, 变量, 时间)list 类型的 Series pd.DataFrame

  • Hierarchical 类型 = 时间序列的分层集合。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-row) | | Panel | Primitives | pd.DataFrame | | Series | Series | Series | | Panel | Series | Panel | | Series | Panel | Panel |

返回的实例对应于 X 中的实例
表格中未列出的组合目前不支持
明确地,带有示例:
如果 XSeries`(例如,`pd.DataFrame),并且 transform-outputSeries

然后返回的是一个相同mtype的单个 Series 示例:去趋势化单个序列

如果 XPanel`(例如,`pd-multiindex),并且 transform-outputSeries
然后返回的是与 X 具有相同实例数量的 Panel

(转换器应用于每个输入的 Series 实例)

示例:面板中的所有序列都单独去趋势化

如果 XSeriesPanel 并且 transform-outputPrimitives

然后返回的是 pd.DataFrame ,其行数与 X 中的实例数相同。示例:返回的第 i 行包含第 i 个序列的均值和方差。

如果 XSeries 并且 transform-outputPanel

然后返回的是一个类型为 pd-multiindexPanel 对象。示例:输出的第 i 个实例是第 i 个窗口在 X 上运行。

classmethod get_class_tag(tag_name, tag_value_default=None)[源代码]#

获取类标签的值。

不返回在实例上定义的动态标签(通过 set_tags 或 clone_tags 设置)的信息。

参数:
标签名称str

标签值的名称。

tag_value_default任何

如果未找到标签,则使用默认/回退值。

返回:
标签值

self 中 tag_name 标签的值。如果未找到,则返回 tag_value_default

classmethod get_class_tags()[源代码]#

从类及其所有父类中获取类标签。

从 _tags 类属性中检索标签:值对。不返回在实例上通过 set_tags 或 clone_tags 设置的动态标签信息。

返回:
collected_tagsdict

类标签名称字典:标签值对。通过嵌套继承从 _tags 类属性中收集。

get_config()[源代码]#

获取 self 的配置标志

返回:
config_dictdict

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

get_fitted_params(deep=True)[源代码]#

获取拟合参数。

状态要求:

需要状态为“已拟合”。

参数:
深度bool, 默认=True

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

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

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

返回:
fitted_params带有字符串键的字典

拟合参数的字典,paramname : paramvalue 键值对包括:

  • always: 此对象的所有拟合参数,通过 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)[源代码]#

获取对象的参数名称。

参数:
排序bool, 默认=True

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

返回:
param_names: list[str]

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

get_params(deep=True)[源代码]#

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

参数:
深度bool, 默认=True

是否返回组件的参数。

  • 如果为真,将返回此对象的参数名称 : 值的字典,包括组件的参数(= BaseObject 值的参数)。

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

返回:
参数带有字符串键的字典

参数的字典,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)[源代码]#

从估计器类获取标签值和动态标签覆盖。

参数:
标签名称str

要检索的标签名称

tag_value_default任何类型,可选;默认=None

如果未找到标签,则使用默认/回退值

raise_error布尔值

当标签未找到时是否引发 ValueError

返回:
标签值任何

在 self 中 tag_name 标签的值。如果未找到,当 raise_error 为 True 时返回错误,否则返回 tag_value_default

引发:
如果 raise_error 为 True,即如果 tag_name 不在其中,则引发 ValueError。
self.get_tags().keys()
get_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

参数:
X : sktime 兼容数据容器格式的时间序列时间序列在

要拟合转换的数据。

sktime 中的单个数据格式被称为 mtype 规范,每个 mtype 实现了一个抽象的 scitype

  • Series 类型 = 单个时间序列。pd.DataFramepd.Series``np.ndarray``(1D 或 2D)

  • Panel 类型 = 时间序列集合。pd.DataFrame 具有 2 级行 MultiIndex (实例, 时间)3D np.ndarray (实例, 变量, 时间)list 类型的 Series pd.DataFrame

  • Hierarchical 类型 = 时间序列的分层集合。pd.DataFrame 具有3个或更多级别的行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)

关于数据格式的更多细节,请参见关于 mtype 的术语表。关于使用方法,请参见转换器教程 examples/03_transformers.ipynb

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

附加数据,例如,转换的标签。某些转换器需要这些数据,详情请参见类文档字符串。

返回:
X 的逆变换版本

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

is_composite()[源代码]#

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

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

返回:
composite: bool

一个对象是否具有任何值为 BaseObjects 的参数。

property is_fitted[源代码]#

是否已调用 fit

classmethod load_from_path(serial)[源代码]#

从文件位置加载对象。

参数:
串行ZipFile(path).open(“object”) 的结果
返回:
反序列化自身,结果输出到 path,通过 cls.save(path)
classmethod load_from_serial(serial)[源代码]#

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

参数:
serial : cls.save(None) 输出的第一个元素输出结果的第一个元素
返回:
反序列化自身,结果输出为 serial,来自 cls.save(None)
reset()[源代码]#

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

使用 reset,使用超参数的当前值(get_params 的结果)运行 __init__。这将移除任何对象属性,除了:

  • 超参数 = __init__ 的参数

  • 包含双下划线的对象属性,即字符串”__”

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

返回:
自身

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

注释

等同于 sklearn.clone 但覆盖了 self。在调用 self.reset() 之后,self 的值等于 type(self)(**self.get_params(deep=False))

save(path=None, serialization_format='pickle')[源代码]#

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

行为:如果 path 是 None,返回一个内存中的序列化自身;如果 path 是一个文件位置,将自身存储在该位置作为一个 zip 文件。

保存的文件是包含以下内容的zip文件:_metadata - 包含自身的类,即 type(self) _obj - 序列化的自身。此类使用默认的序列化(pickle)。

参数:
路径无或文件位置(字符串或路径)

如果为 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 - 内存中的序列化自身
如果 path 是文件位置 - 带有文件引用的 ZipFile
set_config(**config_dict)[源代码]#

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

参数:
config_dictdict

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

显示str, “diagram” (默认), 或 “text”

jupyter 内核如何显示实例

  • “diagram” = html 盒子图表示

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

print_changed_onlybool, 默认=True

是否仅打印与默认值不同的自身参数(False),或打印所有参数名称和值(False)。不嵌套,即仅影响自身,而不影响组件估计器。

警告str, “on” (默认), 或 “off”

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

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

  • “off” = 不会从 sktime 引发警告

后端:并行str, 可选, 默认=”None”

在广播/矢量化时用于并行化的后端,为以下之一

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

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

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

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

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

输入转换str, 可以是 “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)[源代码]#

设置此对象的参数。

该方法适用于简单估计器以及复合对象。参数键字符串 <component>__<parameter> 可用于复合对象,即包含其他对象的对象,以访问组件 <component> 中的 <parameter>。如果这使得引用明确,例如没有两个组件的参数名称相同,则也可以使用不带 <component>__ 的字符串 <parameter>

参数:
**参数dict

BaseObject 参数,键必须是 <component>__<parameter> 字符串。如果 get_params 键中唯一,__ 后缀可以别名完整字符串。

返回:
self引用自身(在参数设置之后)
set_random_state(random_state=None, deep=True, self_policy='copy')[源代码]#

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

通过 estimator.get_params 查找名为 random_state 的参数,并通过 set_params 将其设置为由 random_state 派生的整数。这些整数通过 sample_dependent_seed 的链式哈希采样获得,并保证种子随机生成器的伪随机独立性。

根据 self_policy 应用于 estimator 中的 random_state 参数,并且仅当 deep=True 时应用于剩余的组件估计器。

注意:即使 self 没有 random_state,或者没有任何组件具有 random_state 参数,也会调用 set_params。因此,set_random_state 将重置任何 scikit-base 估计器,即使它们没有 random_state 参数。

参数:
random_stateint, RandomState 实例或 None, 默认=None

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

深度bool, 默认=True

是否在子估计器中设置随机状态。如果为 False,则仅设置 selfrandom_state 参数(如果存在)。如果为 True,则还会在子估计器中设置 random_state 参数。

self_policystr, 可选值为 {“copy”, “keep”, “new”}, 默认值为 “copy”
  • “复制” : estimator.random_state 被设置为输入 random_state

  • “保持” : estimator.random_state 保持不变

  • “new” : estimator.random_state 被设置为一个新随机状态,

源自输入 random_state,并且通常与它不同

返回:
self自我引用
set_tags(**tag_dict)[源代码]#

将动态标签设置为给定值。

参数:
**标签字典dict

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

返回:
自我

自我引用。

注释

通过在 tag_dict 中设置标签值来改变对象状态,作为 self 中的动态标签。

transform(X, y=None)[源代码]#

转换 X 并返回一个转换后的版本。

状态要求:

需要状态为“已拟合”。

在自身中的访问:

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

  • self.is_fitted,必须为 True

参数:
X : sktime 兼容数据容器格式的时间序列时间序列在

要转换的数据。

sktime 中的单个数据格式被称为 mtype 规范,每个 mtype 实现了一个抽象的 scitype

  • Series 类型 = 单个时间序列。pd.DataFramepd.Series``np.ndarray``(1D 或 2D)

  • Panel 类型 = 时间序列集合。pd.DataFrame 具有 2 级行 MultiIndex (实例, 时间)3D np.ndarray (实例, 变量, 时间)list 类型的 Series pd.DataFrame

  • Hierarchical 类型 = 时间序列的分层集合。pd.DataFrame 具有3个或更多级别的行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)

关于数据格式的更多细节,请参见关于 mtype 的术语表。关于使用方法,请参见转换器教程 examples/03_transformers.ipynb

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

附加数据,例如,转换的标签。某些转换器需要这些数据,详情请参见类文档字符串。

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

transform

X

-output

返回类型

Series

基本元素

pd.DataFrame (1行)

Panel

基本元素

pd.DataFrame

Series

Series

Series

Panel

Series

Panel

Series

Panel

Panel

返回的实例对应于 X 中的实例
表格中未列出的组合目前不支持
明确地,带有示例:
如果 XSeries`(例如,`pd.DataFrame),并且 transform-outputSeries

然后返回的是一个相同mtype的单个 Series 示例:去趋势化单个序列

如果 XPanel`(例如,`pd-multiindex),并且 transform-outputSeries
然后返回的是与 X 具有相同实例数量的 Panel

(转换器应用于每个输入的 Series 实例)

示例:面板中的所有序列都单独去趋势化

如果 XSeriesPanel 并且 transform-outputPrimitives

然后返回的是 pd.DataFrame ,其行数与 X 中的实例数相同。示例:返回的第 i 行包含第 i 个序列的均值和方差。

如果 XSeries 并且 transform-outputPanel

然后返回的是一个类型为 pd-multiindexPanel 对象。示例:输出的第 i 个实例是第 i 个窗口在 X 上运行。

update(X, y=None, update_params=True)[源代码]#

使用 X 更新转换器,可选地使用 y。

状态要求:

需要状态为“已拟合”。

在自身中的访问:

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

  • self.is_fitted,必须为 True

写给自己:

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

  • 如果 remember_data 标签为 True,则通过 update_dataX 中的值写入 self._X

参数:
X : sktime 兼容数据容器格式的时间序列时间序列在

数据更新转换

sktime 中的单个数据格式被称为 mtype 规范,每个 mtype 实现了一个抽象的 scitype

  • Series 类型 = 单个时间序列。pd.DataFramepd.Series``np.ndarray``(1D 或 2D)

  • Panel 类型 = 时间序列集合。pd.DataFrame 具有 2 级行 MultiIndex (实例, 时间)3D np.ndarray (实例, 变量, 时间)list 类型的 Series pd.DataFrame

  • Hierarchical 类型 = 时间序列的分层集合。pd.DataFrame 具有3个或更多级别的行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)

关于数据格式的更多细节,请参见关于 mtype 的术语表。关于使用方法,请参见转换器教程 examples/03_transformers.ipynb

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

附加数据,例如,转换的标签。某些转换器需要这些数据,详情请参见类文档字符串。

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