UnobservedComponents#

class UnobservedComponents(level=False, trend=False, seasonal=None, freq_seasonal=None, cycle=False, autoregressive=None, irregular=False, stochastic_level=False, stochastic_trend=False, stochastic_seasonal=True, stochastic_freq_seasonal=None, stochastic_cycle=False, damped_cycle=False, cycle_period_bounds=None, mle_regression=True, use_exact_diffuse=False, start_params=None, transformed=True, includes_fixed=False, cov_type=None, cov_kwds=None, method='lbfgs', maxiter=50, full_output=1, disp=0, callback=None, return_params=False, optim_score=None, optim_complex_step=None, optim_hessian=None, flags=None, low_memory=False, random_state=None)[source]#

statsmodels 中的 UnobservedComponents 预测模型。

直接接口到 statsmodels.tsa.statespace.structural 中的 UnobservedComponents。

输入参数和文档字符串取自原始实现。

参数：
level{bool, str}，可选

是否包含水平分量。默认为 False。也可以是水平/趋势分量的字符串规范。

trendbool，可选

是否包含趋势分量。默认为 False。如果为 True，level 也必须为 True。

seasonal{int, None}，可选

季节分量的周期，如果有。默认为 None。

freq_seasonal{list[dict], None}，可选。

是否（以及如何）使用三角函数建模季节分量。如果指定，每个频域季节分量对应一个字典。每个字典必须包含键值对 ‘period’ – 整数，并且可能包含键值对 ‘harmonics’ – 整数。如果任一字典中未指定 ‘harmonics’，则默认为周期/2 的向下取整。

cyclebool，可选

是否包含周期分量。默认为 False。

autoregressive{int, None}，可选

自回归分量的阶数。默认为 None。

irregularbool，可选

是否包含不规则分量。默认为 False。

stochastic_levelbool，可选

任何水平分量是否是随机的。默认为 False。

stochastic_trendbool，可选

任何趋势分量是否是随机的。默认为 False。

stochastic_seasonalbool，可选

任何季节分量是否是随机的。默认为 True。

stochastic_freq_seasonallist[bool]，可选

每个季节分量是否是随机的。每个分量默认为 True。该列表应与 freq_seasonal 的长度相同。

stochastic_cyclebool，可选

任何周期分量是否是随机的。默认为 False。

damped_cyclebool，可选

周期分量是否是阻尼的。默认为 False。

cycle_period_boundstuple，可选

一个包含周期允许的下限和上限的元组。如果未提供，则使用以下默认边界：(1) 如果未提供日期/时间信息，频率限制在零到 \(\pi\) 之间，因此周期限制在 [0.5, 无穷大] 范围内。(2) 如果提供了日期/时间信息，默认边界允许周期分量在 1.5 到 12 年之间；根据内生变量的频率，这将意味着不同的具体边界。

mle_regressionbool，可选

是否将回归系数作为超参数之一通过最大似然估计。默认为 True。如果为 False，则回归系数通过递归 OLS 估计，包含在状态向量中。

use_exact_diffusebool，可选

是否对非平稳状态使用精确扩散初始化。默认为 False（在这种情况下使用近似扩散初始化）。

start_paramsarray_like，可选

对数似然最大化解的初始猜测。

transformedbool，可选

`start_params` 是否已转换。默认为 True。

includes_fixedbool，可选

如果参数先前已通过 fix_params 方法固定，此参数描述 start_params 是否除了自由参数外还包含固定参数。默认为 False。

cov_typestr，可选

`cov_type` 关键字控制计算参数估计协方差矩阵的方法。可以是以下之一： - ‘opg’ 表示梯度外积估计器 - ‘oim’ 表示观测信息矩阵估计器，通过以下方法计算

使用 Harvey (1989) 的方法

  • ‘approx’ 表示观测信息矩阵估计器，

    使用 Hessian 矩阵的数值近似计算。

  • ‘robust’ 表示近似（准最大似然）协方差

    矩阵，即使存在一些错误指定也可能有效。中间计算使用 ‘oim’ 方法。

  • ‘robust_approx’ 与 ‘robust’ 相同，但中间计算使用 ‘approx’ 方法。

    中间计算使用 ‘approx’ 方法。

  • ‘none’ 表示不计算协方差矩阵。

默认为 ‘opg’，除非使用内存节约技术以避免计算每个观测值的对数似然值，在这种情况下默认为 ‘approx’。

cov_kwdsdict 或 None，可选

影响协方差矩阵计算的参数字典。opg, oim, approx, robust, robust_approx - ‘approx_complex_step’ : bool，可选 - 如果为 True，数值

近似使用复步法计算。如果为 False，数值近似使用有限差分法计算。默认为 True。

  • ‘approx_centered’bool，可选 - 如果为 True，使用有限差分法计算的数值

    近似使用中心差分。默认为 False。

methodstr，可选

`method` 确定使用 `scipy.optimize` 中的哪个求解器，可以从以下字符串中选择： - ‘newton’ 表示 Newton-Raphson - ‘nm’ 表示 Nelder-Mead - ‘bfgs’ 表示 Broyden-Fletcher-Goldfarb-Shanno (BFGS) - ‘lbfgs’ 表示带可选盒约束的有限内存 BFGS - ‘powell’ 表示修正的 Powell 方法 - ‘cg’ 表示共轭梯度 - ‘ncg’ 表示 Newton 共轭梯度 - ‘basinhopping’ 表示全局 basin-hopping 求解器 `fit` 中的明确参数传递给求解器，但 basin-hopping 求解器除外。每个求解器都有几个可选参数，不同求解器之间不相同。有关可用参数以及 basin-hopping 求解器支持的明确参数列表，请参见下面的注意事项部分（或 scipy.optimize）。

