AutoETS#

AutoETS(error='add', trend=None, damped_trend=False, seasonal=None, sp=1, initialization_method='estimated', initial_level=None, initial_trend=None, initial_seasonal=None, bounds=None, dates=None, freq=None, missing='none', start_params=None, maxiter=1000, full_output=True, disp=False, callback=None, return_params=False, auto=False, information_criterion='aic', allow_multiplicative_trend=False, restrict=True, additive_only=False, ignore_inf_ic=True, n_jobs=None, random_state=None)[source]#

具有手动和自动拟合能力的 ETS 模型。

手动(固定参数)使用(auto=False,默认)是 statsmodels ETSModel [2] 的直接接口,而自动调优(auto=True)是基于 statsmodels ETSModel 对 R 版本 ets [3] 的改编。

第一个参数是 statsmodels 参数(从 errorreturn_params)[2] 的直接接口。

其余参数是 R ets 参数(autoadditive_only)[3] 的改编,用于自动模型选择。

参数:
errorstr,默认值=”add”

误差模型。取值范围为“add”或“mul”。如果 auto=True,则忽略。

trendstr 或 None,默认值=None

趋势分量模型。取值范围为“add”、“mul”或 None。如果 auto=True,则忽略。

damped_trendbool,默认值=False

包含的趋势分量是否阻尼。如果 auto=True,则忽略。

seasonalstr 或 None,默认值=None

季节性模型。取值范围为“add”、“mul”或 None。如果 auto=True,则忽略。

spint,默认值=1

季节性(Holt-Winters)模型中完整季节周期的周期数。例如,年周期季度数据为 4,或周周期每日数据为 7。如果 seasonal 不为 None,则必需。

initialization_methodstr,默认值=’estimated’

状态空间模型的初始化方法。以下之一:

  • ‘estimated’(默认)

  • ‘heuristic’

  • ‘known’

如果使用‘known’初始化,则必须传入 initial_level,如果适用,还需要传入 initial_trendinitial_seasonal。‘heuristic’ 使用基于数据的启发式方法来估计初始水平、趋势和季节状态。‘estimated’ 使用与初始猜测相同的启发式方法,但随后作为拟合过程的一部分估计初始状态。默认值为‘estimated’。

initial_levelfloat 或 None,默认值=None

初始水平分量。仅在初始化方法为‘known’时使用。

initial_trendfloat 或 None,默认值=None

初始趋势分量。仅在初始化方法为‘known’时使用。

initial_seasonalarray_like 或 None,默认值=None

初始季节性分量。一个长度为 seasonal_periods 的数组。仅在初始化方法为‘known’时使用。

boundsdict 或 None,默认值=None

一个字典,键为参数名,值为相应的边界区间(列表/元组/数组)。可用的参数名取决于模型和初始化方法:

  • “smoothing_level”

  • “smoothing_trend”

  • “smoothing_seasonal”

  • “damping_trend”

  • “initial_level”

  • “initial_trend”

  • “initial_seasonal.0”, …, “initial_seasonal.<m-1>”

默认选项为 None,在这种情况下使用 [1] 中描述的传统(非线性)边界。

start_paramsarray_like 或 None,默认值=None

将被优化的参数的初始值。如果为 None,则使用默认值。其长度取决于所选模型。应按以下顺序包含参数,跳过在所选模型中不存在的参数。

  • smoothing_level (alpha)

  • smoothing_trend (beta)

  • smoothing_seasonal (gamma)

  • damping_trend (phi)

如果将 initialization_method 设置为 'estimated'(默认值),则此外,参数

  • initial_level (\(l_{-1}\))

  • initial_trend (\(l_{-1}\))

  • initial_seasonal.0 (\(s_{-1}\))

  • initial_seasonal.<m-1> (\(s_{-m}\))

也必须指定。

maxiterint,默认值=1000

要执行的最大迭代次数。

full_outputbool,默认值=True

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

dispbool,默认值=False

设置为 True 以打印收敛消息。

callback可调用 callback(xk) 或 None,默认值=None

