Permute#
- class Permute(estimator, permutation=None, steps_arg='steps')[source]#
用于排列预测流水线步骤的置换合成器。
该合成器可用于排列任何元预测器(包括 ForecastingPipeline、TransformedTargetForecaster)的步骤顺序。
steps_arg 参数需要指向包装预测器的“steps”类参数,permutation 参数则用于切换步骤的顺序。
单独使用不太有用,但与调优或自动机器学习包装器结合使用时非常有用。
- 参数:
- estimatorsktime 预测器,继承自 BaseForecaster
必须有一个名为 steps_arg 的参数,该参数指向其步骤将被置换的预测器
- permutation字符串列表,或 None,可选,默认为 None
如果不为 None,则必须与 getattr(estimator, steps_arg) 长度相等,且元素必须等于 estimator.steps_arg 评估器的名称;名称是由 _get_estimator_tuples(如果列表未命名)创建的唯一名称,或者是元组的第一个字符串元素;estimator.steps_arg 列表被解释为名称的排列范围;如果为 None,则解释为恒等置换。
- steps_arg字符串,可选,默认为“steps”
steps 参数的名称。getattr(estimator, steps_arg) 必须是评估器列表,或 (字符串, 评估器) 对列表。
- 属性:
示例
>>> from sktime.datasets import load_airline >>> from sktime.forecasting.base import ForecastingHorizon >>> from sktime.forecasting.compose import ForecastingPipeline, Permute >>> from sktime.forecasting.naive import NaiveForecaster >>> from sktime.transformations.series.boxcox import BoxCoxTransformer >>> from sktime.transformations.series.exponent import ExponentTransformer
简单示例:在预测流水线中置换评估器序列
>>> y = load_airline() >>> fh = ForecastingHorizon([1, 2, 3]) >>> pipe = ForecastingPipeline( ... [ ... ("boxcox", BoxCoxTransformer()), ... ("exp", ExponentTransformer(3)), ... ("naive", NaiveForecaster()), ... ] ... ) >>> # this results in the pipeline with sequence "exp", "boxcox", "naive" >>> permuted = Permute(pipe, ["exp", "boxcox", "naive"]) >>> permuted = permuted.fit(y, fh=fh) >>> y_pred = permuted.predict()
置换器与网格搜索结合使用时很有用(示例)
>>> from sktime.datasets import load_shampoo_sales >>> from sktime.forecasting.model_selection import ForecastingGridSearchCV >>> from sktime.split import ExpandingWindowSplitter >>> fh = [1,2,3] >>> cv = ExpandingWindowSplitter(fh=fh) >>> forecaster = NaiveForecaster() >>> # check which of the two sequences of transformers is better >>> param_grid = { ... "permutation" : [["boxcox", "exp", "naive"], ["exp", "boxcox", "naive"]] ... } >>> gscv = ForecastingGridSearchCV( ... forecaster=permuted, ... param_grid=param_grid, ... cv=cv)
方法
check_is_fitted
([方法名称])检查评估器是否已拟合。
clone
()获取具有相同超参数和配置的对象的克隆。
clone_tags
(评估器[, 标签名称])将另一个对象的标签克隆为动态覆盖。
create_test_instance
([参数集])使用第一个测试参数集构造类的实例。
创建所有测试实例的列表及其名称列表。
fit
(y[, X, fh])将预测器拟合到训练数据。
fit_predict
(y[, X, fh, X_pred])拟合并预测未来范围的时间序列。
get_class_tag
(标签名称[, 默认标签值])从类中获取类标签值,继承父类的标签级别。
从类中获取类标签,继承父类的标签级别。
获取自身的配置标志。
get_fitted_params
([deep])获取已拟合的参数。
获取对象的默认参数。
get_param_names
([排序])获取对象的参数名称。
get_params
([deep])获取此对象的参数值字典。
get_tag
(标签名称[, 默认标签值, ...])从实例中获取标签值,具有标签级别继承和覆盖。
get_tags
()从实例中获取标签,具有标签级别继承和覆盖。
get_test_params
([参数集])返回评估器的测试参数设置。
检查对象是否由其他 BaseObject 组成。
load_from_path
(序列)从文件位置加载对象。
load_from_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
([路径, 序列化格式])将序列化的自身保存到字节类对象或 (.zip) 文件。
score
(y[, X, fh])使用 MAPE(非对称)对预测与实际值进行评分。
set_config
(**配置字典)将配置标志设置为给定值。
set_params
(**参数)设置此对象的参数。
set_random_state
([random_state, deep, ...])为自身设置 random_state 伪随机种子参数。
set_tags
(**标签字典)将实例级别标签覆盖设置为给定值。
update
(y[, X, update_params])更新截止点值,并可选择更新已拟合的参数。
update_predict
(y[, cv, X, update_params, ...])在测试集上迭代进行预测和更新模型。
update_predict_single
([y, fh, X, update_params])使用新数据更新模型并进行预测。
- check_is_fitted(method_name=None)[source]#
检查评估器是否已拟合。
检查
_is_fitted
属性是否存在且True
。is_fitted
属性应在调用对象的fit
方法时设置为True
。如果未拟合,则引发
NotFittedError
异常。- 参数:
- method_name字符串,可选
调用此函数的方法的名称。如果提供,错误消息将包含此信息。
- 引发:
- NotFittedError
如果评估器尚未拟合。
- clone()[source]#
获取具有相同超参数和配置的对象的克隆。
克隆是一个不同的对象,没有共享引用,处于初始化后状态。此函数等效于返回自身的
sklearn.clone
。等效于构造一个新的
type(self)
实例,具有自身的参数,即type(self)(**self.get_params(deep=False))
。如果自身设置了配置,则克隆也会具有与原始对象相同的配置,等效于调用
cloned_self.set_config(**self.get_config())
。在值上与调用自身的
reset
方法也等效,不同之处在于clone
返回一个新对象,而不是像reset
那样改变自身。- 引发:
- 如果克隆不符合规范,由于
__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
中的所有标签写入自身。可以通过
get_tags
或get_tag
检查当前的标签值。- 参数:
- estimatorBaseObject 或派生类的实例
- tag_names字符串或字符串列表,默认为 None
要克隆的标签名称。默认值 (
None
) 克隆estimator
的所有标签。
- 返回:
- self
对自身的引用。
- classmethod create_test_instance(parameter_set='default')[source]#
使用第一个测试参数集构造类的实例。
- 参数:
- parameter_set字符串,默认为“default”
要返回的测试参数集的名称,用于测试。如果某个值没有定义特殊参数,则返回“default”集。
- 返回:
- instance具有默认参数的类的实例
- classmethod create_test_instances_and_names(parameter_set='default')[source]#
创建所有测试实例的列表及其名称列表。
- 参数:
- parameter_set字符串,默认为“default”
要返回的测试参数集的名称,用于测试。如果某个值没有定义特殊参数,则返回“default”集。
- 返回:
- objscls 的实例列表
第 i 个实例是
cls(**cls.get_test_params()[i])
- names字符串列表,与 objs 长度相同
第 i 个元素是 objs 中第 i 个实例在测试中的名称。命名约定为:如果有多个实例,则为
{cls.__name__}-{i}
,否则为{cls.__name__}
。
- property cutoff[source]#
截止点 = 预测器的“当前时间”状态。
- 返回:
- cutoffpandas 兼容的索引元素,或 None
pandas 兼容的索引元素,如果 cutoff 已设置;否则为 None。
- 已传递的预测范围。
将预测器拟合到训练数据。
将状态更改为“已拟合”。
写入自身
设置以“_”结尾的已拟合模型属性,已拟合属性可通过
get_fitted_params
进行检查。将
self.is_fitted
标志设置为True
。将
self.cutoff
设置为在y
中看到的最后一个索引。
- 参数:
- 如果
fh
被传递,则将fh
存储到self.fh
。 ysktime 兼容数据容器格式的时间序列。
用于拟合预测器的时间序列。
Series
scitype = 单个时间序列,普通预测。pd.DataFrame
,pd.Series
, 或np.ndarray
(1D 或 2D)Panel
scitype = 时间序列集合,全局/面板预测。具有 2 级行MultiIndex
(实例, 时间)
的pd.DataFrame
,3D np.ndarray
(实例, 变量, 时间)
,Series
类型的pd.DataFrame
列表。
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
具有相同的 scitype(Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
为True
,则X.index
必须包含y.index
。
- 用于拟合模型的外生时间序列。应与
- self对自身的引用。
拟合并预测未来范围的时间序列。
fit_predict(y, X=None, fh=None, X_pred=None)[source]#
将状态更改为“已拟合”。
写入自身
设置以“_”结尾的已拟合模型属性,已拟合属性可通过
get_fitted_params
进行检查。将
self.is_fitted
标志设置为True
。与
fit(y, X, fh).predict(X_pred)
相同。如果未传递X_pred
,则与fit(y, fh, X).predict(X)
相同。
- 参数:
- 将
fh
存储到self.fh
。 ysktime 兼容数据容器格式的时间序列。
用于拟合预测器的时间序列。
Series
scitype = 单个时间序列,普通预测。pd.DataFrame
,pd.Series
, 或np.ndarray
(1D 或 2D)Panel
scitype = 时间序列集合,全局/面板预测。具有 2 级行MultiIndex
(实例, 时间)
的pd.DataFrame
,3D np.ndarray
(实例, 变量, 时间)
,Series
类型的pd.DataFrame
列表。
Hierarchical
scitype = 分层集合,用于分层预测。具有 3 级或更多行MultiIndex
(层次结构_1, ..., 层次结构_n, 时间)
的pd.DataFrame
。- ysktime 兼容数据容器格式的时间序列
fhint, list, 可强制转换为 pd.Index, 或
ForecastingHorizon
(不可选)预测范围编码了要预测的时间戳。
- 预测范围编码了要预测的时间戳。如果
self.get_tag("requires-fh-in-fit")
为True
,则必须在fit
中传递,不可选。 Xsktime 兼容格式的时间序列,可选(默认为 None)。
- 如果 fh 不为 None 且不是 ForecastingHorizon 类型,则通过调用 _check_fh 将其强制转换为 ForecastingHorizon。特别是,如果 fh 是 pd.Index 类型,则通过 ForecastingHorizon(fh, is_relative=False) 将其强制转换。
X_predsktime 兼容格式的时间序列,可选(默认为 None)
- 将
- 返回:
- 用于预测的外生时间序列。如果传递,将在 predict 中使用而不是 X。应与 fit 中的 y 具有相同的 scitype(
Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
为 True,则 X.index 必须包含 fh 索引引用。 y_predsktime 兼容数据容器格式的时间序列
- 用于预测的外生时间序列。如果传递,将在 predict 中使用而不是 X。应与 fit 中的 y 具有相同的 scitype(
-
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_name字符串
- 标签值的名称。
tag_value_default任何类型
- 要检索具有潜在实例覆盖的标签值,请改用
- 返回:
- 如果找不到标签的默认/备用值。
tag_value
-
自身中
tag_name
标签的值。如果找不到,则返回tag_value_default
。 从类中获取类标签,继承父类的标签级别。
每个
scikit-base
兼容对象都有一个标签字典。标签可用于存储对象的元数据或控制对象的行为。标签是特定于实例
self
的键值对,它们是静态标志,在对象构造后不会更改。classmethod get_class_tags()[source]#
get_class_tags
方法是一个类方法,仅考虑类级别标签值和覆盖来检索标签的值。它返回一个字典,其键是类或其任何父类中设置的
_tags
任何属性的键。它返回对象中名为
tag_name
的标签的值,考虑标签覆盖,优先级降序排列如下:类
_tags
属性中设置的标签。
父类
_tags
属性中设置的标签,值是对应的标签值,覆盖的优先级降序排列如下:
实例可以根据超参数覆盖这些标签。
按继承顺序排列。
要检索具有潜在实例覆盖的标签,请改用
get_tags
方法。- 对于包含来自动态标签的覆盖,请使用
get_tags
。 collected_tags字典
-
标签名称 : 标签值对的字典。通过嵌套继承从
_tags
类属性收集。不受通过set_tags
或clone_tags
设置的动态标签覆盖。 获取自身的配置标志。
配置是自身的键值对,通常用作控制行为的临时标志。
get_config
返回动态配置,它会覆盖默认配置。默认配置在类或其父类的
_config
类属性中设置,并被通过set_config
设置的动态配置覆盖。- 返回:
- 配置在
clone
或reset
调用下会被保留。 config_dict字典
- 配置在
- 配置名称 : 配置值对的字典。通过嵌套继承从 _config 类属性收集,然后从 _onfig_dynamic 对象属性收集任何覆盖和新标签。
获取已拟合的参数。
- 参数:
- 要求状态为“已拟合”。
deep布尔值,默认为 True
是否返回组件的拟合参数。
如果为 True,将返回此对象的参数名称 : 值字典,包括可拟合组件(= BaseEstimator 类型参数)的拟合参数。
- 返回:
- 如果为 False,将返回此对象的参数名称 : 值字典,但不包括组件的拟合参数。
fitted_params键为字符串的字典
拟合参数字典,参数名 : 参数值 键值对包含
始终:此对象的所有拟合参数,如同通过
get_param_names
获取,值是此对象该键的拟合参数值。如果
deep=True
,还包含组件参数的键值对;组件参数以[组件名称]__[参数名称]
为索引;组件名称的所有参数以其值作为参数名称出现。
-
如果
deep=True
,还包含任意级别的组件递归,例如[组件名称]__[子组件名称]__[参数名称]
等。 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]
- 是否按字母顺序(True)或按其在类
-
cls
的参数名称列表。如果sort=False
,则按其在类__init__
中出现的相同顺序排列。如果sort=True
,则按字母顺序排列。 获取此对象的参数值字典。
- 参数:
- 返回:
- 如果
False
,将返回此对象的参数名称 : 值字典,但不包括组件的参数。 params键为字符串的字典
参数字典,参数名 : 参数值 键值对包含
始终:此对象的所有拟合参数,如同通过
get_param_names
获取,值是此对象该键的拟合参数值。如果
deep=True
,还包含组件参数的键值对;组件参数以[组件名称]__[参数名称]
为索引;组件名称的所有参数以其值作为参数名称出现。
- 如果
-
始终:此对象的所有参数,如同通过
get_param_names
获取,值是此对象该键的参数值,值总是与构造时传递的值相同。 从实例中获取标签值,具有标签级别继承和覆盖。
每个
scikit-base
兼容对象都有一个标签字典。标签可用于存储对象的元数据或控制对象的行为。标签是特定于实例
self
的键值对,它们是静态标志,在对象构造后不会更改。get_tag(tag_name, tag_value_default=None, raise_error=True)[source]#
get_tag
方法从实例中检索名称为tag_name
的单个标签的值,考虑标签覆盖,优先级降序排列如下:
通过
set_tags
或clone_tags
在实例上设置的标签,它返回对象中名为
tag_name
的标签的值,考虑标签覆盖,优先级降序排列如下:类
_tags
属性中设置的标签。
父类
_tags
属性中设置的标签,- 参数:
- 要检索具有潜在实例覆盖的标签值,请改用
get_tag
方法。 在实例构造时设置。
- 要检索的标签名称
tag_value_default任何类型,可选;默认为 None
- 如果找不到标签的默认/备用值
raise_error布尔值
- 要检索具有潜在实例覆盖的标签值,请改用
- 返回:
- 找不到标签时是否引发
ValueError
tag_value任何类型
- 找不到标签时是否引发
- 引发:
- 自身中
tag_name
标签的值。如果找不到,则在raise_error
为 True 时引发错误,否则返回tag_value_default
。 ValueError,如果
raise_error
为True
。
- 自身中
-
如果
tag_name
不在self.get_tags().keys()
中,则引发ValueError
。 从实例中获取标签,具有标签级别继承和覆盖。
每个
scikit-base
兼容对象都有一个标签字典。标签可用于存储对象的元数据或控制对象的行为。标签是特定于实例
self
的键值对,它们是静态标志,在对象构造后不会更改。它返回一个字典,其键是类或其任何父类中设置的
_tags
任何属性的键。get_tag
方法从实例中检索名称为tag_name
的单个标签的值,考虑标签覆盖,优先级降序排列如下:
通过
set_tags
或clone_tags
在实例上设置的标签,它返回对象中名为
tag_name
的标签的值,考虑标签覆盖,优先级降序排列如下:类
_tags
属性中设置的标签。
父类
_tags
属性中设置的标签,- 返回:
get_tags
方法返回一个标签字典,其键是类或其任何父类中设置的_tags
任何属性的键,或通过set_tags
或clone_tags
设置的标签的键。collected_tags字典
-
标签名称 : 标签值对的字典。通过嵌套继承从
_tags
类属性收集,然后从_tags_dynamic
对象属性收集任何覆盖和新标签。 检查对象是否由其他 BaseObject 组成。
- 返回:
- 复合对象是包含其他对象作为参数的对象。在实例上调用,因为这可能因实例而异。
composite: 布尔值
- 对象是否有任何参数的值是 BaseObject 派生实例。
是否已调用
fit
方法。- 返回:
- 检查对象的
_is_fitted
属性,该属性应在对象构造期间初始化为False
,并在调用对象的 fit 方法时设置为 True。 布尔值
- 检查对象的
- 评估器是否已 fit。
从文件位置加载对象。
-
反序列化的自身,结果输出到路径,即
cls.save(path)
的结果 从序列化的内存容器加载对象。
-
反序列化的自身,结果输出
serial
,即cls.save(None)
的结果 预测未来范围的时间序列。
要求状态为“已拟合”,即
self.is_fitted=True
。访问自身
以“_”结尾的拟合模型属性。
- 将状态更改为“已拟合”。
self.cutoff
,self.is_fitted
- 参数:
- 有关数据格式的更多详细信息,请参阅 mtype 的词汇表。有关用法,请参阅预测教程
examples/01_forecasting.ipynb
。 如果
fh
被传递且之前未传递,则将fh
存储到self.fh
。预测范围编码了要预测的时间戳。
- 预测范围编码了要预测的时间戳。如果已在 fit 中传递,则不应再传递。如果未在 fit 中传递,则必须传递,不可选。
Xsktime 兼容格式的时间序列,可选(默认为 None)
- 有关数据格式的更多详细信息,请参阅 mtype 的词汇表。有关用法,请参阅预测教程
- 返回:
- 用于预测的外生时间序列。如果传递,将在 predict 中使用而不是 X。应与 fit 中的 y 具有相同的 scitype(
Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
为 True,则 X.index 必须包含 fh 索引引用。 y_predsktime 兼容数据容器格式的时间序列
- 用于预测的外生时间序列。如果传递,将在 predict 中使用而不是 X。应与 fit 中的 y 具有相同的 scitype(
-
用于预测的外生时间序列。应与 fit 中的 y 具有相同的 scitype(
Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
为 True,则 X.index 必须包含 fh 索引引用。 计算/返回预测区间预测。
predict_interval(fh=None, X=None, coverage=0.9)[source]#
要求状态为“已拟合”,即
self.is_fitted=True
。访问自身
以“_”结尾的拟合模型属性。
- 将状态更改为“已拟合”。
self.cutoff
,self.is_fitted
- 参数:
- 有关数据格式的更多详细信息,请参阅 mtype 的词汇表。有关用法,请参阅预测教程
examples/01_forecasting.ipynb
。 如果
fh
被传递且之前未传递,则将fh
存储到self.fh
。如果
coverage
是可迭代的,将计算多个区间。如果
fh
不为 None 且不是ForecastingHorizon
类型,则在内部将其强制转换为ForecastingHorizon
(通过_check_fh
)。如果
fh
是 int 或 int 的数组类型,则解释为相对范围,并强制转换为相对ForecastingHorizon(fh, is_relative=True)
。
- 预测范围编码了要预测的时间戳。如果已在 fit 中传递,则不应再传递。如果未在 fit 中传递,则必须传递,不可选。
Xsktime 兼容格式的时间序列,可选(默认为 None)
- 如果
fh
是 pd.Index 类型,则解释为绝对范围,并强制转换为绝对ForecastingHorizon(fh, is_relative=False)
。 coverage浮点数或唯一浮点值列表,可选(默认为 0.90)
- 有关数据格式的更多详细信息,请参阅 mtype 的词汇表。有关用法,请参阅预测教程
- 返回:
- 预测区间(s) 的名义覆盖率
- pred_intpd.DataFrame
- 列具有多级索引:第一级是 fit 中 y 的变量名,
第二级是计算区间的覆盖率分数。
与输入
coverage
的顺序相同。- 第三级是字符串“lower”或“upper”,表示区间下限/上限。
行索引是 fh,附加(上层)级别等于 fit 中 y 看到的实例级别,
- 如果 fit 中看到的 y 是 Panel 或 Hierarchical 类型。
条目是区间下限/上限的预测值,
- 对于列索引中的变量,在第二个列索引中的名义覆盖率下,根据第三个列索引表示下限/上限,对应于行索引。区间上限/下限预测等效于在 alpha = 0.5 - c/2, 0.5 + c/2(对于 coverage 中的 c)处的分位数预测。
计算/返回完整的概率预测。
predict_proba(fh=None, X=None, marginal=True)[source]#
注意
当前仅对 Series(非面板、非分层)y 实现。
要求状态为“已拟合”,即
self.is_fitted=True
。访问自身
以“_”结尾的拟合模型属性。
- 将状态更改为“已拟合”。
self.cutoff
,self.is_fitted
- 参数:
- 有关数据格式的更多详细信息,请参阅 mtype 的词汇表。有关用法,请参阅预测教程
examples/01_forecasting.ipynb
。 如果
fh
被传递且之前未传递,则将fh
存储到self.fh
。如果
coverage
是可迭代的,将计算多个区间。如果
fh
不为 None 且不是ForecastingHorizon
类型,则在内部将其强制转换为ForecastingHorizon
(通过_check_fh
)。如果
fh
是 int 或 int 的数组类型,则解释为相对范围,并强制转换为相对ForecastingHorizon(fh, is_relative=True)
。
- 预测范围编码了要预测的时间戳。如果已在 fit 中传递,则不应再传递。如果未在 fit 中传递,则必须传递,不可选。
Xsktime 兼容格式的时间序列,可选(默认为 None)
- 返回的分布对象需要安装
skpro
。 marginal布尔值,可选(默认为 True)
- 有关数据格式的更多详细信息,请参阅 mtype 的词汇表。有关用法,请参阅预测教程
- 返回:
- 返回的分布是否按时间索引是边际的
pred_distskpro BaseDistribution
- 如果 marginal=True,则为预测分布,按时间点是边际分布;如果 marginal=False 且方法已实现,则为联合分布。
计算/返回分位数预测。
predict_quantiles(fh=None, X=None, alpha=None)[source]#
要求状态为“已拟合”,即
self.is_fitted=True
。访问自身
以“_”结尾的拟合模型属性。
- 将状态更改为“已拟合”。
self.cutoff
,self.is_fitted
- 参数:
- 有关数据格式的更多详细信息,请参阅 mtype 的词汇表。有关用法,请参阅预测教程
examples/01_forecasting.ipynb
。 如果
fh
被传递且之前未传递,则将fh
存储到self.fh
。如果
coverage
是可迭代的,将计算多个区间。如果
fh
不为 None 且不是ForecastingHorizon
类型,则在内部将其强制转换为ForecastingHorizon
(通过_check_fh
)。如果
fh
是 int 或 int 的数组类型,则解释为相对范围,并强制转换为相对ForecastingHorizon(fh, is_relative=True)
。
- 预测范围编码了要预测的时间戳。如果已在 fit 中传递,则不应再传递。如果未在 fit 中传递,则必须传递,不可选。
Xsktime 兼容格式的时间序列,可选(默认为 None)
- alpha浮点数或唯一值的浮点数列表,可选 (默认=[0.05, 0.95])
计算分位数预测的概率或概率列表。
- 有关数据格式的更多详细信息,请参阅 mtype 的词汇表。有关用法,请参阅预测教程
- 返回:
- quantilespd.DataFrame
- pred_intpd.DataFrame
第二层是传递给函数的值 alpha。
- 第三级是字符串“lower”或“upper”,表示区间下限/上限。
行索引是 fh,附加(上层)级别等于 fit 中 y 看到的实例级别,
- 条目是分位数预测,针对列索引中的 var,
在第二列索引中的分位数概率处,针对行索引。
- predict_residuals(y=None, X=None)[source]#
返回时间序列预测的残差。
残差将针对 y.index 处的预测进行计算。
如果 fh 必须在 fit 中传入,则必须与 y.index 一致。如果 y 是一个 np.ndarray,并且在 fit 中没有传入 fh,则残差将根据范围 range(len(y.shape[0])) 的 fh 进行计算。
- get_fitted_params(deep=True)[source]#
要求状态为“已拟合”。如果已设置 fh,则必须与 y 的索引(pandas 或整数)对应。
- 要求状态为“已拟合”,即
self.is_fitted=True
。 以“_”结尾的已拟合模型属性。self.cutoff, self._is_fitted
- 将状态更改为“已拟合”。
无。
- 参数:
- 将
fh
存储到self.fh
。 包含真实观测值的时间序列,用于计算残差。必须具有与 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_res
sktime
兼容数据容器格式的时间序列 在
fh
处的预测残差,与fh
具有相同的索引。y_res
的类型与最近传入的y
相同:Series
、Panel
、Hierarchical
scitype,格式相同(见上文)。
- y_res
- predict_var(fh=None, X=None, cov=False)[source]#
计算/返回方差预测。
要求状态为“已拟合”,即
self.is_fitted=True
。访问自身
以“_”结尾的拟合模型属性。
- 将状态更改为“已拟合”。
self.cutoff
,self.is_fitted
- 参数:
- 有关数据格式的更多详细信息,请参阅 mtype 的词汇表。有关用法,请参阅预测教程
examples/01_forecasting.ipynb
。 如果
fh
被传递且之前未传递,则将fh
存储到self.fh
。如果
coverage
是可迭代的,将计算多个区间。如果
fh
不为 None 且不是ForecastingHorizon
类型,则在内部将其强制转换为ForecastingHorizon
(通过_check_fh
)。如果
fh
是 int 或 int 的数组类型,则解释为相对范围,并强制转换为相对ForecastingHorizon(fh, is_relative=True)
。
- 预测范围编码了要预测的时间戳。如果已在 fit 中传递,则不应再传递。如果未在 fit 中传递,则必须传递,不可选。
Xsktime 兼容格式的时间序列,可选(默认为 None)
- covbool,可选 (默认=False)
如果为 True,计算协方差矩阵预测。如果为 False,计算边际方差预测。
- 有关数据格式的更多详细信息,请参阅 mtype 的词汇表。有关用法,请参阅预测教程
- 返回:
- pred_varpd.DataFrame,格式取决于
cov
变量 - 如果 cov=False
- 列名与在
fit
/update
中传入的y
完全相同。 对于无名称格式,列索引将是 RangeIndex。
- 行索引为 fh,附加级别等于实例级别,
行索引是 fh,附加(上层)级别等于 fit 中 y 看到的实例级别,
条目为方差预测,针对列索引中的 var。给定变量和 fh 索引的方差预测是预测得到的
该变量和索引的方差,给定观测数据。
- 列名与在
- 如果 cov=True
- 列索引是多级索引:第一级是变量名(如上)
第二级是 fh。
- 行索引为 fh,附加级别等于实例级别,
行索引是 fh,附加(上层)级别等于 fit 中 y 看到的实例级别,
- 条目为(协)方差预测,针对列索引中的 var,以及
行索引和列索引中时间索引之间的协方差。
注意:不会返回不同变量之间的协方差预测。
- pred_varpd.DataFrame,格式取决于
- reset()[source]#
将对象重置到干净的初始化后状态。
将
self
重置为构造函数调用后直接拥有的状态,并保留相同的超参数。set_config
设置的配置值也会保留。调用
reset
会删除所有对象属性,除了超参数 = 写入
self
的__init__
参数,例如,如果paramname
是__init__
的参数,则为self.paramname
。包含双下划线的对象属性,即字符串“__”。例如,名为“__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”,则会在当前工作目录 (cwd) 创建一个 zip 文件
estimator.zip
。path=”/home/stored/estimator”,则会在
/home/stored/
中存储一个 zip 文件estimator.zip
。
存储在
/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)
用于评分的时间序列
- 有关数据格式的更多详细信息,请参阅 mtype 的词汇表。有关用法,请参阅预测教程
examples/01_forecasting.ipynb
。 fhint, list, 可强制转换为 pd.Index, 或
ForecastingHorizon
(不可选)- 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 损失。
- set_config(**config_dict)[source]#
将配置标志设置为给定值。
- 参数:
- 配置在
clone
或reset
调用下会被保留。 配置名称:配置值对的字典。有效的配置、值及其含义如下所示
- displaystr,“diagram”(默认),或“text”
jupyter kernel 如何显示 self 的实例
“diagram” = html 框图表示
“text” = 字符串打印输出
- print_changed_onlybool,默认=True
打印 self 时是否只列出与默认值不同的 self 参数(True),还是所有参数名称和值(False)。不包含嵌套,即只影响 self,不影响组件估计器。
- warningsstr,“on”(默认),或“off”
是否触发警告,仅影响来自 sktime 的警告
“on” = 将触发来自 sktime 的警告
“off” = 将不触发来自 sktime 的警告
- backend:parallelstr,可选,默认=”None”
在广播/向量化时用于并行化的后端,选项之一:
“None”:顺序执行循环,简单的列表推导式
“loky”、“multiprocessing” 和 “threading”:使用
joblib.Parallel
“joblib”:自定义和第三方
joblib
后端,例如spark
“dask”:使用
dask
,需要在环境中安装dask
包“ray”:使用
ray
,需要在环境中安装ray
包
- backend:parallel:paramsdict,可选,默认={}(未传递参数)
作为配置传递给并行化后端的附加参数。有效键取决于
backend:parallel
的值“None”:无附加参数,
backend_params
被忽略“loky”、“multiprocessing” 和 “threading”:默认的
joblib
后端。此处可以传入joblib.Parallel
的任何有效键,例如n_jobs
,但backend
除外,它直接由backend
控制。如果未传入n_jobs
,它将默认为-1
,其他参数将默认为joblib
的默认值。“joblib”:自定义和第三方
joblib
后端,例如spark
。此处可以传入joblib.Parallel
的任何有效键,例如n_jobs
。在这种情况下,backend
必须作为backend_params
的键传入。如果未传入n_jobs
,它将默认为-1
,其他参数将默认为joblib
的默认值。“dask”:可以传入
dask.compute
的任何有效键,例如scheduler
“ray”:可以传入以下键
“ray_remote_args”:
ray.init
有效键的字典- “shutdown_ray”:bool,默认=True;False 可防止
ray
在并行化后 关闭。
- “shutdown_ray”:bool,默认=True;False 可防止
“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对自身的引用。
注意
改变对象状态,将 config_dict 中的配置复制到 self._config_dynamic。
- set_params(**params)[source]#
设置此对象的参数。
该方法适用于简单的 skbase 对象以及复合对象。参数键字符串
<component>__<parameter>
可用于复合对象(即包含其他对象的对象),以访问组件<component>
中的<parameter>
。如果在不使用<component>__
前缀的情况下能明确引用,例如,没有两个组件参数名称都为<parameter>
,则也可以直接使用字符串<parameter>
。- 参数:
- **paramsdict
BaseObject 参数,键必须是
<component>__<parameter>
字符串。如果后缀__
在 get_params 键中唯一,则可以作为完整字符串的别名。
- 返回:
- self对自身的引用(设置参数后)
- set_random_state(random_state=None, deep=True, self_policy='copy')[source]#
为自身设置 random_state 伪随机种子参数。
通过
self.get_params
查找名为random_state
的参数,并通过set_params
将它们设置为从random_state
派生的整数。这些整数通过sample_dependent_seed
的链式哈希采样,确保 seeded 随机生成器具有伪随机独立性。根据
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 可在多次函数调用中获得可复现的输出。
- 要求状态为“已拟合”。
是否设置 skbase 对象值参数(即组件估计器)中的随机状态。
如果为 False,则仅设置
self
的random_state
参数(如果存在)。如果为 True,则也会设置组件对象中的
random_state
参数。
- self_policystr,{“copy”, “keep”, “new”} 之一,默认=”copy”
“copy”:
self.random_state
设置为输入的random_state
“keep”:
self.random_state
保持不变“new”:
self.random_state
设置为一个新的随机状态,
源自输入的
random_state
,并且通常与它不同。
- 返回:
- self对自身的引用
- set_tags(**tag_dict)[source]#
将实例级别标签覆盖设置为给定值。
classmethod get_class_tag(tag_name, tag_value_default=None)[source]#
标签是特定于实例
self
的键值对,它们是静态标志,在对象构造后不会更改。它们可用于元数据检查或控制对象的行为。set_tags
将动态标签覆盖设置为tag_dict
中指定的值,其中键是标签名称,字典值是要将标签设置为什么值。set_tags
方法只能在对象的__init__
方法中、构造期间或通过__init__
直接构造后调用。可以通过
get_tags
或get_tag
检查当前的标签值。- 参数:
- **tag_dictdict
标签名称:标签值对的字典。
- 返回:
- Self
对自身的引用。
- update(y, X=None, update_params=True)[source]#
更新截止点值,并可选择更新已拟合的参数。
如果未实现特定于估计器的更新方法,默认回退如下:
update_params=True
:拟合到目前为止所有观测到的数据update_params=False
:仅更新 cutoff 并记住数据
要求状态为“已拟合”,即
self.is_fitted=True
。访问自身
以“_”结尾的拟合模型属性。
将状态更改为“已拟合”。
将
self.cutoff
更新为在y
中看到的最新索引。如果
update_params=True
,则更新以“_”结尾的已拟合模型属性。
- 参数:
- 如果
fh
被传递,则将fh
存储到self.fh
。 用于更新预测器的时间序列。
用于拟合预测器的时间序列。
Series
scitype = 单个时间序列,普通预测。pd.DataFrame
,pd.Series
, 或np.ndarray
(1D 或 2D)Panel
scitype = 时间序列集合,全局/面板预测。具有 2 级行MultiIndex
(实例, 时间)
的pd.DataFrame
,3D np.ndarray
(实例, 变量, 时间)
,Series
类型的pd.DataFrame
列表。
Hierarchical
scitype = 分层集合,用于分层预测。具有 3 级或更多行MultiIndex
(层次结构_1, ..., 层次结构_n, 时间)
的pd.DataFrame
。- 预测范围编码了要预测的时间戳。如果
self.get_tag("requires-fh-in-fit")
为True
,则必须在fit
中传递,不可选。 用于更新模型拟合的外生时间序列。应与
y
具有相同的 scitype(Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
为 True,则X.index
必须包含y.index
。- update_paramsbool,可选 (默认=True)
是否应更新模型参数。如果为
False
,则仅更新 cutoff,模型参数(例如系数)不更新。
- 如果
- 返回:
- self对自身的引用
- update_predict(y, cv=None, X=None, update_params=True, reset_forecaster=True)[source]#
在测试集上迭代进行预测和更新模型。
此方法是执行多个
update
/predict
的链式调用的简写,数据回放基于时间分割器cv
。与以下代码等效(如果只有
y
、cv
非默认值)self.update(y=cv.split_series(y)[0][0])
记住
self.predict()
(稍后在单个批次中返回)self.update(y=cv.split_series(y)[1][0])
记住
self.predict()
(稍后在单个批次中返回)等等
返回所有记住的预测
如果未实现特定于估计器的更新方法,默认回退如下:
update_params=True
:拟合到目前为止所有观测到的数据update_params=False
:仅更新 cutoff 并记住数据
要求状态为“已拟合”,即
self.is_fitted=True
。访问自身
以“_”结尾的拟合模型属性。
- 写入 self(除非
reset_forecaster=True
) 将
self.cutoff
更新为在y
中看到的最新索引。如果
update_params=True
,则更新以“_”结尾的已拟合模型属性。
如果
reset_forecaster=True
,则不更新状态。- 参数:
- 如果
fh
被传递,则将fh
存储到self.fh
。 用于更新预测器的时间序列。
用于拟合预测器的时间序列。
Series
scitype = 单个时间序列,普通预测。pd.DataFrame
,pd.Series
, 或np.ndarray
(1D 或 2D)Panel
scitype = 时间序列集合,全局/面板预测。具有 2 级行MultiIndex
(实例, 时间)
的pd.DataFrame
,3D np.ndarray
(实例, 变量, 时间)
,Series
类型的pd.DataFrame
列表。
Hierarchical
scitype = 分层集合,用于分层预测。具有 3 级或更多行MultiIndex
(层次结构_1, ..., 层次结构_n, 时间)
的pd.DataFrame
。- cv继承自 BaseSplitter 的时间序列交叉验证生成器,可选
例如,
SlidingWindowSplitter
或ExpandingWindowSplitter
;默认 = initial_window=1 的 ExpandingWindowSplitter,默认 = y/X 中的单个数据点被逐个添加和预测,initial_window = 1
,step_length = 1
,fh = 1
。- Xsktime 兼容格式的时间序列,可选 (默认=None)
用于更新和预测的外生时间序列。应与
fit
中的y
具有相同的 scitype(Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
为 True,则X.index
必须包含fh
索引引用。- update_paramsbool,可选 (默认=True)
是否应更新模型参数。如果为
False
,则仅更新 cutoff,模型参数(例如系数)不更新。- reset_forecasterbool,可选 (默认=True)
如果为 True,则不会改变预测器的状态,即 update/predict 序列是使用副本运行的,self 的 cutoff、模型参数、数据内存不会改变
如果为 False,则在运行 update/predict 序列时会更新 self,就像直接调用 update/predict 一样
- 如果
- 返回:
- y_pred一个对象,以表格形式呈现来自多个分割批次的点预测
格式取决于预测整体的 (cutoff, absolute horizon) 对
如果 absolute horizon 点的集合是唯一的:类型为 sktime 兼容数据容器格式的时间序列,输出中抑制了 cutoff,与最近传入的 y 具有相同的类型:Series、Panel、Hierarchical scitype,格式相同(见上文)
如果 absolute horizon 点的集合不唯一:类型为 pandas DataFrame,行和列索引为时间戳,行索引对应于预测的 cutoff,列索引对应于预测的 absolute horizon,条目是根据行索引预测的列索引的点预测,如果在该 (cutoff, horizon) 对没有进行预测,则条目为 nan
- update_predict_single(y=None, fh=None, X=None, update_params=True)[source]#
使用新数据更新模型并进行预测。
此方法有助于在一个步骤中进行更新和预测。
如果未实现特定于估计器的更新方法,默认回退是先更新,然后预测。
- get_fitted_params(deep=True)[source]#
必需状态
- 要求状态为“已拟合”,即
self.is_fitted=True
。 以“_”结尾的已拟合模型属性。指向已见数据的指针,self._y 和 self.X self.cutoff, self._is_fitted 如果 update_params=True,以“_”结尾的模型属性。
- 将状态更改为“已拟合”。
通过追加行来更新 self._y 和 self._X,使用
y
和X
。将 self.cutoff 和 self._cutoff 更新为在y
中看到的最新索引。如果 update_params=True,更新以“_”结尾的已拟合模型属性。
- 参数:
- 如果
fh
被传递,则将fh
存储到self.fh
。 用于更新预测器的时间序列。
用于拟合预测器的时间序列。
Series
scitype = 单个时间序列,普通预测。pd.DataFrame
,pd.Series
, 或np.ndarray
(1D 或 2D)Panel
scitype = 时间序列集合,全局/面板预测。具有 2 级行MultiIndex
(实例, 时间)
的pd.DataFrame
,3D np.ndarray
(实例, 变量, 时间)
,Series
类型的pd.DataFrame
列表。
Hierarchical
scitype = 分层集合,用于分层预测。具有 3 级或更多行MultiIndex
(层次结构_1, ..., 层次结构_n, 时间)
的pd.DataFrame
。- 有关数据格式的更多详细信息,请参阅 mtype 的词汇表。有关用法,请参阅预测教程
examples/01_forecasting.ipynb
。 如果
fh
被传递且之前未传递,则将fh
存储到self.fh
。- Xsktime 兼容格式的时间序列,可选 (默认=None)
用于更新和预测的外生时间序列。应与
fit
中的y
具有相同的 scitype(Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
为 True,则X.index
必须包含fh
索引引用。- update_paramsbool,可选 (默认=True)
是否应更新模型参数。如果为
False
,则仅更新 cutoff,模型参数(例如系数)不更新。
- 如果
- 返回:
- 用于预测的外生时间序列。如果传递,将在 predict 中使用而不是 X。应与 fit 中的 y 具有相同的 scitype(
Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
为 True,则 X.index 必须包含 fh 索引引用。 y_predsktime 兼容数据容器格式的时间序列
- 用于预测的外生时间序列。如果传递,将在 predict 中使用而不是 X。应与 fit 中的 y 具有相同的 scitype(
- classmethod get_test_params(parameter_set='default')[source]#
返回评估器的测试参数设置。
- 参数:
- parameter_set字符串,默认为“default”
要返回的测试参数集的名称,用于测试。如果某个值没有定义特殊参数,将返回
"default"
集。目前预测器没有保留值。
- 返回:
- paramsdict 或 dict 列表,默认 = {}
用于创建类的测试实例的参数。每个 dict 都是构造一个“有趣的”测试实例的参数,即
MyClass(**params)
或MyClass(**params[i])
创建一个有效的测试实例。create_test_instance
使用params
中的第一个(或唯一一个)字典。