maxiterint，可选

要执行的最大迭代次数。

full_outputbool，可选

设置为 True 以在 Results 对象的 mle_retvals 属性中包含所有可用输出。输出取决于求解器。有关更多信息，请参见 LikelihoodModelResults 注意事项部分。

dispbool，可选

设置为 True 以打印收敛信息。默认为 0。

callbackcallable callback(xk)，可选

在每次迭代后调用，形式为 callback(xk)，其中 xk 是当前参数向量。

return_paramsbool，可选

是否仅返回最大化参数的数组。默认为 False。

optim_score{‘harvey’, ‘approx’} 或 None，可选

计算得分向量的方法。‘harvey’ 使用 Harvey (1989) 的方法，‘approx’ 根据 optim_complex_step 的值使用有限差分或复步微分，None 使用优化器内置的梯度近似。默认为 None。此关键字仅在优化方法使用得分时相关。

optim_complex_stepbool，可选

近似得分时是否使用复步微分；如果为 False，则使用有限差分近似。默认为 True。此关键字仅在 optim_score 设置为 ‘harvey’ 或 ‘approx’ 时相关。

optim_hessian{‘opg’,’oim’,’approx’}，可选

Hessian 数值近似的方法。‘opg’ 使用梯度外积，‘oim’ 使用 Harvey (1989) 的信息矩阵公式，‘approx’ 使用数值近似。此关键字仅在优化方法使用 Hessian 矩阵时相关。

low_memorybool，可选

如果设置为 True，将应用技术显著降低内存使用。如果使用此选项，结果对象的某些功能将不可用（包括平滑结果和样本内预测），但样本外预测是可能的。默认为 False。

random_stateint, RandomState 实例或 None，可选 ，

默认为 None - 如果是 int，random_state 是随机数生成器使用的种子；如果是 RandomState 实例，random_state 是随机数生成器；如果是 None，随机数生成器是 np.random 使用的 RandomState 实例。

属性：
cutoff

截断点 = 预测器的“当前时间”状态。

fh

传递的预测范围。

is_fitted

`fit` 是否已被调用。

另请参阅

statsmodels.tsa.statespace.structural.UnobservedComponents
statsmodels.tsa.statespace.structural.UnobservedComponentsResults

参考文献

[1]

Seabold, Skipper, and Josef Perktold. “statsmodels: Econometric and statistical modeling with python.” Proceedings of the 9th Python in Science Conference. 2010.

[2]

Durbin, James, and Siem Jan Koopman. 2012. Time Series Analysis by State Space Methods: Second Edition. Oxford University Press.

示例

>>> from sktime.datasets import load_airline
>>> from sktime.forecasting.structural import UnobservedComponents
>>> y = load_airline()
>>> forecaster = UnobservedComponents(level='local linear trend')  
>>> forecaster.fit(y)  
UnobservedComponents(...)
>>> y_pred = forecaster.predict(fh=[1, 2, 3])

方法

check_is_fitted([方法名称])

检查估计器是否已拟合。

clone()

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

clone_tags(估计器[, 标签名称])

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

create_test_instance([参数集])

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

create_test_instances_and_names([参数集])

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

fit(y[, X, fh])

使用训练数据拟合预测器。

fit_predict(y[, X, fh, X_pred])

拟合并预测未来范围的时间序列。

get_class_tag(标签名称[, 默认标签值])

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

get_class_tags()

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

get_config()

获取 self 的配置标志。

get_fitted_params([deep])

获取已拟合参数。

get_param_defaults()

获取对象的默认参数。

get_param_names([sort])

获取对象的参数名称。

get_params([deep])

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

get_tag(标签名称[, 默认标签值, ...])

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

get_tags()

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

get_test_params([参数集])

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

is_composite()

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

load_from_path(serial)

从文件位置加载对象。

load_from_serial(serial)

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

plot_diagnostics([变量, 滞后项, 图, ...])

标准化残差的诊断图。

predict([fh, X])

预测未来范围的时间序列。

predict_interval([fh, X, coverage])

计算/返回预测区间预测。

predict_proba([fh, X, marginal])

计算/返回完全概率预测。

predict_quantiles([fh, X, alpha])

计算/返回分位数预测。

predict_residuals([y, X])

返回时间序列预测的残差。

predict_var([fh, X, cov])

计算/返回方差预测。

reset()

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

save([路径, 序列化格式])

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

score(y[, X, fh])

使用 MAPE（非对称）对照真实值对预测进行评分。

set_config(**配置字典)

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

set_params(**参数)

设置此对象的参数。

set_random_state([随机状态, deep, ...])

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

set_tags(**标签字典)

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

simulate(nsimulations[, X, ...])

模拟遵循状态空间模型的新时间序列。

summary()

获取拟合预测器的摘要。

update(y[, X, update_params])

更新截断值，可选更新拟合参数。

update_predict(y[, cv, X, update_params, ...])

在测试集上迭代进行预测并更新模型。