每次迭代后调用,作为 callback(xk),其中 xk 是当前参数向量。

return_paramsbool,默认值=False

是否仅返回最大化参数的数组。

autobool,默认值=False

设置为 True 以启用自动模型选择。如果 auto=True,则忽略 error、trend、seasonal 和 damped_trend。

information_criterionstr,默认值=”aic”

用于模型选择的信息准则。以下之一:

  • “aic”

  • “bic”

  • “aicc”

allow_multiplicative_trendbool,默认值=False

如果为 True,则在搜索模型时允许包含乘法趋势的模型。否则,模型空间将排除它们。

restrictbool,默认值=True

如果为 True,则不允许包含无限方差的模型。

additive_onlybool,默认值=False

如果为 True,则仅考虑加法模型。

ignore_inf_ic: bool,默认值=True

如果为 True,则忽略具有负无穷大信息准则(aic, bic, aicc)的模型。

n_jobsint 或 None,默认值=None

并行运行自动模型拟合的作业数。None 表示 1,除非在 joblib.parallel_backend 上下文中。-1 表示使用所有处理器。

random_stateint,RandomState 实例或 None,可选,

默认值=None - 如果是 int,则 random_state 是随机数生成器使用的种子;如果是 RandomState 实例,则 random_state 是随机数生成器;如果是 None,则随机数生成器是 np.random 使用的 RandomState 实例。

属性:
cutoff

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

fh

传入的预测范围。

is_fitted

fit 是否已被调用。

另请参见

StatsForecastAutoETS

参考资料

[1]

Hyndman, R.J., & Athanasopoulos, G. (2019) Forecasting: principles and practice, 3rd edition, OTexts: Melbourne, Australia. OTexts.com/fpp3. Accessed on April 19th 2020.

示例

>>> from sktime.datasets import load_airline
>>> from sktime.forecasting.ets import AutoETS
>>> y = load_airline()
>>> forecaster = AutoETS(auto=True, n_jobs=-1, sp=12)  
>>> forecaster.fit(y)  
AutoETS(...)
>>> y_pred = forecaster.predict(fh=[1,2,3])  

方法

check_is_fitted([method_name])

检查估计器是否已拟合。

clone()

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

clone_tags(estimator[, tag_names])

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

create_test_instance([parameter_set])

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

create_test_instances_and_names([parameter_set])

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

fit(y[, X, fh])

将预测器拟合到训练数据。

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

在未来范围内拟合和预测时间序列。

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

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

is_composite()

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

load_from_path(serial)

从文件位置加载对象。

load_from_serial(serial)

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

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([path, serialization_format])

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

score(y[, X, fh])

使用 MAPE(非对称)评估预测相对于真实值的得分。

set_config(**config_dict)

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

set_params(**params)

设置此对象的参数。

set_random_state([random_state, deep, ...])

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

set_tags(**tag_dict)

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

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.pythonlang.cn/dev/examples/notebooks/generated/ets.html

类方法 get_test_params(parameter_set='default')[source]#

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

参数:
parameter_setstr,默认值=”default”

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

返回:
paramsdict 或 dict 列表
check_is_fitted(method_name=None)[source]#

检查估计器是否已拟合。

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

如果不是,则引发 NotFittedError

参数:
method_namestr,可选

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

引发:
NotFittedError

如果估计器尚未拟合。

clone()[source]#

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

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

等同于构造 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_tagsget_tag 进行检查。

参数:
estimator:class:BaseObject 或派生类的实例
tag_namesstr 或 str 列表,默认值 = None

要克隆的标签名称。默认值(None)克隆 estimator 中的所有标签。

返回:
self

self 的引用。

类方法 create_test_instance(parameter_set='default')[source]#

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

参数:
parameter_setstr,默认值=”default”

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

返回:
instance具有默认参数的类实例
类方法 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 个 obj 实例的名称。如果实例多于一个,命名约定为 {cls.__name__}-{i},否则为 {cls.__name__}

属性 cutoff[source]#

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

