DartsLinearRegressionModel#
- class DartsLinearRegressionModel(past_covariates: list[str] | None = None, num_samples: int | None = 1000, lags: int | list[int] | dict[str, int | list[int]] | None = None, lags_past_covariates: int | list[int] | dict[str, int | list[int]] | None = None, lags_future_covariates: tuple[int, int] | list[int] | dict[str, tuple[int, int] | list[int]] | None = None, output_chunk_length: int | None = 1, add_encoders: dict | None = None, likelihood: str | None = None, quantiles: list[float] | None = None, random_state: int | None = None, multi_models: bool | None = True, use_static_covariates: bool | None = True, kwargs: dict | None = None)[source]#
Darts 线性回归评估器。
这基于 Unit8 在 darts [1] 中实现的回归模型。
- 参数:
- lagsint、list 或 dict 之一,默认值=None
用于预测下一时间步的滞后目标值。如果给定整数,则使用最后 lags 个过去滞后(从 -1 开始向后)。否则,需要一个包含滞后整数的列表(每个滞后必须 < 0)。如果给定字典,则键对应于分量名称(使用多个序列时是第一个序列),值对应于分量滞后(整数或整数列表)。
- lags_past_covariatesint、list 或 dict 之一,默认值=None
用于预测下一时间步的滞后 past_covariates 值数量。如果给定整数,则使用最后 lags_past_covariates 个过去滞后(包括,从滞后 -1 开始)。否则,需要一个包含滞后 < 0 整数的列表。如果给定字典,则键对应于 past_covariates 分量名称(使用多个序列时是第一个序列),值对应于分量滞后(整数或整数列表)。
- lags_future_covariatestuple、list 或 dict 之一,默认值=None
用于预测下一时间步的滞后 future_covariates 值数量。如果给定元组 (past, future),则使用过去最后 past 个滞后(包括,从滞后 -1 开始),以及未来前 future 个滞后(从 0 - 预测时间 - 到 future - 1,包括)。否则,需要一个包含滞后整数的列表。如果给定字典,则键对应于 future_covariates 分量名称(使用多个序列时是第一个序列),值对应于分量滞后(整数或整数列表)。
- output_chunk_lengthint,默认值=1
内部回归模型一次预测的时间步长数量。不必等于 predict() 中使用的预测范围 n。然而,如果协变量在未来延伸不够远,将 output_chunk_length 设置为等于预测范围可能会很有用。
- add_encodersdict,默认值=None
可以使用 add_encoders 自动生成大量过去和未来协变量。这可以通过添加多个预定义的索引编码器和/或用作索引编码器的自定义用户函数来实现。此外,还可以添加转换器,例如 Darts 的
Scaler
,来转换生成的协变量。这一切都一次性完成,只需在模型创建时指定即可。阅读SequentialEncoder
以了解更多关于add_encoders
的信息。默认值:None
。显示add_encoders
部分功能的示例add_encoders={ 'cyclic': {'future': ['month']}, 'datetime_attribute': {'future': ['hour', 'dayofweek']}, 'position': {'past': ['relative'], 'future': ['relative']}, 'custom': {'past': [lambda idx: (idx.year - 1950) / 50]}, 'transformer': Scaler() }
- likelihoodstr,默认值=None
可以设置为 poisson 或 quantile。如果设置,模型将是概率性的,允许在预测时进行抽样。这将覆盖任何 objective 参数。
- quantileslist,默认值=None
如果 likelihood 设置为 quantile,则将模型拟合到这些分位数。
- random_stateint,默认值=None
控制拟合过程和抽样中的随机性。默认值:
None
。- multi_modelsbool,默认值=True
如果为 True,则为每个未来滞后训练一个单独的模型进行预测。如果为 False,则训练一个单一模型来预测未来步长 'output_chunk_length'。默认值:True。
- use_static_covariates: bool, 默认值=True
当传递给
fit()
的输入 series 包含静态协变量时,模型是否应使用静态协变量信息。如果True
,并且在拟合时存在静态协变量,则将强制要求所有目标 series 在fit()
和predict()
中具有相同的静态协变量维度。- past_covariateslist,默认值=None
X
中仅在历史数据中已知的列名,默认为 None- num_samplesint,默认值=1000
从概率模型中抽取预测样本的次数,默认为 1000
- kwargs
传递给 sklearn.linear_model.LinearRegression(默认)、如果 likelihood 是 poisson 则传递给 sklearn.linear_model.PoissonRegressor、如果 likelihood 是 quantile 则传递给 sklearn.linear_model.QuantileRegressor 的额外关键字参数。作为字典传递以符合 sklearn 的 API。默认值:
None
。
- 属性:
注意
如果未指定,所有列将被假定在预测期间已知。
参考
方法
check_is_fitted
([method_name])检查评估器是否已拟合。
clone
()获取具有相同超参数和配置的对象的克隆。
clone_tags
(estimator[, tag_names])从另一个对象克隆标签作为动态覆盖。
convert_dataframe_to_timeseries
(dataset)转换数据集以便与
darts
兼容。convert_exogenous_dataset
(dataset)如果可用,将外部特征转换为与
darts
兼容。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])从类获取类标签值,带有父类的标签级别继承。
从类获取类标签,带有父类的标签级别继承。
获取 self 的配置标志。
get_fitted_params
([deep])获取拟合参数。
获取对象的默认参数。
get_param_names
([sort])获取对象的参数名称。
get_params
([deep])获取此对象的参数值字典。
get_tag
(tag_name[, tag_value_default, ...])从实例获取标签值,带有标签级别继承和覆盖。
get_tags
()从实例获取标签,带有标签级别继承和覆盖。
get_test_params
([parameter_set])返回评估器的测试参数设置。
检查对象是否由其他 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])将序列化的 self 保存到字节类对象或到 (.zip) 文件。
score
(y[, X, fh])使用 MAPE(非对称)根据真实值对预测进行评分。
set_config
(**config_dict)将配置标志设置为给定值。
set_params
(**params)设置此对象的参数。
set_random_state
([random_state, deep, ...])为 self 设置 random_state 伪随机种子参数。
set_tags
(**tag_dict)将实例级标签覆盖设置为给定值。
update
(y[, X, update_params])更新截止值,并可选地更新拟合参数。
update_predict
(y[, cv, X, update_params, ...])对测试集进行迭代预测和模型更新。
update_predict_single
([y, fh, X, update_params])使用新数据更新模型并进行预测。
- classmethod get_test_params(parameter_set='default')[source]#
返回评估器的测试参数设置。
- 参数:
- parameter_setstr,默认值=”default”
要返回的测试参数集名称,用于测试。如果未为某个值定义特殊参数,则将返回“default”集。当前预测器没有保留值。
- 返回值:
- paramsdict 或 list of dict,默认值 = {}
用于创建类的测试实例的参数
- 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
查看。- 参数:
- estimatorBaseObject 或派生类的实例
- tag_namesstr 或 list of str,默认值 = None
要克隆的标签名称。默认值 (
None
) 克隆estimator
中的所有标签。
- 返回值:
- self
对
self
的引用。
- static convert_dataframe_to_timeseries(dataset: DataFrame)[source]#
转换数据集以便与
darts
兼容。- 参数:
- datasetpandas.DataFrame
要转换的源数据集
- 返回值:
- darts.TimeSeries
转换后的目标数据集
- convert_exogenous_dataset(dataset: DataFrame | None)[source]#
如果可用,将外部特征转换为与
darts
兼容。- 参数:
- datasetOptional[pandas.DataFrame]
关于外部特征的可用数据
- 返回值:
- Tuple[darts.TimeSeries, darts.TimeSeries]
未来已知和未来未知外部特征的转换数据
- 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 个元素是 obj 在测试中的第 i 个实例的名称。如果实例多于一个,命名约定为
{cls.__name__}-{i}
,否则为{cls.__name__}
- property cutoff[source]#
截止时间 = 预测器的“当前时间”状态。
- 返回值:
- cutoffpandas 兼容的索引元素,或 None
如果已设置截止时间,则为 pandas 兼容的索引元素;否则为 None
- fit(y, X=None, fh=None)[source]#
将预测器拟合到训练数据。
- 状态改变
将状态更改为“已拟合”。
写入 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
(instance, time)
的pd.DataFrame
,3Dnp.ndarray
(instance, variable, time)
,Series
类型pd.DataFrame
列表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
中传递,非可选。- Xsktime 兼容格式的时间序列,可选(默认为 None)。
用于拟合模型的外部时间序列。应与
y
具有相同的 scitype (Series
,Panel
, 或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
为 True,则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
。
- 参数:
- ysktime 兼容数据容器格式的时间序列
用于拟合预测器的时间序列。
sktime 中的个体数据格式是所谓的 mtype 规范,每个 mtype 实现一个抽象的 scitype。
Series
scitype = 个体时间序列,普通预测。pd.DataFrame
,pd.Series
, 或np.ndarray
(1D 或 2D)Panel
scitype = 时间序列集合,全局/面板预测。具有 2 级行MultiIndex
(instance, time)
的pd.DataFrame
,3Dnp.ndarray
(instance, variable, time)
,Series
类型pd.DataFrame
列表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) 将其强制转换。
- Xsktime 兼容格式的时间序列,可选(默认为 None)。
用于拟合模型的外部时间序列。应与
y
具有相同的 scitype (Series
,Panel
, 或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
为 True,则X.index
必须包含y.index
。- X_predsktime 兼容格式的时间序列,可选 (默认值为 None)
用于预测的外部时间序列。如果传入,将代替 X 用于预测。应该具有与 fit 中 y 相同的 scitype(
Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
为 True,则X.index
必须包含fh
索引参考。
- 返回值:
- y_predsktime 兼容数据容器格式的时间序列
在
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
的标签值,考虑标签覆盖,按以下优先级递减的顺序:在类的
_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 的配置标志。
配置是
self
的键值对,通常用作控制行为的瞬时标志。get_config
返回动态配置,它们会覆盖默认配置。默认配置在类或其父类的类属性
_config
中设置,并被通过set_config
设置的动态配置覆盖。配置在调用
clone
或reset
时保留。- 返回值:
- config_dictdict
配置名称:配置值对字典。通过嵌套继承从 _config 类属性收集,然后是来自 _onfig_dynamic 对象属性的任何覆盖和新标签。
- get_fitted_params(deep=True)[source]#
获取拟合参数。
- 所需状态
需要状态为“已拟合”。
- 参数:
- deep布尔值,默认为 True
是否返回组件的已拟合参数。
如果为 True,将返回此对象的参数名称:值字典,包括可拟合组件(= BaseEstimator 类型参数)的已拟合参数。
如果为 False,将返回此对象的参数名称:值字典,但不包括组件的已拟合参数。
- 返回值:
- fitted_params键为 str 值的字典
已拟合参数字典,参数名:参数值 键值对包括
始终:此对象的所有已拟合参数,例如通过
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]#
获取对象的参数名称。
- 参数:
- sort布尔值,默认为 True
是否按字母顺序返回参数名称 (True),或按它们在类
__init__
中出现的顺序返回 (False)。
- 返回值:
- param_names: list[str]
cls
的参数名称列表。如果sort=False
,则按它们在类__init__
中出现的相同顺序。如果sort=True
,则按字母顺序排序。
- get_params(deep=True)[source]#
获取此对象的参数值字典。
- 参数:
- deep布尔值,默认为 True
是否返回组件的参数。
如果
True
,将返回此对象的参数名称:值dict
,包括组件(=BaseObject
类型参数)的参数。如果
False
,将返回此对象的参数名称:值dict
,但不包括组件的参数。
- 返回值:
- params键为 str 值的字典
参数字典,参数名:参数值 键值对包括
始终:此对象的所有参数,例如通过
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_error布尔值
当找不到标签时是否引发
ValueError
- 返回值:
- tag_valueAny
self
中tag_name
标签的值。如果找不到,则在raise_error
为 True 时引发错误,否则返回tag_value_default
。
- 抛出:
- ValueError,如果
raise_error
为True
。 如果
tag_name
不在self.get_tags().keys()
中,则引发ValueError
。
- 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
对象属性的任何覆盖和新标签。
- is_composite()[source]#
检查对象是否由其他 BaseObjects 组成。
组合对象是包含其他对象作为参数的对象。在实例上调用,因为这可能因实例而异。
- 返回值:
- composite: bool
对象是否有任何参数的值是
BaseObject
后代实例。
- property is_fitted[source]#
是否已调用
fit
。检查对象的
_is_fitted` 属性,该属性在对象构造期间应初始化为 ``False``,并在调用对象的 fit 方法时设置为 True。
- 返回值:
- 布尔值
估计器是否已 fit。
- classmethod load_from_path(serial)[source]#
从文件位置加载对象。
- 参数:
- serialZipFile(path).open(“object) 的结果
- 返回值:
- 反序列化 self,产生在
path
处的输出,由cls.save(path)
生成
- 反序列化 self,产生在
- classmethod load_from_serial(serial)[source]#
从序列化内存容器加载对象。
- 参数:
- serial
cls.save(None)
输出的第一个元素
- serial
- 返回值:
- 产生输出
serial
的反序列化 self,由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
相同的 scitype(Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
为 True,则X.index
必须包含fh
索引参考。
- fhint, list, pd.Index 可强制转换类型, 或
- 返回值:
- y_predsktime 兼容数据容器格式的时间序列
在
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 的 array-like,则将其解释为相对范围,并被强制转换为相对ForecastingHorizon(fh, is_relative=True)
。如果
fh
是pd.Index
类型,则将其解释为绝对范围,并被强制转换为绝对ForecastingHorizon(fh, is_relative=False)
。
- Xsktime 兼容格式的时间序列,可选 (默认值为 None)
用于预测的外部时间序列。应该具有与
fit
中y
相同的 scitype(Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
为 True,则X.index
必须包含fh
索引参考。- coverage浮点数或包含唯一浮点数的列表,可选 (默认值为 0.90)
预测区间(s) 的标称覆盖率
- fhint, list, pd.Index 可强制转换类型, 或
- 返回值:
- pred_intpd.DataFrame
- 列具有多级索引:第一级是 fit 中 y 的变量名,
- 第二级是计算区间的覆盖率分数。
与输入
coverage
中的顺序相同。
第三级是字符串“lower”或“upper”,表示区间的下限/上限。
- 行索引是 fh,额外的 (上层) 级别等于实例级别,
来自 fit 中看到的 y,如果 fit 中看到的 y 是 Panel 或 Hierarchical。
- 条目是区间下限/上限的预测值,
对于列索引中的变量,在第二列索引中的标称覆盖率下,根据第三列索引是 lower 或 upper,对于该行索引。区间上限/下限预测值等同于在 alpha = 0.5 - c/2, 0.5 + c/2 处的分位数预测值,其中 c 在 coverage 中。
- predict_proba(fh=None, X=None, marginal=True)[source]#
计算/返回完全概率预测。
注意
目前仅对 Series (非 Panel、非 Hierarchical) 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 的 array-like,则将其解释为相对范围,并被强制转换为相对ForecastingHorizon(fh, is_relative=True)
。如果
fh
是pd.Index
类型,则将其解释为绝对范围,并被强制转换为绝对ForecastingHorizon(fh, is_relative=False)
。
- Xsktime 兼容格式的时间序列,可选 (默认值为 None)
用于预测的外部时间序列。应该具有与
fit
中y
相同的 scitype(Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
为 True,则X.index
必须包含fh
索引参考。- marginal布尔值,可选 (默认为 True)
返回的分布是否是按时间索引的边际分布
- fhint, list, pd.Index 可强制转换类型, 或
- 返回值:
- 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 的 array-like,则将其解释为相对范围,并被强制转换为相对ForecastingHorizon(fh, is_relative=True)
。如果
fh
是pd.Index
类型,则将其解释为绝对范围,并被强制转换为绝对ForecastingHorizon(fh, is_relative=False)
。
- Xsktime 兼容格式的时间序列,可选 (默认值为 None)
用于预测的外部时间序列。应该具有与
fit
中y
相同的 scitype(Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
为 True,则X.index
必须包含fh
索引参考。- alpha浮点数或包含唯一浮点数的列表,可选 (默认值为 [0.05, 0.95])
计算分位数预测值的一个或多个概率。
- fhint, list, pd.Index 可强制转换类型, 或
- 返回值:
- quantilespd.DataFrame
- 列具有多级索引:第一级是 fit 中 y 的变量名,
第二级是传递给函数的 alpha 值。
- 行索引是 fh,额外的 (上层) 级别等于实例级别,
来自 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])) 处计算残差
- 所需状态
需要状态为“已拟合”。如果已设置 fh,则必须与 y 的索引 (pandas 或整数) 对应。
- 在 self 中访问:
结尾为“_”的已拟合模型属性。self.cutoff, self._is_fitted
- 写入 self
无。
- 参数:
- ysktime 兼容数据容器格式的时间序列
具有真实观测值的时间序列,用于计算残差。必须与 predict 的预期返回值具有相同的类型、维度和索引。
如果为 None,则使用迄今为止看到的 y (self._y),特别是
如果前面只有一次 fit 调用,则产生样本内残差
如果 fit 需要
fh
,则必须指向 fit 中 y 的索引
- Xsktime 兼容格式的时间序列,可选 (默认值为 None)
用于更新和预测的外部时间序列。应该具有与
fit
中y
相同的 scitype(Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
为 True,则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]#
计算/返回方差预测。
- 所需状态
需要状态为“已拟合”,即
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 的 array-like,则将其解释为相对范围,并被强制转换为相对ForecastingHorizon(fh, is_relative=True)
。如果
fh
是pd.Index
类型,则将其解释为绝对范围,并被强制转换为绝对ForecastingHorizon(fh, is_relative=False)
。
- Xsktime 兼容格式的时间序列,可选 (默认值为 None)
用于预测的外部时间序列。应该具有与
fit
中y
相同的 scitype(Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
为 True,则X.index
必须包含fh
索引参考。- cov布尔值,可选 (默认为 False)
如果为 True,计算协方差矩阵预测值。如果为 False,计算边际方差预测值。
- fhint, list, pd.Index 可强制转换类型, 或
- 返回值:
- pred_varpd.DataFrame,格式取决于
cov
变量 - 如果 cov=False
- 列名与在
fit
/update
中传入的y
的列名完全相同。 对于无名称格式,列索引将是 RangeIndex。
- 行索引是 fh,额外的级别等于实例级别,
来自 fit 中看到的 y,如果 fit 中看到的 y 是 Panel 或 Hierarchical。
来自 fit 中看到的 y,如果 fit 中看到的 y 是 Panel 或 Hierarchical。
条目是方差预测值,对于列索引中的变量。给定变量和 fh 索引的方差预测值是预测的
- 列名与在
- 在给定观测数据下,该变量和索引的方差。
- 如果 cov=True
列索引是多级索引:第一级是变量名 (同上)
- 行索引是 fh,额外的级别等于实例级别,
来自 fit 中看到的 y,如果 fit 中看到的 y 是 Panel 或 Hierarchical。
- 第二级是 fh。
条目是 (协)方差预测值,对于列索引中的变量,以及
行和列中时间索引之间的协方差。
- pred_varpd.DataFrame,格式取决于
- 注意:不同变量之间不返回协方差预测值。
将对象重置为干净的初始化后状态。
结果是将
self
设置为构造函数调用后的状态,具有相同的超参数。通过set_config
设置的配置值也保留。调用
reset
会删除任何对象属性,除了超参数 = 写入
self
的__init__
参数,例如self.paramname
,其中paramname
是__init__
的参数包含双下划线(即字符串“__”)的对象属性。例如,名为“__myattr”的属性会保留。
配置属性,配置不变地保留。即,
reset
前后get_config
的结果相同。类和对象方法,以及类属性也不受影响。
等同于
clone
,除了reset
会修改self
而不是返回一个新的对象。- 返回值:
- self
调用
self.reset()
后,self
在值和状态上等于构造函数调用type(self)(**self.get_params(deep=False))
后获得的对象。
- 类实例重置为干净的 post-init 状态,但保留当前的超参数值。
将序列化的 self 保存到字节类对象或到 (.zip) 文件。
save(path=None, serialization_format='pickle')[source]#
行为:如果
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” 则 zip 文件
estimator.zip
将- 存储在
/home/stored/
中。 serialization_format: str, default = “pickle”
- 返回值:
- 用于序列化的模块。可用选项有“pickle”和“cloudpickle”。注意,非默认格式可能需要安装其他软依赖项。
- 如果
path
为 None - 内存中的序列化 self
-
如果
path
是文件位置 - 带有文件引用的 ZipFile 使用 MAPE(非对称)根据真实值对预测进行评分。
- 参数:
- 返回值:
- 要评分的外部时间序列,如果 self.get_tag(“X-y-must-have-same-index”) 为 True,则 X.index 必须包含 y.index
fhfh
- 另见
将配置标志设置为给定值。
- 参数:
- config_dictdict
sktime.performance_metrics.forecasting.mean_absolute_percentage_error
- set_config(**config_dict)[source]#
配置名称:配置值对字典。有效配置、值及其含义如下所列:
displaystr,“diagram”(默认)或“text”
jupyter 内核如何显示 self 的实例
- “diagram” = html 框图表示
“text” = 字符串输出
- print_changed_only布尔值,默认为 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”:布尔值,默认为 True;False 可防止
ray
在并行化后关闭。
- “logger_name”:str,默认为“ray”;要使用的 logger 名称。
“mute_warnings”:布尔值,默认为 False;如果为 True,则禁止显示警告
- 返回值:
- remember_data布尔值,默认为 True
注意
self._X 和 self._y 是否在 fit 中存储并在 update 中更新。如果为 True,self._X 和 self._y 会被存储和更新。如果为 False,self._X 和 self._y 不会被存储和更新。这在使用 save 时会减小序列化大小,但 update 将默认为“不执行任何操作”,而不是“重新拟合所有已见数据”。
- self对 self 的引用。
设置此对象的参数。
更改对象状态,将 config_dict 中的配置复制到 self._config_dynamic。
-
BaseObject 参数,键必须是
<component>__<parameter>
字符串。__
后缀可以作为完整字符串的别名,如果它们在 get_params 键中是唯一的。 为 self 设置 random_state 伪随机种子参数。
self对 self 的引用 (设置参数后)
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
参数的对象。- deep布尔值,默认为 True
random_stateint, RandomState 实例或 None,默认为 None
控制随机整数生成的伪随机数生成器。传入 int 以在多次函数调用中获得可重现的输出。
deep布尔值,默认为 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
保持不变
- “keep”:
-
“new”:
self.random_state
被设置为一个新的随机状态, 将实例级标签覆盖设置为给定值。
每个
scikit-base
兼容对象都有一个标签字典,用于存储有关对象的元数据。从输入的
random_state
派生,通常与它不同self对 self 的引用
当前标签值可以通过
get_tags
或get_tag
查看。- 参数:
- 标签是特定于实例
self
的键值对,它们是静态标志,在对象构造后不会改变。它们可用于元数据检查或控制对象的行为。 set_tags
将动态标签覆盖设置为tag_dict
中指定的值,其中键是标签名称,字典值是要设置的标签值。
- 标签是特定于实例
- 返回值:
set_tags
方法只能在对象的__init__
方法中调用,在构造期间,或通过__init__
直接构造后。**tag_dictdict
- 标签名称:标签值对字典。
更新截止值,并可选地更新拟合参数。
Self
- 所需状态
需要状态为“已拟合”,即
self.is_fitted=True
。
在 self 中访问:
结尾为“_”的已拟合模型属性。
self.cutoff
,self.is_fitted
写入 self
如果没有实现特定于估计器的 update 方法,默认备用方案如下:
update_params=True
:拟合到目前为止所有观测数据
- 参数:
- ysktime 兼容数据容器格式的时间序列。
update_params=False
:仅更新 cutoff 并记住数据sktime 中的个体数据格式是所谓的 mtype 规范,每个 mtype 实现一个抽象的 scitype。
Series
scitype = 个体时间序列,普通预测。pd.DataFrame
,pd.Series
, 或np.ndarray
(1D 或 2D)Panel
scitype = 时间序列集合,全局/面板预测。具有 2 级行MultiIndex
(instance, time)
的pd.DataFrame
,3Dnp.ndarray
(instance, variable, time)
,Series
类型pd.DataFrame
列表Hierarchical
scitype = 分层集合,用于分层预测。具有 3 个或更多级别行MultiIndex
(hierarchy_1, ..., hierarchy_n, time)
的pd.DataFrame
有关数据格式的更多详细信息,请参见 mtype 术语表。有关用法,请参见预测教程
examples/01_forecasting.ipynb
- Xsktime 兼容格式的时间序列,可选(默认为 None)。
将
self.cutoff
更新为y
中看到的最新索引。- 如果
update_params=True
,更新结尾为“_”的已拟合模型属性。 y用于更新预测器的时间序列。
- 返回值:
- “keep”:
self.random_state
保持不变
- “keep”:
- X用于更新模型拟合的外部时间序列,sktime 兼容格式,可选 (默认值为 None)
对测试集进行迭代预测和模型更新。
应该具有与
y
相同的 scitype(Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
为 True,则X.index
必须包含y.index
。update_params布尔值,可选 (默认为 True)
模型参数是否应该更新。如果为
False
,则仅更新 cutoff,模型参数(例如系数)不更新。update_predict(y, cv=None, X=None, update_params=True, reset_forecaster=True)[source]#
这是执行多次
update
/predict
操作链的简写方式,基于时间分割器cv
进行数据回放。update_predict(y, cv=None, X=None, update_params=True, reset_forecaster=True)[source]#
与以下相同(如果只有
y
,cv
不是默认值):self.update(y=cv.split_series(y)[0][0])
Self
- 所需状态
需要状态为“已拟合”,即
self.is_fitted=True
。
在 self 中访问:
结尾为“_”的已拟合模型属性。
self.cutoff
,self.is_fitted
- 记住
self.predict()
(稍后在单个批次中返回) 如果没有实现特定于估计器的 update 方法,默认备用方案如下:
update_params=True
:拟合到目前为止所有观测数据
self.update(y=cv.split_series(y)[1][0])
- 参数:
- ysktime 兼容数据容器格式的时间序列。
update_params=False
:仅更新 cutoff 并记住数据sktime 中的个体数据格式是所谓的 mtype 规范,每个 mtype 实现一个抽象的 scitype。
Series
scitype = 个体时间序列,普通预测。pd.DataFrame
,pd.Series
, 或np.ndarray
(1D 或 2D)Panel
scitype = 时间序列集合,全局/面板预测。具有 2 级行MultiIndex
(instance, time)
的pd.DataFrame
,3Dnp.ndarray
(instance, variable, time)
,Series
类型pd.DataFrame
列表Hierarchical
scitype = 分层集合,用于分层预测。具有 3 个或更多级别行MultiIndex
(hierarchy_1, ..., hierarchy_n, time)
的pd.DataFrame
有关数据格式的更多详细信息,请参见 mtype 术语表。有关用法,请参见预测教程
examples/01_forecasting.ipynb
- 等
返回所有记住的预测值
- Xsktime 兼容格式的时间序列,可选 (默认值为 None)
写入 self (除非
reset_forecaster=True
)- 如果
update_params=True
,更新结尾为“_”的已拟合模型属性。 y用于更新预测器的时间序列。
- 如果
reset_forecaster=True
,不更新状态。 cv继承自 BaseSplitter 的时间交叉验证生成器,可选
例如,
SlidingWindowSplitter
或ExpandingWindowSplitter
;默认为 ExpandingWindowSplitter,initial_window=1
,并且默认情况下 y/X 中的单个数据点逐个添加并预测,initial_window = 1
,step_length = 1
且fh = 1
- 返回值:
- X用于更新和预测的外部时间序列,sktime 兼容格式,可选 (默认值为 None)
应该具有与
fit
中y
相同的 scitype(Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
为 True,则X.index
必须包含fh
索引参考。reset_forecaster布尔值,可选 (默认为 True)
如果为 True,将不会改变预测器的状态,即 update/predict 序列是使用副本运行的,并且 self 的 cutoff、模型参数、数据内存不会改变
- 如果为 False,当 update/predict 序列运行时,将像直接调用 update/predict 一样更新 self
使用新数据更新模型并进行预测。
y_pred用于表格化来自多个分割批次的点预测的对象
格式取决于总体的 (cutoff, 绝对范围) 预测对
- 所需状态
需要状态为“已拟合”。
- 在 self 中访问:
如果绝对范围点的集合是唯一的:类型是 sktime 兼容数据容器格式的时间序列,输出中省略 cutoff,具有最近传入的 y 的相同类型:Series, Panel, Hierarchical scitype (类型),相同的格式 (见上文)
- 写入 self
如果绝对范围点的集合不唯一:类型是 pandas DataFrame,行和列索引是时间戳,行索引对应于从中预测的 cutoffs,列索引对应于预测的绝对范围,条目是从行索引预测的列索引的点预测值,如果在该 (cutoff, horizon) 对没有预测,则条目为 nan
- 参数:
- ysktime 兼容数据容器格式的时间序列。
update_params=False
:仅更新 cutoff 并记住数据sktime 中的个体数据格式是所谓的 mtype 规范,每个 mtype 实现一个抽象的 scitype。
Series
scitype = 个体时间序列,普通预测。pd.DataFrame
,pd.Series
, 或np.ndarray
(1D 或 2D)Panel
scitype = 时间序列集合,全局/面板预测。具有 2 级行MultiIndex
(instance, time)
的pd.DataFrame
,3Dnp.ndarray
(instance, variable, time)
,Series
类型pd.DataFrame
列表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)
写入 self (除非
reset_forecaster=True
)- 如果
update_params=True
,更新结尾为“_”的已拟合模型属性。 y用于更新预测器的时间序列。
- 返回值:
- y_predsktime 兼容数据容器格式的时间序列
在
fh
处的点预测值,具有与fh
相同的索引。y_pred
具有最近传入的y
的相同类型:Series
、Panel
、Hierarchical
scitype,相同的格式 (见上文)