update_predict_single([y, fh, X, update_params])

使用新数据更新模型并进行预测。
summary()[source]#

获取拟合预测器的摘要。

这与 statsmodels 中的实现相同

https://statsmodels.cn/dev/examples/notebooks/generated/statespace_structural_harvey_jaeger.html

simulate(nsimulations, X=None, measurement_shocks=None, state_shocks=None, initial_state=None, anchor=None, repetitions=None, **kwargs)[source]#

模拟遵循状态空间模型的新时间序列。

取自原始 statsmodels 实现。

参数：
nsimulationsint

模拟的观测数量。如果模型是时不变的，这可以是任意数字。如果模型是时变的，则此数字必须小于或等于观测数量。

Xpd.DataFrame，可选 (default=None)

外生变量。

measurement_shocksarray_like，可选

如果指定，这些是测量方程的冲击，\(\varepsilon_t\)。如果未指定，则使用伪随机数生成器自动生成。如果指定，形状必须为 nsimulations x k_endog，其中 k_endog 与状态空间模型中相同。

state_shocksarray_like，可选

如果指定，这些是状态方程的冲击，\(\eta_t\)。如果未指定，则使用伪随机数生成器自动生成。如果指定，形状必须为 nsimulations x k_posdef，其中 k_posdef 与状态空间模型中相同。

initial_statearray_like，可选

如果指定，这是用于模拟的初始状态向量，其形状应为 (k_states x 1)，其中 k_states 与状态空间模型中相同。如果未指定，但模型已初始化，则使用该初始化。如果 anchor 不是“start”或 0，则必须指定此项（否则，您可以在结果对象而不是模型对象上使用 simulate 方法）。

anchorint, str, 或 datetime，可选

模拟的第一个周期。模拟将以 anchor 之前所有现有数据点为条件。类型取决于模型中给定 endog 的索引。两个特殊情况是字符串 ‘start’ 和 ‘end’。start 指从样本的第一个周期开始模拟，而 end 指从样本后的第一个周期开始模拟。整数值可以从 0 到 nobs，也可以是负数以应用负索引。最后，如果为模型提供了日期/时间索引，则此参数可以是要解析的日期字符串或 datetime 类型。默认为 ‘start’。

repetitionsint，可选

要生成的模拟路径数量。默认为 1 条模拟路径。

返回：
simulated_obsndarray

模拟观测的数组。如果 repetitions=None，则形状为 (nsimulations x k_endog) 或 (nsimulations,)（如果 k_endog=1）。否则形状为 (nsimulations x k_endog x repetitions)。如果模型使用 Pandas 输入，则输出将是 Pandas 对象。如果 k_endog > 1 且 repetitions 不是 None，则输出将是 Pandas DataFrame，其列具有 MultiIndex，第一级包含 endog 变量的名称，第二级包含重复次数。

另请参阅

statsmodels.tsa.statespace.mlemodel.MLEResults
plot_diagnostics(variable=0, lags=10, fig=None, figsize=None, truncate_endog_names=24)[source]#

标准化残差的诊断图。

取自原始 statsmodels 实现。

参数：
variableint，可选

应创建诊断图的内生变量的索引。默认为 0。

lagsint，可选

互相关图中包含的滞后项数量。默认为 10。

figFigure，可选

如果给定，在此图中而不是在新图中创建子图。注意，将使用 fig.add_subplot() 在提供的图中创建 2x2 网格。

figsizetuple，可选

如果创建图，此参数允许指定大小。元组格式为（宽度，高度）。

返回：
图

包含诊断图的 Figure 实例。

另请参阅

statsmodels.tsa.statespace.mlemodel.MLEResults
classmethod get_test_params(parameter_set='default')[source]#

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

参数：
parameter_setstr，默认为“default”

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

返回：
paramsdict 或 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。

相当于构造一个 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)[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 或 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” 集。

返回：
objs: cls 实例列表

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

names: str 列表，与 objs 长度相同

第 i 个元素是测试中第 i 个 obj 实例的名称。命名约定为 {cls.__name__}-{i}（如果实例多于一个），否则为 {cls.__name__}。

property cutoff[source]#

截断点 = 预测器的“当前时间”状态。

返回：
cutoffpandas 兼容的索引元素，或 None

pandas 兼容的索引元素，如果已设置 cutoff；否则为 None

property fh[source]#

传递的预测范围。

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

使用训练数据拟合预测器。

状态变更

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

写入 self

  • 设置以“_”结尾的拟合模型属性，拟合属性可通过 get_fitted_params 检查。

  • 将 self.is_fitted 标志设置为 True。

  • 将 self.cutoff 设置为 y 中看到的最后一个索引。

  • 如果传递了 fh，则将 fh 存储到 self.fh。

参数：
y：`sktime` 兼容数据容器格式的时间序列。

用于拟合预测器的时间序列。

`sktime` 中的个体数据格式是所谓的 mtype 规范，每种 mtype 实现一个抽象的 scitype。

  • `Series` scitype = 个体时间序列，普通预测。pd.DataFrame、pd.Series 或 np.ndarray（1D 或 2D）

  • `Panel` scitype = 时间序列集合，全局/面板预测。具有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，Series 类型的 pd.DataFrame list

  • `Hierarchical` scitype = 分层集合，用于分层预测。具有 3 级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time) 的 pd.DataFrame