返回:
cutoffpandas 兼容的索引元素,或 None

如果已设置截止点,则为 pandas 兼容的索引元素;否则为 None

属性 fh[source]#

传入的预测范围。

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

将预测器拟合到训练数据。

状态改变

将状态更改为“fitted”。

写入 self

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

  • self.is_fitted 标志设置为 True

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

  • 如果传入了 fh,则将 fh 存储到 self.fh

参数:
ysktime 兼容数据容器格式的时间序列。

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

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

  • Series scitype = 个体时间序列,普通预测。pd.DataFrame, pd.Series, 或 np.ndarray (1D 或 2D)

  • Panel scitype = 时间序列集合,全局/面板预测。具有 2 级行 MultiIndex (实例, 时间)pd.DataFrame3D np.ndarray (实例, 变量, 时间)Series 类型 pd.DataFramelist

  • Hierarchical scitype = 分层集合,用于分层预测。具有 3 级或更多级行 MultiIndex (层级 1, ..., 层级 n, 时间)pd.DataFrame

有关数据格式的更多详细信息,请参阅 mtype 术语表。有关用法,请参阅预测教程 examples/01_forecasting.ipynb

fhint, list, 可强制转换为 pd.Index, 或 ForecastingHorizon, 默认值=None

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

Xsktime 兼容格式的时间序列,可选 (默认值=None)。

用于拟合模型的外生时间序列。应与 y 具有相同的 scitypeSeriesPanelHierarchical)。如果 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) 相同。

状态改变

将状态更改为“fitted”。

写入 self

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

  • self.is_fitted 标志设置为 True

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

  • fh 存储到 self.fh

参数:
ysktime 兼容数据容器格式的时间序列

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

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

  • Series scitype = 个体时间序列,普通预测。pd.DataFrame, pd.Series, 或 np.ndarray (1D 或 2D)

  • Panel scitype = 时间序列集合,全局/面板预测。具有 2 级行 MultiIndex (实例, 时间)pd.DataFrame3D np.ndarray (实例, 变量, 时间)Series 类型 pd.DataFramelist

  • Hierarchical scitype = 分层集合,用于分层预测。具有 3 级或更多级行 MultiIndex (层级 1, ..., 层级 n, 时间)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) 将其强制转换。

Xsktime 兼容格式的时间序列,可选 (默认值=None)。

用于拟合模型的外生时间序列。应与 y 具有相同的 scitypeSeriesPanelHierarchical)。如果 self.get_tag("X-y-must-have-same-index"),则 X.index 必须包含 y.index

X_predsktime 兼容格式的时间序列,可选 (默认值=None)

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

返回:
y_predsktime 兼容数据容器格式的时间序列

fh 处的点预测,与 fh 具有相同的索引。y_pred 的类型与最近传入的 y 相同:SeriesPanelHierarchical scitype,格式相同(见上文)

类方法 get_class_tag(tag_name, tag_value_default=None)[source]#

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

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

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

它返回对象中名称为 tag_name 的标签值,考虑到标签覆盖,按以下降序优先级:

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

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

按照继承顺序。

不考虑在实例上设置的动态标签覆盖,即通过 set_tagsclone_tags 在实例上定义的标签。

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

参数:
tag_namestr

标签值的名称。

tag_value_default任意类型

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

返回:
tag_value

selftag_name 标签的值。如果未找到,则返回 tag_value_default

类方法 get_class_tags()[source]#

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

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

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

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

它返回一个字典,其键是类或其任何父类中设置的 _tags 任何属性的键。

值是相应的标签值,按以下降序优先级进行覆盖:

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

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

按照继承顺序。

实例可以根据超参数覆盖这些标签。

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

不考虑在实例上设置的动态标签覆盖,即通过 set_tagsclone_tags 在实例上定义的标签。

对于包含来自动态标签的覆盖,请使用 get_tags

collected_tagsdict

标签名: 标签值 对的字典。通过嵌套继承从 _tags 类属性收集。不受 set_tagsclone_tags 设置的动态标签覆盖。

