季节性ACF#
- class SeasonalityACF(candidate_sp=None, p_threshold=0.05, adjusted=False, nlags=None, fft=True, missing='none')[source]#
使用自相关函数 CI 查找候选季节性参数。
使用
statsmodels.tsa.stattools.act
计算自相关函数,并使用其测试功能确定候选季节性参数。(“季节性参数”是整数滞后,下面缩写为 sp)在给定的显著性水平下获得置信区间,并返回具有显著正自相关的滞后,按置信下限排序。
- 注意:这应应用于平稳序列。
通过差分可以快速实现平稳性转换。另请参见:Differencer
- 参数:
- candidate_spNone、int 或 int 列表,可选,默认 = None
要测试的候选 sp,以及限制测试范围;整数必须大于或等于 2;如果为 None,将测试介于 2 和
nlags
之间的所有整数滞后(包含边界)- p_threshold浮点数,可选,默认=0.05
用于季节性测试的显著性阈值
- adjusted布尔值,可选,默认=False
如果为 True,则自协方差的分母为 n-k,否则为 n。
- nlags整数,可选,默认=None
要计算自相关并从中选择的滞后数。默认 None 时,使用
min(10 * np.log10(nobs), nobs - 1)
。如果提供了candidate_sp
,则此参数将被忽略。- fft布尔值,可选,默认=True
如果为 True,则通过 FFT 计算 ACF。
- missing字符串,[“none”, “raise”, “conservative”, “drop”] 之一,可选,默认=”none”
指定如何处理 NaN 值。“none” 不执行任何检查。“raise” 如果发现 NaN 值则抛出异常。“drop” 移除缺失观测值并视非缺失观测值为连续。“conservative” 使用 nan-ops 计算自协方差,以便在计算用于估计自协方差的均值和交叉乘积时移除 nan 值。
使用“conservative”时,n 设置为非缺失观测值的数量。
- 属性:
- sp_整数,p 值最低的季节性周期,如果存在低于阈值的情况,否则为 1
如果传递了
candidate_sp
,则结果将在candidate_sp
或 1 中- sp_significant_整数列表,p 值低于阈值的季节性周期
按 p 值递增排序。如果都没有低于阈值,则为空列表,而不是 [1]
示例
>>> from sktime.datasets import load_airline >>> from sktime.param_est.seasonality import SeasonalityACF >>> >>> X = load_airline().diff()[1:] >>> sp_est = SeasonalityACF() >>> sp_est.fit(X) SeasonalityACF(...) >>> sp_est.get_fitted_params()["sp"] 12 >>> sp_est.get_fitted_params()["sp_significant"] array([12, 11])
在应用 ACF 之前,序列应该是平稳的。要将 SeasonalityACF 与 Differencer 构建流水线,请使用 ParamFitterPipeline
>>> from sktime.datasets import load_airline >>> from sktime.param_est.seasonality import SeasonalityACF >>> from sktime.transformations.series.difference import Differencer >>> >>> X = load_airline() >>> sp_est = Differencer() * SeasonalityACF() >>> sp_est.fit(X) ParamFitterPipeline(...) >>> sp_est.get_fitted_params()["sp"] 12 >>> sp_est.get_fitted_params()["sp_significant"] array([12, 11])
方法
check_is_fitted
([method_name])检查估计器是否已拟合。
克隆
()获取一个具有相同超参数和配置的对象克隆。
clone_tags
(estimator[, tag_names])从另一个对象克隆标签作为动态覆盖。
create_test_instance
([parameter_set])使用第一个测试参数集构造类的实例。
create_test_instances_and_names
([parameter_set])创建所有测试实例列表及其名称列表。
fit
(X[, y])拟合估计器并估计参数。
get_class_tag
(tag_name[, tag_value_default])从类中获取类标签值,包含来自父类的标签级别继承。
获取类标签
()从类中获取类标签,包含来自父类的标签级别继承。
获取配置
()获取自身的配置标志。
get_fitted_params
([deep])获取已拟合的参数。
获取参数默认值
()获取对象的参数默认值。
get_param_names
([sort])获取对象的参数名称。
get_params
([deep])获取此对象的参数值字典。
get_tag
(tag_name[, tag_value_default, ...])从实例获取标签值,包含标签级别继承和覆盖。
获取标签
()从实例获取标签,包含标签级别继承和覆盖。
get_test_params
([parameter_set])返回估计器的测试参数设置。
是否为复合对象
()检查对象是否由其他 BaseObject 组成。
load_from_path
(serial)从文件位置加载对象。
load_from_serial
(serial)从序列化内存容器加载对象。
重置
()将对象重置为干净的初始化后状态。
save
([path, serialization_format])将序列化的自身保存为字节类对象或保存到 (.zip) 文件。
set_config
(**config_dict)将配置标志设置为给定值。
set_params
(**params)设置此对象的参数。
set_random_state
([random_state, deep, ...])为自身设置 random_state 伪随机种子参数。
set_tags
(**tag_dict)将实例级别的标签覆盖设置为给定值。
update
(X[, y])在更多数据上更新拟合参数。
- classmethod get_test_params(parameter_set='default')[source]#
返回估计器的测试参数设置。
- 参数:
- parameter_set字符串,默认=”default”
返回的测试参数集的名称,用于测试。如果未为某个值定义特殊参数,则将返回
"default"
集。当前没有为转换器保留的值。
- 返回值:
- params字典或字典列表,默认 = {}
用于创建类测试实例的参数。每个字典都是用于构造“有趣”测试实例的参数,例如
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_name字符串,可选
调用此方法的名称。如果提供,错误消息将包含此信息。
- 抛出异常:
- 未拟合错误
如果估计器尚未拟合。
- clone()[source]#
获取一个具有相同超参数和配置的对象克隆。
克隆是另一个没有共享引用且处于初始化后状态的对象。此函数等效于返回
sklearn.clone
的self
。等效于构造一个新的
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_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 个元素是测试中第 i 个 obj 实例的名称。如果实例多于一个,命名约定为
{cls.__name__}-{i}
,否则为{cls.__name__}
。
- fit(X, y=None)[source]#
拟合估计器并估计参数。
- 状态变化
将状态更改为“fitted”(已拟合)。
- 写入自身
将 self._is_fitted 标志设置为 True。将 X 写入 self._X。如果 y 不为 None,则将 y 写入 self._y。设置以 “_” 结尾的拟合模型属性。
- 参数:
- X
sktime
兼容数据容器格式的时间序列。 用于拟合参数估计器的时间序列。
sktime
中的单个数据格式是所谓的 mtype 规范,每个 mtype 实现一个抽象 scitype。Series
scitype = 单个时间序列,普通预测。pd.DataFrame
,pd.Series
, 或np.ndarray
(1D 或 2D)Panel
scitype = 时间序列集合,全局/面板预测。pd.DataFrame
带有 2 级行MultiIndex
(实例, 时间)
,3D np.ndarray
(实例, 变量, 时间)
,list
类型的pd.DataFrame
,其中包含Series
类型数据。Hierarchical
scitype = 分层集合,用于分层预测。pd.DataFrame
带有 3 个或更多级别行MultiIndex
(层级_1, ..., 层级_n, 时间)
。
估计器是否支持面板数据或分层数据由 scitype 标签
scitype:X
和scitype:y
决定。有关数据格式的更多详细信息,请参阅 mtype 术语表。
- y
sktime
兼容数据容器格式的时间序列。 用于拟合参数估计器的第二个时间序列。
仅当估计器是成对估计器(即标签
capability:pairwise
为 True)时才需要。否则输入将被忽略,并且不会抛出异常。
- X
- 返回值:
- self对自身的引用。
- 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任意类型
如果找不到标签,则使用默认/回退值。
- 返回值:
- 标签值
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_tags字典
标签名称 : 标签值对的字典。通过嵌套继承从
_tags
类属性收集。不会被通过set_tags
或clone_tags
设置的动态标签覆盖。
- get_config()[source]#
获取自身的配置标志。
配置是
self
的键值对,通常用作控制行为的瞬时标志。get_config
返回动态配置,这些配置会覆盖默认配置。默认配置设置在类或其父类的类属性
_config
中,并通过set_config
设置的动态配置进行覆盖。配置在
clone
或reset
调用下保留。- 返回值:
- config_dict字典
配置名称 : 配置值对的字典。通过嵌套继承从 _config 类属性收集,然后是 _onfig_dynamic 对象属性中的任何覆盖和新标签。
- get_fitted_params(deep=True)[source]#
获取已拟合的参数。
- 需要状态
需要状态为“fitted”(已拟合)。
- 参数:
- deep布尔值,默认=True
是否返回组件的拟合参数。
如果为 True,则将返回此对象的参数名称: 值字典,包括可拟合组件(= BaseEstimator 值的参数)的拟合参数。
如果为 False,则将返回此对象的参数名称: 值字典,但不包括组件的拟合参数。
- 返回值:
- fitted_params键为字符串的字典
拟合参数字典,paramname : paramvalue 键值对包括
始终:此对象的所有拟合参数,通过
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键为字符串的字典
参数字典,paramname : paramvalue 键值对包括
始终:此对象的所有参数,通过
get_param_names
获取,值为此对象该键的参数值,这些值始终与构造时传递的值相同。如果
deep=True
,也包含组件参数的键值对,组件的参数索引为[componentname]__[paramname]
,componentname
的所有参数都以paramname
及其值出现如果
deep=True
,还包含任意级别的组件递归,例如[componentname]__[componentcomponentname]__[paramname]
等。
- get_tag(tag_name, tag_value_default=None, raise_error=True)[source]#
从实例获取标签值,包含标签级别继承和覆盖。
每个
scikit-base
兼容对象都有一个标签字典。标签可用于存储关于对象的元数据,或控制对象的行为。标签是特定于实例
self
的键值对,它们是对象构造后不会改变的静态标志。get_tag
方法从实例中检索名称为tag_name
的单个标签值,考虑标签覆盖,优先级按以下降序排列:在实例上通过
set_tags
或clone_tags
设置的标签,
在实例构造时。
在类的
_tags
属性中设置的标签。在父类的
_tags
属性中设置的标签,
按继承顺序排列。
- 参数:
- tag_name字符串
要检索的标签名称
- 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_tags字典
标签名称 : 标签值对的字典。通过嵌套继承从
_tags
类属性收集,然后是_tags_dynamic
对象属性中的任何覆盖和新标签。
- is_composite()[source]#
检查对象是否由其他 BaseObject 组成。
复合对象是包含其他对象作为参数的对象。在实例上调用,因为这可能因实例而异。
- 返回值:
- composite: 布尔值
对象的任何参数的值是否为
BaseObject
的后代实例。
- property is_fitted[source]#
fit
是否已被调用。检查对象的
_is_fitted` 属性,该属性在对象构造期间应初始化为 ``False
,并在调用对象的 fit 方法时设置为 True。- 返回值:
- 布尔值
估计器是否已被 fit(拟合)。
- classmethod load_from_path(serial)[source]#
从文件位置加载对象。
- 参数:
- serialZipFile(path).open(“object) 的结果
- 返回值:
- 反序列化的自身,结果输出到
path
,对应cls.save(path)
的输出
- 反序列化的自身,结果输出到
- classmethod load_from_serial(serial)[source]#
从序列化内存容器加载对象。
- 参数:
- serial
cls.save(None)
输出的第一个元素
- serial
- 返回值:
- 反序列化的自身,结果输出为
serial
,对应cls.save(None)
的输出
- 反序列化的自身,结果输出为
- 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))`` 后获得的对象。- 返回值:
- 自身
类实例重置为干净的初始化后状态,但保留当前的超参数值。
- save(path=None, serialization_format='pickle')[source]#
将序列化的自身保存为字节类对象或保存到 (.zip) 文件。
行为:如果
path
为 None,则返回内存中的序列化自身;如果path
是文件位置,则将自身存储在该位置作为 zip 文件。保存的文件是 zip 文件,包含以下内容: _metadata - 包含自身所在的类,即 type(self) _obj - 序列化的自身。此类使用默认序列化方式 (pickle)。
- 参数:
- pathNone 或文件位置(字符串或 Path 对象)
如果为 None,则将自身保存到内存对象中;如果是文件位置,则将自身保存到该文件位置。如果
path=”estimator”,则会在当前工作目录创建 zip 文件
estimator.zip
。path=”/home/stored/estimator”,则会在
/home/stored/
中创建 zip 文件estimator.zip
。
存储在
/home/stored/
中。- serialization_format: 字符串,默认 = “pickle”
用于序列化的模块。可用选项为“pickle”和“cloudpickle”。请注意,非默认格式可能需要安装其他软依赖项。
- 返回值:
- 如果
path
为 None - 内存中的序列化自身 - 如果
path
是文件位置 - 带有文件引用的 ZipFile
- 如果
- set_config(**config_dict)[source]#
将配置标志设置为给定值。
- 参数:
- config_dict字典
配置名称 : 配置值对的字典。有效的配置、值及其含义如下所示
- display字符串,“diagram”(默认)或“text”
jupyter 内核如何显示自身的实例
“diagram” = html 框图表示
“text” = 字符串打印输出
- print_changed_only布尔值,默认=True
打印自身时是否只列出与默认值不同的自身参数(False),还是列出所有参数名称和值(False)。不嵌套,即仅影响自身,不影响组件估计器。
- warnings字符串,“on”(默认)或“off”
是否发出警告,仅影响 sktime 的警告
“on” = 将发出来自 sktime 的警告
“off” = 将不会发出来自 sktime 的警告
- backend:parallel字符串,可选,默认=”None”
广播/向量化时用于并行化的后端,以下之一:
“None”: 按顺序执行循环,简单的列表推导
“loky”, “multiprocessing” 和 “threading”: 使用
joblib.Parallel
“joblib”: 自定义和第三方
joblib
后端,例如spark
“dask”: 使用
dask
,需要环境中安装dask
包“ray”: 使用
ray
,需要环境中安装ray
包
- backend:parallel:params字典,可选,默认={}(未传递参数)
作为配置传递给并行化后端的附加参数。有效键取决于
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
在并行化后 关闭。
- “shutdown_ray”: 布尔值,默认=True;False 阻止
“logger_name”: 字符串,默认=”ray”;要使用的日志记录器名称。
“mute_warnings”: 布尔值,默认=False;如果为 True,则抑制警告
- 返回值:
- self对自身的引用。
注意
改变对象状态,将 config_dict 中的配置复制到 self._config_dynamic。
- set_params(**params)[source]#
设置此对象的参数。
该方法适用于简单的 skbase 对象和复合对象。参数键字符串
<component>__<parameter>
可用于复合对象(即包含其他对象的对象),以访问组件<component>
中的<parameter>
。如果引用明确,也可以使用不带<component>__
的字符串<parameter>
,例如,没有两个组件的参数名称相同。- 参数:
- **params字典
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
通过链式哈希采样,并保证有种子随机生成器的伪随机独立性。根据
self_policy
,适用于self
中的random_state
参数,且仅当deep=True
时适用于剩余组件对象。注意:即使
self
没有random_state
参数,或者所有组件都没有random_state
参数,也会调用set_params
。因此,set_random_state
会重置任何scikit-base
对象,即使那些没有random_state
参数的对象也是如此。- 参数:
- random_state整数,RandomState 实例或 None,默认=None
控制随机整数生成的伪随机数生成器。传递整数可确保多次函数调用输出可重现。
- deep布尔值,默认=True
是否在 skbase 对象值参数(即组件估计器)中设置随机状态。
如果为 False,则仅设置
self
的random_state
参数(如果存在)。如果为 True,则也会在组件对象中设置
random_state
参数。
- self_policy字符串,{“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]#
将实例级别的标签覆盖设置为给定值。
每个
scikit-base
兼容对象都有一个标签字典,用于存储关于对象的元数据。标签是特定于实例
self
的键值对,它们是对象构造后不会改变的静态标志。它们可用于元数据检查,或控制对象的行为。set_tags
将动态标签覆盖设置为tag_dict
中指定的值,其中键是标签名称,字典值是要将标签设置到的值。set_tags
方法应仅在对象的__init__
方法中调用,即在构造期间或通过__init__
构造之后直接调用。当前标签值可以通过
get_tags
或get_tag
检查。- 参数:
- **tag_dict字典
标签名称 : 标签值对的字典。
- 返回值:
- 自身
对自身的引用。
- update(X, y=None)[source]#
在更多数据上更新拟合参数。
如果没有实现特定于估计器的更新方法,默认回退是拟合目前所有观测到的数据。
- 需要状态
需要状态为“fitted”(已拟合)。
- 自身中访问
以 “_” 结尾的拟合模型属性。指向已见数据的指针,self._X self._is_fitted 模型属性以 “_” 结尾。
- 写入自身
通过附加行来更新 self._X,使用 X。更新以 “_” 结尾的拟合模型属性。
- 参数:
- X
sktime
兼容数据容器格式的时间序列。 用于拟合参数估计器的时间序列。
sktime
中的单个数据格式是所谓的 mtype 规范,每个 mtype 实现一个抽象 scitype。Series
scitype = 单个时间序列,普通预测。pd.DataFrame
,pd.Series
, 或np.ndarray
(1D 或 2D)Panel
scitype = 时间序列集合,全局/面板预测。pd.DataFrame
带有 2 级行MultiIndex
(实例, 时间)
,3D np.ndarray
(实例, 变量, 时间)
,list
类型的pd.DataFrame
,其中包含Series
类型数据。Hierarchical
scitype = 分层集合,用于分层预测。pd.DataFrame
带有 3 个或更多级别行MultiIndex
(层级_1, ..., 层级_n, 时间)
。
估计器是否支持面板数据或分层数据由 scitype 标签
scitype:X
和scitype:y
决定。有关数据格式的更多详细信息,请参阅 mtype 术语表。
- y
sktime
兼容数据容器格式的时间序列。 用于拟合参数估计器的第二个时间序列。
仅当估计器是成对估计器(即标签
capability:pairwise
为 True)时才需要。否则输入将被忽略,并且不会抛出异常。
- X
- 返回值:
- self对自身的引用