有关数据格式的更多详细信息，请参见 mtype 词汇表。有关用法，请参见预测教程 examples/01_forecasting.ipynb

fhint, list, pd.Index 可强制转换类型，或 ForecastingHorizon，默认为 None

编码要预测的时间戳的预测范围。如果 self.get_tag("requires-fh-in-fit") 为 True，则必须在 fit 中传递，非可选。

X：`sktime` 兼容格式的时间序列，可选 (default=None)。

用于拟合模型的外生时间序列。应与 y 具有相同的 scitype (Series、Panel 或 Hierarchical)。如果 self.get_tag("X-y-must-have-same-index")，X.index 必须包含 y.index。

返回：
self：对 self 的引用。
fit_predict(y, X=None, fh=None, X_pred=None)[source]#

拟合并预测未来范围的时间序列。

与 fit(y, X, fh).predict(X_pred) 相同。如果未传递 X_pred，则与 fit(y, fh, X).predict(X) 相同。

状态变更

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

写入 self

  • 设置以“_”结尾的拟合模型属性，拟合属性可通过 get_fitted_params 检查。

  • 将 self.is_fitted 标志设置为 True。

  • 将 self.cutoff 设置为 y 中看到的最后一个索引。

  • 将 fh 存储到 self.fh。

参数：
y：sktime 兼容数据容器格式的时间序列

用于拟合预测器的时间序列。

`sktime` 中的个体数据格式是所谓的 mtype 规范，每种 mtype 实现一个抽象的 scitype。

  • `Series` scitype = 个体时间序列，普通预测。pd.DataFrame、pd.Series 或 np.ndarray（1D 或 2D）

  • `Panel` scitype = 时间序列集合，全局/面板预测。具有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，Series 类型的 pd.DataFrame list

  • `Hierarchical` scitype = 分层集合，用于分层预测。具有 3 级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time) 的 pd.DataFrame

有关数据格式的更多详细信息，请参见 mtype 词汇表。有关用法，请参见预测教程 examples/01_forecasting.ipynb

fhint, list, pd.Index 可强制转换类型，或 ForecastingHorizon（非可选）

编码要预测的时间戳的预测范围。

如果 fh 不是 None 且不是 ForecastingHorizon 类型，则通过调用 _check_fh 将其强制转换为 ForecastingHorizon。特别是，如果 fh 是 pd.Index 类型，则通过 ForecastingHorizon(fh, is_relative=False) 将其强制转换。

X：`sktime` 兼容格式的时间序列，可选 (default=None)。

用于拟合模型的外生时间序列。应与 y 具有相同的 scitype (Series、Panel 或 Hierarchical)。如果 self.get_tag("X-y-must-have-same-index")，X.index 必须包含 y.index。

X_pred：sktime 兼容格式的时间序列，可选 (default=None)

用于预测的外生时间序列。如果传递，将用于预测而不是 X。应与 fit 中的 y 具有相同的 scitype (`Series`、`Panel` 或 `Hierarchical`)。如果 self.get_tag("X-y-must-have-same-index")，X.index 必须包含 fh 索引引用。

返回：
y_pred：sktime 兼容数据容器格式的时间序列

在 fh 处的点预测，索引与 fh 相同。y_pred 与最近传递的 y 类型相同：Series、Panel、Hierarchical scitype，格式相同（见上文）

classmethod get_class_tag(tag_name, tag_value_default=None)[source]#

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

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

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

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

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

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

按继承顺序。

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

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

参数：
tag_namestr

标签值的名称。

tag_value_defaultany type

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

返回：
tag_value

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

classmethod get_class_tags()[source]#

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

每个 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()[source]#

获取 self 的配置标志。

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

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

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

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

返回：
config_dictdict

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

get_fitted_params(deep=True)[source]#

获取已拟合参数。

所需状态

要求状态为“已拟合”。

参数：
deepbool, default=True

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

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

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

返回：
fitted_paramsdict with str-valued keys

拟合参数字典，参数名 : 参数值 键值对包括

  • 始终：此对象的所有拟合参数，如通过 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，将返回此对象的参数名称 : 值字典，包括组件参数（= BaseObject 类型参数）。

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

返回：
paramsdict with str-valued keys

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

  • 始终：此对象的所有参数，如通过 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_defaultany type, optional; default=None

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

raise_errorbool

未找到标签时是否引发 ValueError 错误

返回：
tag_valueAny

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

引发：
如果 raise_error 为 True，则引发 ValueError。

如果 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 对象属性的任何覆盖和新标签。

is_composite()[source]#

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

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

返回：
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]#

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

参数：
serial`cls.save(None)` 输出的第一个元素
返回：
反序列化的 self，结果输出 serial，即 cls.save(None) 的输出
predict(fh=None, X=None)[source]#

预测未来范围的时间序列。

所需状态

要求状态为“已拟合”，即 self.is_fitted=True。

访问 self 中的

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

  • self.cutoff、self.is_fitted

写入 self

如果传递了 fh 且之前未传递过，则将 fh 存储到 self.fh。

参数：
fhint, list, pd.Index 可强制转换类型，或 ForecastingHorizon，默认为 None

编码预测时间戳的预测范围。如果已在 fit 中传递过，则不应再次传递。如果未在 fit 中传递过，则必须传递，不是可选的。