get_config()[source]#

获取自身的配置标志。

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

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

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

配置在 clonereset 调用中保留。

返回:
config_dictdict

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

get_fitted_params(deep=True)[source]#

获取拟合参数。

所需状态

要求状态为“fitted”。

参数:
deepbool,默认值=True

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

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

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

返回:
fitted_params键为 str 类型的 dict

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

  • 总是:此对象的所有拟合参数,通过 get_param_names 获取的值是此对象该键的拟合参数值

  • 如果 deep=True,还包含组件参数的键/值对,组件参数的索引格式为 [组件名]__[参数名]组件名 的所有参数以 参数名 形式出现并带有其值

  • 如果 deep=True,还包含任意级别的组件递归,例如 [组件名]__[组件组件名]__[参数名]

类方法 get_param_defaults()[source]#

获取对象的参数默认值。

返回:
default_dict: dict[str, Any]

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

类方法 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,但不包括组件的参数。

返回:
params键为 str 类型的 dict

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

  • always: 此对象的所有参数,通过 get_param_names 获取;值是该键的参数值,此对象的值与构造时传递的值总是相同的

  • 如果 deep=True,还包含组件参数的键/值对,组件参数的索引格式为 [组件名]__[参数名]组件名 的所有参数以 参数名 形式出现并带有其值

  • 如果 deep=True,还包含任意级别的组件递归,例如 [组件名]__[组件组件名]__[参数名]

get_tag(tag_name, tag_value_default=None, raise_error=True)[source]#

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

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

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

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

  1. 通过实例上的 set_tagsclone_tags 设置的标签,

在实例构建时。

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

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

按照继承顺序。

参数:
tag_namestr

要检索的标签名称

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

如果未找到标签,则使用的默认/备用值

raise_errorbool

未找到标签时是否引发 ValueError

返回:
tag_valueAny

selftag_name 标签的值。如果未找到,则在 raise_error 为 True 时引发错误,否则返回 tag_value_default

引发:
ValueError,如果 raise_errorTrue

如果 tag_name 不在 self.get_tags().keys() 中,则会引发 ValueError

get_tags()[source]#

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

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

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

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

值是相应的标签值,按以下降序优先级进行覆盖:

  1. 通过实例上的 set_tagsclone_tags 设置的标签,

在实例构建时。

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

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

按照继承顺序。

返回:
collected_tagsdict

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

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) 输出的第1个元素
返回:
反序列化的 self,结果是 serial,是 cls.save(None) 的输出
predict(fh=None, X=None)[source]#

在未来范围内预测时间序列。

所需状态

要求状态为“fitted”,即 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)

预测中使用的外生时间序列。应与 fity 的 scitype (Series, Panel, 或 Hierarchical) 相同。如果 self.get_tag("X-y-must-have-same-index"),则 X.index 必须包含 fh 索引引用。

返回:
y_predsktime 兼容数据容器格式的时间序列

fh 处的点预测,与 fh 具有相同的索引。y_pred 的类型与最近传入的 y 相同:SeriesPanelHierarchical scitype,格式相同(见上文)

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

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

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

所需状态

要求状态为“fitted”,即 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)。

  • 如果 fhintint 的类似数组类型,它将被解释为相对范围,并强制转换为相对 ForecastingHorizon(fh, is_relative=True)

  • 如果 fh 的类型是 pd.Index,它将被解释为绝对范围,并强制转换为绝对 ForecastingHorizon(fh, is_relative=False)

Xsktime 兼容格式的时间序列,可选 (默认=None)

预测中使用的外生时间序列。应与 fity 的 scitype (Series, Panel, 或 Hierarchical) 相同。如果 self.get_tag("X-y-must-have-same-index"),则 X.index 必须包含 fh 索引引用。

coverage浮点数或包含唯一值的浮点数列表,可选 (默认=0.90)

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

返回:
pred_intpd.DataFrame
列具有多重索引:第一级是 fity 的变量名,
第二级是计算区间的覆盖度分数。

顺序与输入 coverage 中的顺序相同。

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

行索引是 fh,如果 fit 中看到的 y 是 Panel 或 Hierarchical,则包含额外的(上层)级别等于实例级别。

来自 fit 中看到的 y,如果 fit 中看到的 y 是 Panel 或 Hierarchical。

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

对于列索引中的变量,在第二个列索引中的名义覆盖度,取决于第三个列索引的 lower/upper,对于该行索引。上限/下限区间预测等价于对于 coverage 中 c 的 alpha = 0.5 - c/2, 0.5 + c/2 处的分位数预测。

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

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

注意

  • 目前仅为 Series(非面板,非分层)y 实现。

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

所需状态

要求状态为“fitted”,即 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)。

  • 如果 fhintint 的类似数组类型,它将被解释为相对范围,并强制转换为相对 ForecastingHorizon(fh, is_relative=True)

  • 如果 fh 的类型是 pd.Index,它将被解释为绝对范围,并强制转换为绝对 ForecastingHorizon(fh, is_relative=False)

Xsktime 兼容格式的时间序列,可选 (默认=None)

预测中使用的外生时间序列。应与 fity 的 scitype (Series, Panel, 或 Hierarchical) 相同。如果 self.get_tag("X-y-must-have-same-index"),则 X.index 必须包含 fh 索引引用。

marginalbool,可选 (默认=True)

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

返回:
pred_distskpro BaseDistribution

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

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

计算/返回分位数预测。

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

所需状态

要求状态为“fitted”,即 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)。

  • 如果 fhintint 的类似数组类型,它将被解释为相对范围,并强制转换为相对 ForecastingHorizon(fh, is_relative=True)

  • 如果 fh 的类型是 pd.Index,它将被解释为绝对范围,并强制转换为绝对 ForecastingHorizon(fh, is_relative=False)

Xsktime 兼容格式的时间序列,可选 (默认=None)

预测中使用的外生时间序列。应与 fity 的 scitype (Series, Panel, 或 Hierarchical) 相同。如果 self.get_tag("X-y-must-have-same-index"),则 X.index 必须包含 fh 索引引用。

alpha浮点数或包含唯一值的浮点数列表,可选 (默认=[0.05, 0.95])

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

返回:
quantilespd.DataFrame
列具有多重索引:第一级是 fity 的变量名,

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

行索引是 fh,如果 fit 中看到的 y 是 Panel 或 Hierarchical,则包含额外的(上层)级别等于实例级别。

来自 fit 中看到的 y,如果 fit 中看到的 y 是 Panel 或 Hierarchical。

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

在第二个列索引中的分位数概率,对于该行索引。

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

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

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

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

所需状态

要求状态为“fitted”。如果已设置 fh,则必须与 y 的索引(pandas 或整数)对应

访问 self 中的属性

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

写入 self

无。

参数:
ysktime 兼容数据容器格式的时间序列

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

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

  • 如果在单次 fit 调用之前,则生成样本内残差

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

Xsktime 兼容格式的时间序列,可选 (默认=None)

用于更新和预测的外生时间序列 应与 fity 的 scitype (Series, Panel, 或 Hierarchical) 相同。如果 self.get_tag("X-y-must-have-same-index"),则 X.index 必须包含 fh 索引引用和 y.index

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

fh 处的预测残差,与 fh 具有相同的索引。y_res 与最近传递的 y 具有相同的类型:Series, Panel, Hierarchical scitype,相同的格式(见上文)

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

计算/返回方差预测。

所需状态

要求状态为“fitted”,即 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)。

  • 如果 fhintint 的类似数组类型,它将被解释为相对范围,并强制转换为相对 ForecastingHorizon(fh, is_relative=True)

  • 如果 fh 的类型是 pd.Index,它将被解释为绝对范围,并强制转换为绝对 ForecastingHorizon(fh, is_relative=False)

Xsktime 兼容格式的时间序列,可选 (默认=None)