如果 fh 不是 None 且不是 ForecastingHorizon 类型，则通过调用 _check_fh 将其强制转换为 ForecastingHorizon。特别是，如果 fh 是 pd.Index 类型，则通过 ForecastingHorizon(fh, is_relative=False) 将其强制转换。

Xsktime 兼容格式的时间序列，可选（默认=None）

用于预测的外生时间序列。应与 fit 中的 y 具有相同的科学类型（Series、Panel 或 Hierarchical）。如果 self.get_tag("X-y-must-have-same-index") 为 True，则 X.index 必须包含 fh 索引参考。

返回：
y_pred：sktime 兼容数据容器格式的时间序列

在 fh 处的点预测，索引与 fh 相同。y_pred 与最近传递的 y 类型相同：Series、Panel、Hierarchical scitype，格式相同（见上文）

predict_interval(fh=None, X=None, coverage=0.9)[source]#

计算/返回预测区间预测。

如果 coverage 是可迭代的，将计算多个区间。

所需状态

要求状态为“已拟合”，即 self.is_fitted=True。

访问 self 中的

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

  • self.cutoff、self.is_fitted

写入 self

如果传递了 fh 且之前未传递过，则将 fh 存储到 self.fh。

参数：
fhint, list, pd.Index 可强制转换类型，或 ForecastingHorizon，默认为 None

编码预测时间戳的预测范围。如果已在 fit 中传递过，则不应再次传递。如果未在 fit 中传递过，则必须传递，不是可选的。

如果 fh 不为 None 且不是 ForecastingHorizon 类型，它将在内部被强制转换为 ForecastingHorizon（通过 _check_fh）。

  • 如果 fh 是 int 或类似于 int 的数组，则将其解释为相对预测范围，并强制转换为相对的 ForecastingHorizon(fh, is_relative=True)。

  • 如果 fh 是 pd.Index 类型，则将其解释为绝对预测范围，并强制转换为绝对的 ForecastingHorizon(fh, is_relative=False)。

Xsktime 兼容格式的时间序列，可选（默认=None）

用于预测的外生时间序列。应与 fit 中的 y 具有相同的科学类型（Series、Panel 或 Hierarchical）。如果 self.get_tag("X-y-must-have-same-index") 为 True，则 X.index 必须包含 fh 索引参考。

coveragefloat 或 唯一 float 值列表，可选（默认=0.90）

预测区间(s)的名义覆盖率

返回：
pred_intpd.DataFrame
列具有多重索引：第一层是 fit 中 y 的变量名，
第二层是计算区间的覆盖率分数值。

与输入 coverage 中的顺序相同。

第三层是字符串“lower”或“upper”，表示区间的下限/上限。

行索引是 fh，附加（上层）级别等于实例级别，

来自在 fit 中看到的 y，如果在 fit 中看到的 y 是 Panel 或 Hierarchical 类型。

条目是区间下限/上限的预测值，

对于列索引中的变量，在第二列索引中的名义覆盖率下，根据第三列索引确定下限/上限，对应于行索引。区间上限/下限预测等同于在覆盖率 c 对应的 alpha = 0.5 - c/2, 0.5 + c/2 处的分位数预测。

predict_proba(fh=None, X=None, marginal=True)[source]#

计算/返回完全概率预测。

注

  • 目前仅针对 Series（非面板、非层级）y 实现。

  • 返回的分布对象需要安装 skpro。

所需状态

要求状态为“已拟合”，即 self.is_fitted=True。

访问 self 中的

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

  • self.cutoff、self.is_fitted

写入 self

如果传递了 fh 且之前未传递过，则将 fh 存储到 self.fh。

参数：
fhint, list, pd.Index 可强制转换类型，或 ForecastingHorizon，默认为 None

编码预测时间戳的预测范围。如果已在 fit 中传递过，则不应再次传递。如果未在 fit 中传递过，则必须传递，不是可选的。

如果 fh 不为 None 且不是 ForecastingHorizon 类型，它将在内部被强制转换为 ForecastingHorizon（通过 _check_fh）。

  • 如果 fh 是 int 或类似于 int 的数组，则将其解释为相对预测范围，并强制转换为相对的 ForecastingHorizon(fh, is_relative=True)。

  • 如果 fh 是 pd.Index 类型，则将其解释为绝对预测范围，并强制转换为绝对的 ForecastingHorizon(fh, is_relative=False)。

Xsktime 兼容格式的时间序列，可选（默认=None）

用于预测的外生时间序列。应与 fit 中的 y 具有相同的科学类型（Series、Panel 或 Hierarchical）。如果 self.get_tag("X-y-must-have-same-index") 为 True，则 X.index 必须包含 fh 索引参考。

marginalbool, 可选（默认=True）

返回的分布是否按时间索引是边际分布

返回：
pred_distskpro BaseDistribution

如果 marginal=True，则是预测分布，将是按时间点的边际分布；如果 marginal=False 且方法已实现，将是联合分布

predict_quantiles(fh=None, X=None, alpha=None)[source]#

计算/返回分位数预测。

如果 alpha 是可迭代的，将计算多个分位数。

所需状态

要求状态为“已拟合”，即 self.is_fitted=True。

访问 self 中的

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

  • self.cutoff、self.is_fitted

写入 self

如果传递了 fh 且之前未传递过，则将 fh 存储到 self.fh。