预测中使用的外生时间序列。应与 fity 的 scitype (Series, Panel, 或 Hierarchical) 相同。如果 self.get_tag("X-y-must-have-same-index"),则 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]#

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

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

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

参数:
pathNone 或文件位置 (str 或 Path)

如果为 None,self 将保存到一个内存对象;如果为文件位置,self 将保存到该文件位置。如果

  • path="estimator",则将在当前工作目录创建一个 zip 文件 estimator.zip

  • path="/home/stored/estimator",则将在 /home/stored/ 中存储一个 zip 文件 estimator.zip

存储在 /home/stored/ 中。

serialization_format: str, default = “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"),X.index 必须包含 y.index

返回:
score浮点数

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

set_config(**config_dict)[source]#

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

参数:
config_dictdict

配置名称:配置值对的字典。下面列出了有效的配置、值及其含义

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

jupyter 内核如何显示 self 的实例

  • “diagram” = html 框图表示

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

print_changed_onlybool,默认=True

打印 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”;要使用的日志记录器名称。

    • “mute_warnings”: bool,默认=False;如果为 True,则禁止警告

警告。

remember_databool,默认=True

返回:
是否在 fit 中存储 self._X 和 self._y,并在 update 中更新。如果为 True,则存储和更新 self._X 和 self._y。如果为 False,则不存储和更新 self._X 和 self._y。使用 save 时这会减小序列化大小,但 update 将默认为“不执行任何操作”而不是“重新拟合所有可见数据”。

self对 self 的引用。

注意

更改对象状态,将 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 的引用(设置参数后)

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

set_random_state(random_state=None, deep=True, self_policy='copy')[source]#

通过 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

deepbool,默认值=True

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

  • 是否在 skbase 对象值参数中设置随机状态,即组件估计器中。

  • 如果为 False,则仅设置 selfrandom_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 的引用

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

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

set_tags(**tag_dict)[source]#

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

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

当前标签值可以通过 get_tagsget_tag 进行检查。

参数:
set_tags 方法应仅在对象的 __init__ 方法中(在构造期间)或通过 __init__ 直接在构造后调用。

**tag_dictdict

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

Self

对 self 的引用。

更新截止点值,并可选地更新拟合参数。

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

  • 如果没有实现特定于估计器的 update 方法,则默认的备用如下:

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

所需状态

要求状态为“fitted”,即 self.is_fitted=True

访问 self 中的属性

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

  • self.cutoff, self.is_fitted

写入 self

  • update_params=False:仅更新 cutoff 并记住数据

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

参数:
ysktime 兼容数据容器格式的时间序列。

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

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

  • Series scitype = 个体时间序列,普通预测。pd.DataFrame, pd.Series, 或 np.ndarray (1D 或 2D)

  • Panel scitype = 时间序列集合,全局/面板预测。具有 2 级行 MultiIndex (实例, 时间)pd.DataFrame3D np.ndarray (实例, 变量, 时间)Series 类型 pd.DataFramelist

  • Hierarchical scitype = 分层集合,用于分层预测。具有 3 级或更多级行 MultiIndex (层级 1, ..., 层级 n, 时间)pd.DataFrame

有关数据格式的更多详细信息,请参阅 mtype 术语表。有关用法,请参阅预测教程 examples/01_forecasting.ipynb

Xsktime 兼容格式的时间序列,可选 (默认值=None)。

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

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

update_paramsbool,可选 (默认=True)

返回:
派生自输入的 random_state,通常与之不同
是否应更新模型参数。如果为 False,则仅更新截止点,模型参数(例如,系数)不更新。

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

update_predict(y, cv=None, X=None, update_params=True, reset_forecaster=True)[source]#

执行多个 update / predict 执行链的简写,基于时间分割器 cv 进行数据回放。

  1. 与以下相同(如果只有 y, cv 是非默认值)

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

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

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

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

  6. 等等

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

  • 如果没有实现特定于估计器的 update 方法,则默认的备用如下:

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

所需状态

要求状态为“fitted”,即 self.is_fitted=True

访问 self 中的属性

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

  • self.cutoff, self.is_fitted