参数：
fhint, list, pd.Index 可强制转换类型，或 ForecastingHorizon，默认为 None

编码预测时间戳的预测范围。如果已在 fit 中传递过，则不应再次传递。如果未在 fit 中传递过，则必须传递，不是可选的。

如果 fh 不为 None 且不是 ForecastingHorizon 类型，它将在内部被强制转换为 ForecastingHorizon（通过 _check_fh）。

  • 如果 fh 是 int 或类似于 int 的数组，则将其解释为相对预测范围，并强制转换为相对的 ForecastingHorizon(fh, is_relative=True)。

  • 如果 fh 是 pd.Index 类型，则将其解释为绝对预测范围，并强制转换为绝对的 ForecastingHorizon(fh, is_relative=False)。

Xsktime 兼容格式的时间序列，可选（默认=None）

用于预测的外生时间序列。应与 fit 中的 y 具有相同的科学类型（Series、Panel 或 Hierarchical）。如果 self.get_tag("X-y-must-have-same-index") 为 True，则 X.index 必须包含 fh 索引参考。

alphafloat 或 唯一 float 值列表，可选（默认=[0.05, 0.95]）

计算分位数预测的概率或概率列表。

返回：
quantilespd.DataFrame
列具有多重索引：第一层是 fit 中 y 的变量名，

第二层是传递给函数的 alpha 值。

行索引是 fh，附加（上层）级别等于实例级别，

来自在 fit 中看到的 y，如果在 fit 中看到的 y 是 Panel 或 Hierarchical 类型。

条目是分位数预测，针对列索引中的变量，

在第二列索引中的分位数概率处，对应于行索引。

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

返回时间序列预测的残差。

残差将在 y.index 的预测处计算。

如果 fh 必须在 fit 中传递，则必须与 y.index 一致。如果 y 是一个 np.ndarray，且 fit 中没有传递 fh，则残差将在 fh = range(len(y.shape[0])) 处计算。

所需状态

要求状态为“已拟合”。如果已设置 fh，则必须与 y 的索引（pandas 或整数）对应。

访问 self 中的

以 “_” 结尾的拟合模型属性。self.cutoff, self._is_fitted

写入 self

无。

参数：
y：sktime 兼容数据容器格式的时间序列

包含真实观测值的时间序列，用于计算残差。必须与 predict 的预期返回值具有相同的类型、维度和索引。

如果为 None，则使用迄今为止看到的 y (self._y)，特别是

  • 如果之前仅调用过一次 fit，则产生样本内残差

  • 如果 fit 需要 fh，则它必须指向 fit 中 y 的索引

Xsktime 兼容格式的时间序列，可选（默认=None）

用于更新和预测的外生时间序列。应与 fit 中的 y 具有相同的 科学类型（Series、Panel 或 Hierarchical）。如果 self.get_tag("X-y-must-have-same-index") 为 True，则 X.index 必须同时包含 fh 索引参考和 y.index。

返回：
y_ressktime 兼容数据容器格式的时间序列

在 fh`, with same index as ``fh 处的预测残差，与 `fh` 具有相同的索引。`y_res` 的类型与最近传递的 `y` 类型相同：Series、Panel、Hierarchical 科学类型，格式相同（见上文）。

predict_var(fh=None, X=None, cov=False)[source]#

计算/返回方差预测。

所需状态

要求状态为“已拟合”，即 self.is_fitted=True。

访问 self 中的

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

  • self.cutoff、self.is_fitted

写入 self

如果传递了 fh 且之前未传递过，则将 fh 存储到 self.fh。

参数：
fhint, list, pd.Index 可强制转换类型，或 ForecastingHorizon，默认为 None

编码预测时间戳的预测范围。如果已在 fit 中传递过，则不应再次传递。如果未在 fit 中传递过，则必须传递，不是可选的。

如果 fh 不为 None 且不是 ForecastingHorizon 类型，它将在内部被强制转换为 ForecastingHorizon（通过 _check_fh）。

  • 如果 fh 是 int 或类似于 int 的数组，则将其解释为相对预测范围，并强制转换为相对的 ForecastingHorizon(fh, is_relative=True)。

  • 如果 fh 是 pd.Index 类型，则将其解释为绝对预测范围，并强制转换为绝对的 ForecastingHorizon(fh, is_relative=False)。

Xsktime 兼容格式的时间序列，可选（默认=None）

用于预测的外生时间序列。应与 fit 中的 y 具有相同的科学类型（Series、Panel 或 Hierarchical）。如果 self.get_tag("X-y-must-have-same-index") 为 True，则 X.index 必须包含 fh 索引参考。

covbool, 可选（默认=False）

如果为 True，计算协方差矩阵预测。如果为 False，计算边际方差预测。

返回：
pred_varpd.DataFrame，格式取决于 cov 变量
如果 cov=False
列名与在 fit/update 中传递的 y 的列名完全相同。

对于无名格式，列索引将是 RangeIndex。

行索引是 fh，附加级别等于实例级别，

来自在 fit 中看到的 y，如果在 fit 中看到的 y 是 Panel 或 Hierarchical 类型。

条目是方差预测，针对列索引中的变量。给定变量和 fh 索引的方差预测是一个预测值

在给定观测数据的情况下，该变量和索引的方差。

如果 cov=True
列索引是多重索引：第一层是变量名（如上所述）

第二层是 fh。

行索引是 fh，附加级别等于实例级别，

来自在 fit 中看到的 y，如果在 fit 中看到的 y 是 Panel 或 Hierarchical 类型。

条目是（协）方差预测，针对列索引中的变量，以及

行和列中时间索引之间的协方差。

注意：不返回不同变量之间的协方差预测。

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

将序列化的 self 保存到字节类对象或 (.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 文件。

  • path=”/home/stored/estimator”，则将在

存储在 /home/stored/ 中。

serialization_format: str, 默认 = “pickle”

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

返回：
如果 path 为 None - 内存中的序列化 self
如果 path 是文件位置 - 指向文件的 ZipFile
score(y, X=None, fh=None)[source]#

使用 MAPE（非对称）对照真实值对预测进行评分。

参数：
ypd.Series, pd.DataFrame, 或 np.ndarray (1D 或 2D)

用于评分的时间序列

fhint, list, pd.Index 可强制转换类型，或 ForecastingHorizon，默认为 None

编码要预测的时间戳的预测范围。

Xpd.DataFrame, 或 2D np.array, 可选（默认=None）

用于评分的外生时间序列；如果 self.get_tag(“X-y-must-have-same-index”) 为 True，则 X.index 必须包含 y.index

返回：
scorefloat

self.predict(fh, X) 相对于 y_test 的 MAPE 损失。

另请参阅

sktime.performance_metrics.forecasting.mean_absolute_percentage_error
set_config(**config_dict)[source]#

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

参数：
config_dictdict

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

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

jupyter 内核如何显示 self 的实例

  • “diagram” = html 框图表示

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

print_changed_onlybool, 默认=True

打印 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”: bool, 默认=True; False 阻止 ray 在并行化后关闭。

      shutting down after parallelization.

    • “logger_name”: str, 默认=”ray”; 要使用的日志记录器名称。

    • “mute_warnings”: bool, 默认=False; 如果为 True，则抑制警告

remember_databool, 默认=True

self._X 和 self._y 是否在 fit 中存储并在 update 中更新。如果为 True，则存储并更新 self._X 和 self._y。如果为 False，则不存储和更新 self._X 和 self._y。这在使用 save 时会减小序列化大小，但 update 将默认为“什么也不做”，而不是“重新拟合所有已见数据”。

返回：
selfself 的引用。

注意

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

set_params(**params)[source]#

设置此对象的参数。

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

参数：
paramsdict

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

返回：
selfself 的引用（设置参数后）
set_random_state(random_state=None, deep=True, self_policy='copy')[source]#

为 self 设置 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, default=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 派生，通常与输入不同

返回：
selfself 的引用
set_tags(**tag_dict)[source]#

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

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

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

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

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

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

参数：
tag_dictdict

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

返回：
Self

self 的引用。

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

更新截断值，可选更新拟合参数。

如果未实现特定于估计器的 update 方法，默认回退如下

  • update_params=True: 对迄今为止所有观测数据进行拟合

  • update_params=False: 仅更新截止点并记住数据

所需状态

要求状态为“已拟合”，即 self.is_fitted=True。

访问 self 中的

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

  • self.cutoff、self.is_fitted

写入 self

  • 将 self.cutoff 更新为在 y 中看到的最新索引。

  • 如果 update_params=True，更新以 “_” 结尾的拟合模型属性。

参数：
y：`sktime` 兼容数据容器格式的时间序列。

用于更新预测器的时间序列。

`sktime` 中的个体数据格式是所谓的 mtype 规范，每种 mtype 实现一个抽象的 scitype。

  • `Series` scitype = 个体时间序列，普通预测。pd.DataFrame、pd.Series 或 np.ndarray（1D 或 2D）

  • `Panel` scitype = 时间序列集合，全局/面板预测。具有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，Series 类型的 pd.DataFrame list

  • `Hierarchical` scitype = 分层集合，用于分层预测。具有 3 级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time) 的 pd.DataFrame

有关数据格式的更多详细信息，请参见 mtype 词汇表。有关用法，请参见预测教程 examples/01_forecasting.ipynb

X：`sktime` 兼容格式的时间序列，可选 (default=None)。

用于更新模型拟合的外生时间序列。应与 y 具有相同的 科学类型（Series、Panel 或 Hierarchical）。如果 self.get_tag("X-y-must-have-same-index") 为 True，则 X.index 必须包含 y.index。

update_paramsbool, 可选（默认=True）

是否应更新模型参数。如果为 False，则仅更新截止点，模型参数（例如系数）不更新。

返回：
selfself 的引用
update_predict(y, cv=None, X=None, update_params=True, reset_forecaster=True)[source]#

在测试集上迭代进行预测并更新模型。

用于执行多个 update / predict 链式调用的简写，数据回放基于时间序列分割器 cv。

与以下代码相同（如果只有 y、cv 非默认）

  1. self.update(y=cv.split_series(y)[0][0])

  2. 记住 self.predict() （稍后在单个批次中返回）

  3. self.update(y=cv.split_series(y)[1][0])

  4. 记住 self.predict() （稍后在单个批次中返回）

  5. 等等

  6. 返回所有记住的预测

如果未实现特定于估计器的 update 方法，默认回退如下

  • update_params=True: 对迄今为止所有观测数据进行拟合

  • update_params=False: 仅更新截止点并记住数据

所需状态

要求状态为“已拟合”，即 self.is_fitted=True。

访问 self 中的

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

  • self.cutoff、self.is_fitted

写入 self（除非 reset_forecaster=True）

  • 将 self.cutoff 更新为在 y 中看到的最新索引。

  • 如果 update_params=True，更新以 “_” 结尾的拟合模型属性。

如果 reset_forecaster=True，则不更新状态。

参数：
y：`sktime` 兼容数据容器格式的时间序列。

用于更新预测器的时间序列。

`sktime` 中的个体数据格式是所谓的 mtype 规范，每种 mtype 实现一个抽象的 scitype。

  • `Series` scitype = 个体时间序列，普通预测。pd.DataFrame、pd.Series 或 np.ndarray（1D 或 2D）

  • `Panel` scitype = 时间序列集合，全局/面板预测。具有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，Series 类型的 pd.DataFrame list

  • `Hierarchical` scitype = 分层集合，用于分层预测。具有 3 级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time) 的 pd.DataFrame

有关数据格式的更多详细信息，请参见 mtype 词汇表。有关用法，请参见预测教程 examples/01_forecasting.ipynb

cv继承自 BaseSplitter 的时间序列交叉验证生成器，可选

例如，SlidingWindowSplitter 或 ExpandingWindowSplitter；默认 = initial_window=1 的 ExpandingWindowSplitter，并且默认 = y/X 中的单个数据点被逐个添加和预测，initial_window = 1，step_length = 1 且 fh = 1

Xsktime 兼容格式的时间序列，可选（默认=None）

用于更新和预测的外生时间序列。应与 fit 中的 y 具有相同的科学类型（Series、Panel 或 Hierarchical）。如果 self.get_tag("X-y-must-have-same-index") 为 True，则 X.index 必须包含 fh 索引参考。

update_paramsbool, 可选（默认=True）

是否应更新模型参数。如果为 False，则仅更新截止点，模型参数（例如系数）不更新。

reset_forecasterbool, 可选（默认=True）

  • 如果为 True，则不会改变预测器的状态，即 update/predict 序列使用副本运行，self 的截止点、模型参数、数据内存不会改变

  • 如果为 False，则当 update/predict 序列运行时，将更新 self，如同直接调用 update/predict 一样

返回：
y_pred汇总来自多个分割批次的点预测的对象

格式取决于预测总体的 (截止点, 绝对预测范围) 对

  • 如果绝对预测范围点的集合是唯一的：类型为 sktime 兼容数据容器格式的时间序列，输出中隐藏截止点，类型与最近传递的 y 相同：Series、Panel、Hierarchical 科学类型，格式相同（见上文）

  • 如果绝对预测范围点的集合不唯一：类型为 pandas DataFrame，行和列索引为时间戳，行索引对应于从中进行预测的截止点，列索引对应于预测的绝对预测范围，条目是根据行索引预测的列索引的点预测值，如果在该 (截止点, 预测范围) 对没有进行预测，则条目为 nan

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

使用新数据更新模型并进行预测。

此方法有助于一步完成更新和预测。

如果未实现特定于估计器的 update 方法，默认回退是先 update，然后 predict。

所需状态

要求状态为“已拟合”。

访问 self 中的

以 “_” 结尾的拟合模型属性。指向已见数据的指针，self._y 和 self.X，self.cutoff，self._is_fitted。如果 update_params=True，则还有以 “_” 结尾的模型属性。

写入 self

通过附加行来使用 y 和 X 更新 self._y 和 self._X。将 self.cutoff 和 self._cutoff 更新为在 y 中看到的最后一个索引。如果 update_params=True，

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

参数：
y：`sktime` 兼容数据容器格式的时间序列。

用于更新预测器的时间序列。

`sktime` 中的个体数据格式是所谓的 mtype 规范，每种 mtype 实现一个抽象的 scitype。

  • `Series` scitype = 个体时间序列，普通预测。pd.DataFrame、pd.Series 或 np.ndarray（1D 或 2D）

  • `Panel` scitype = 时间序列集合，全局/面板预测。具有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，Series 类型的 pd.DataFrame list

  • `Hierarchical` scitype = 分层集合，用于分层预测。具有 3 级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time) 的 pd.DataFrame

有关数据格式的更多详细信息，请参见 mtype 词汇表。有关用法，请参见预测教程 examples/01_forecasting.ipynb

fhint, list, pd.Index 可强制转换类型，或 ForecastingHorizon，默认为 None

编码预测时间戳的预测范围。如果已在 fit 中传递过，则不应再次传递。如果未在 fit 中传递过，则必须传递，不是可选的。

Xsktime 兼容格式的时间序列，可选（默认=None）

用于更新和预测的外生时间序列。应与 fit 中的 y 具有相同的科学类型（Series、Panel 或 Hierarchical）。如果 self.get_tag("X-y-must-have-same-index") 为 True，则 X.index 必须包含 fh 索引参考。

update_paramsbool, 可选（默认=True）

是否应更新模型参数。如果为 False，则仅更新截止点，模型参数（例如系数）不更新。

返回：
y_pred：sktime 兼容数据容器格式的时间序列

在 fh 处的点预测，索引与 fh 相同。y_pred 与最近传递的 y 类型相同：Series、Panel、Hierarchical scitype，格式相同（见上文）