返回所有记住的预测
  • update_params=False:仅更新 cutoff 并记住数据

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

写入 self(除非 reset_forecaster=True

参数:
ysktime 兼容数据容器格式的时间序列。

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

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

  • Series scitype = 个体时间序列,普通预测。pd.DataFrame, pd.Series, 或 np.ndarray (1D 或 2D)

  • Panel scitype = 时间序列集合,全局/面板预测。具有 2 级行 MultiIndex (实例, 时间)pd.DataFrame3D np.ndarray (实例, 变量, 时间)Series 类型 pd.DataFramelist

  • Hierarchical scitype = 分层集合,用于分层预测。具有 3 级或更多级行 MultiIndex (层级 1, ..., 层级 n, 时间)pd.DataFrame

有关数据格式的更多详细信息,请参阅 mtype 术语表。有关用法,请参阅预测教程 examples/01_forecasting.ipynb

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

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

Xsktime 兼容格式的时间序列,可选 (默认=None)

例如,SlidingWindowSplitterExpandingWindowSplitter;默认 = ExpandingWindowSplitter,initial_window=1,并且默认 = y/X 中的单个数据点逐个添加并预测,initial_window = 1step_length = 1fh = 1

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

update_paramsbool,可选 (默认=True)

用于更新和预测的外生时间序列 应与 fity 的 scitype (Series, Panel, 或 Hierarchical) 相同。如果 self.get_tag("X-y-must-have-same-index"),则 X.index 必须包含 fh 索引引用。
  • reset_forecasterbool,可选 (默认=True)

  • 如果为 True,则不会更改预测器的状态,即更新/预测序列将使用副本运行,并且 self 的截止点、模型参数、数据内存不会更改

返回:
如果为 False,则在运行更新/预测序列时将更新 self,就像直接调用 update/predict 一样

y_pred对多个分割批次的点预测进行制表的对象

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

  • 如果绝对范围点集合是唯一的:类型是 sktime 兼容数据容器格式的时间序列,输出中省略了截止点,与最近传递的 y 具有相同的类型:Series, Panel, Hierarchical scitype,相同的格式(见上文)

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

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

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

此方法对于一步完成更新和预测很有用。

所需状态

要求状态为“fitted”。

访问 self 中的属性

如果没有实现特定于估计器的 update 方法,则默认的备用是先 update,然后 predict。

写入 self

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

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

参数:
ysktime 兼容数据容器格式的时间序列。

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

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

  • Series scitype = 个体时间序列,普通预测。pd.DataFrame, pd.Series, 或 np.ndarray (1D 或 2D)

  • Panel scitype = 时间序列集合,全局/面板预测。具有 2 级行 MultiIndex (实例, 时间)pd.DataFrame3D np.ndarray (实例, 变量, 时间)Series 类型 pd.DataFramelist

  • Hierarchical scitype = 分层集合,用于分层预测。具有 3 级或更多级行 MultiIndex (层级 1, ..., 层级 n, 时间)pd.DataFrame

有关数据格式的更多详细信息,请参阅 mtype 术语表。有关用法,请参阅预测教程 examples/01_forecasting.ipynb

fhint, list, 可强制转换为 pd.Index, 或 ForecastingHorizon, 默认值=None

表示要预测的时间戳的预测范围。如果在 fit 中已经传递过,则不应再次传递。如果在 fit 中未传递过,则必须传递,不是可选的

Xsktime 兼容格式的时间序列,可选 (默认=None)

例如,SlidingWindowSplitterExpandingWindowSplitter;默认 = ExpandingWindowSplitter,initial_window=1,并且默认 = y/X 中的单个数据点逐个添加并预测,initial_window = 1step_length = 1fh = 1

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

update_paramsbool,可选 (默认=True)

返回:
y_predsktime 兼容数据容器格式的时间序列

fh 处的点预测,与 fh 具有相同的索引。y_pred 的类型与最近传入的 y 相同:SeriesPanelHierarchical scitype,格式相同(见上文)