FunctionParamFitter#
- class FunctionParamFitter(param, func, kw_args=None, X_type=None)[源码]#
从任意可调用对象构建参数拟合器。
FunctionParamFitter 将其 X 参数转发给用户定义的函数(或可调用对象),并将此函数的结果设置为
param
属性。这对于无状态估计器很有用,例如简单的条件参数选择器。注意:如果使用 lambda 函数作为
func
,则生成的估计器将不可 pickle 化。- 参数:
- paramstr
要设置的参数名称。
- funccallable (X: X_type, **kwargs) -> Any
用于参数估计的可调用对象。这将传递与估计器相同的参数,并转发 args 和 kwargs。
- kw_argsdict, default=None
要传递给 func 的附加关键字参数字典。
- X_typestr, “pd.DataFrame, pd.Series, np.ndarray” 之一,或其列表
default = [“pd.DataFrame”, “pd.Series”, “np.ndarray”] func 假定允许的 X 类型列表(参见上面签名),如果传递给 transform/inverse_transform 的 X 不在此列表中,
它将被转换为列表的第一个元素,然后传递给 funcs
- 属性:
is_fitted
是否已调用
fit
。
另请参阅
sktime.param_est.plugin.PluginParamsForecaster
将参数估计器的参数插入预测器。
sktime.forecasting.compose.MultiplexForecaster
用于在不同模型之间进行选择的 MultiplexForecaster。
示例
此类可用于构建一个参数估计器,该估计器根据输入数据的长度选择预测器。所选预测器可以存储在
selected_forecaster_
属性中,然后通过PluginParamsForecaster
传递给MultiplexForecaster
。>>> import numpy as np >>> from sktime.param_est.compose import FunctionParamFitter >>> param_est = FunctionParamFitter( ... param="selected_forecaster", ... func=( ... lambda X, threshold: "naive-seasonal" ... if len(X) >= threshold ... else "naive-last" ... ), ... kw_args={"threshold": 7}, ... ) >>> param_est.fit(np.asarray([1, 2, 3, 4])) FunctionParamFitter(...) >>> param_est.get_fitted_params() {'selected_forecaster': 'naive-last'} >>> param_est.fit(np.asarray([1, 2, 3, 4, 5, 6, 7])) FunctionParamFitter(...) >>> param_est.get_fitted_params() {'selected_forecaster': 'naive-seasonal'}
完整的条件预测器选择管道可能如下所示
>>> from sktime.forecasting.compose import MultiplexForecaster >>> from sktime.forecasting.naive import NaiveForecaster >>> from sktime.param_est.plugin import PluginParamsForecaster >>> forecaster = PluginParamsForecaster( ... param_est=param_est, ... forecaster=MultiplexForecaster( ... forecasters=[ ... ("naive-last", NaiveForecaster()), ... ("naive-seasonal", NaiveForecaster(sp=7)), ... ] ... ), ... ) >>> forecaster.fit(np.asarray([1, 2, 3, 4])) PluginParamsForecaster(...) >>> forecaster.predict(fh=[1,2,3]) array([[4.], [4.], [4.]]) >>> forecaster.fit(np.asarray([1, 2, 3, 4, 5, 6, 7])) PluginParamsForecaster(...) >>> forecaster.predict(fh=[1,2,3]) array([[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
(X[, y])拟合估计器并估计参数。
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)从序列化内存容器加载对象。
reset
()将对象重置为干净的初始化后状态。
save
([path, serialization_format])将序列化的 self 保存到字节类对象或 (.zip) 文件。
set_config
(**config_dict)将配置标志设置为给定值。
set_params
(**params)设置此对象的参数。
set_random_state
([random_state, deep, ...])为 self 设置 random_state 伪随机种子参数。
set_tags
(**tag_dict)将实例级别标签覆盖设置为给定值。
update
(X[, y])根据更多数据更新拟合参数。
- classmethod get_test_params(parameter_set='default')[源码]#
返回估计器的测试参数设置。
- 参数:
- parameter_setstr, default=”default”
要返回的测试参数集的名称,用于测试。如果未为某个值定义特殊参数,将返回
"default"
集。参数估计器没有保留值。
- 返回:
- paramsdict 或 list of dict, default = {}
用于创建类测试实例的参数 每个字典都是构造一个“有趣”测试实例的参数,即
MyClass(**params)
或MyClass(**params[i])
创建一个有效的测试实例。create_test_instance
使用params
中的第一个(或唯一一个)字典
- check_is_fitted(method_name=None)[源码]#
检查估计器是否已拟合。
检查
_is_fitted
属性是否存在且为True
。is_fitted
属性应在调用对象的fit
方法时设置为True
。如果不是,则抛出
NotFittedError
。- 参数:
- method_namestr, 可选
调用此方法的函数名称。如果提供,错误消息将包含此信息。
- 抛出:
- NotFittedError
如果估计器尚未拟合。
- clone()[源码]#
获取具有相同超参数和配置的对象的克隆。
克隆是另一个没有共享引用、处于初始化后状态的对象。此函数等同于返回
sklearn.clone
的self
。等同于使用
self
的参数构造一个type(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)[源码]#
从另一个对象克隆标签作为动态覆盖。
每个
scikit-base
兼容对象都带有一个标签字典。标签可用于存储有关对象的元数据,或控制对象的行为。标签是特定于实例
self
的键值对,它们是对象构造后不会更改的静态标志。clone_tags
设置来自另一个对象estimator
的动态标签覆盖。clone_tags
方法应仅在对象的__init__
方法中调用,即在构造期间,或在通过__init__
构造后直接调用。动态标签被设置为
estimator
中标签的值,名称在tag_names
中指定。tag_names
的默认值将estimator
中的所有标签写入self
。可以通过
get_tags
或get_tag
检查当前标签值。- 参数:
- estimator:class:BaseObject 或派生类的实例
- tag_namesstr 或 str 列表, default = None
要克隆的标签名称。默认值(
None
)克隆estimator
中的所有标签。
- 返回:
- self
self
的引用。
- classmethod create_test_instance(parameter_set='default')[源码]#
使用第一个测试参数集构造类的实例。
- 参数:
- parameter_setstr, default=”default”
要返回的测试参数集的名称,用于测试。如果未为某个值定义特殊参数,将返回 “default” 集。
- 返回:
- instance具有默认参数的类实例
- classmethod create_test_instances_and_names(parameter_set='default')[源码]#
创建所有测试实例及其名称列表。
- 参数:
- parameter_setstr, default=”default”
要返回的测试参数集的名称,用于测试。如果未为某个值定义特殊参数,将返回 “default” 集。
- 返回:
- objscls 实例列表
第 i 个实例是
cls(**cls.get_test_params()[i])
- namesstr 列表, 长度与 objs 相同
第 i 个元素是测试中第 i 个 obj 实例的名称。如果实例多于一个,命名约定是
{cls.__name__}-{i}
,否则是{cls.__name__}
- fit(X, y=None)[源码]#
拟合估计器并估计参数。
- 状态改变
将状态更改为“已拟合”。
- 写入 self
将 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
(1维或2维)Panel
scitype = 时间序列集合,全局/面板预测。具有2级行MultiIndex
(instance, time)
的pd.DataFrame
,3D np.ndarray
(instance, variable, time)
,或包含 Series 类型pd.DataFrame
的list
Hierarchical
scitype = 分层集合,用于分层预测。具有3级或更多级别行MultiIndex
(hierarchy_1, ..., hierarchy_n, time)
的pd.DataFrame
估计器是否支持面板或分层数据由 scitype 标签
scitype:X
和scitype:y
决定。有关数据格式的更多详情,请参阅词汇表中的 mtype。
- y`sktime` 兼容数据容器格式的时间序列。
用于拟合参数估计器的第二个时间序列。
仅当估计器是成对估计器时才需要,即当标签
capability:pairwise
为 True 时。否则输入将被忽略,并且不会抛出异常。
- 返回:
- 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任意类型
如果未找到标签,则返回的默认/备用值。
- 返回:
- 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_tags字典
标签名称 : 标签值 对的字典。通过嵌套继承从
_tags
类属性中收集。不会被通过set_tags
或clone_tags
设置的动态标签覆盖。
- get_config()[source]#
获取 self 的配置标志。
配置是
self
的键值对,通常用作控制行为的临时标志。get_config
返回动态配置,这些配置会覆盖默认配置。默认配置在类或其父类的类属性
_config
中设置,并会被通过set_config
设置的动态配置覆盖。配置在
clone
或reset
调用中会保留。- 返回:
- config_dict字典
配置名称 : 配置值 对的字典。通过嵌套继承从 _config 类属性中收集,然后从 _config_dynamic 对象属性中收集任何覆盖和新标签。
- get_fitted_params(deep=True)[source]#
获取拟合参数。
- 所需状态
要求状态为“已拟合”(“fitted”)。
- 参数:
- deep布尔类型,默认为 True
是否返回组件的已拟合参数。
如果为 True,将为此对象返回一个参数名称 : 值 的字典,包括可拟合组件(= BaseEstimator 值的参数)的已拟合参数。
如果为 False,将为此对象返回一个参数名称 : 值 的字典,但不包括组件的已拟合参数。
- 返回:
- fitted_params键为字符串类型的字典
已拟合参数的字典,参数名称 : 参数值 键值对包括
总是:此对象的所有已拟合参数,如通过
get_param_names
获取的;值是此对象对应键的已拟合参数值如果
deep=True
,也包含组件参数的键值对;组件的参数按[componentname]__[paramname]
索引;componentname
的所有参数都以paramname
及其值的形式出现如果
deep=True
,也包含任意深度的组件递归,例如,[componentname]__[componentcomponentname]__[paramname]
,等等
- classmethod get_param_defaults()[source]#
获取对象的参数默认值。
- 返回:
- default_dict: 字典[字符串, 任意类型]
键是
cls
中在__init__
中定义了默认值的所有参数。值是__init__
中定义的默认值。
- classmethod get_param_names(sort=True)[source]#
获取对象的参数名称。
- 参数:
- sort布尔类型,默认为 True
是否按字母顺序返回参数名称 (True),或按它们在类
__init__
中出现的顺序返回 (False)。
- 返回:
- param_names: 字符串列表
cls
的参数名称列表。如果sort=False
,则按它们在类__init__
中出现的相同顺序排列。如果sort=True
,则按字母顺序排列。
- get_params(deep=True)[source]#
获取此对象的参数值字典。
- 参数:
- deep布尔类型,默认为 True
是否返回组件的参数。
如果为
True
,将为此对象返回一个参数名称 : 值 的dict
,包括组件(=BaseObject
值的参数)的参数。如果为
False
,将为此对象返回一个参数名称 : 值 的dict
,但不包括组件的参数。
- 返回:
- params键为字符串类型的字典
参数的字典,参数名称 : 参数值 键值对包括
总是:此对象的所有参数,如通过
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_value任意类型
`self` 中
tag_name
标签的值。如果未找到,并且raise_error
为 True,则抛出错误;否则返回tag_value_default
。
- 抛出:
ValueError
,如果raise_error
为True
。如果
tag_name
不在self.get_tags().keys()
中,则会抛出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]#
检查对象是否由其他 BaseObjects 组成。
复合对象是一个包含其他对象作为参数的对象。在实例上调用,因为这可能因实例而异。
- 返回:
- composite: 布尔类型
对象是否包含任何其值是
BaseObject
子代实例的参数。
- property is_fitted[source]#
是否已调用
fit
。检查对象的
_is_fitted` 属性,该属性在对象构造期间应初始化为 ``False
,并在调用对象的 fit 方法时设置为 True。- 返回:
- 布尔类型
估计器是否已“拟合”。
- classmethod load_from_path(serial)[source]#
从文件位置加载对象。
- 参数:
- serial`ZipFile(path).open("object")` 的结果
- 返回:
- 反序列化后的自身,生成位于
path
的输出,即cls.save(path)
的结果。
- 反序列化后的自身,生成位于
- classmethod load_from_serial(serial)[source]#
从序列化内存容器加载对象。
- 参数:
- serial`cls.save(None)` 输出的第一个元素
- 返回:
- 反序列化后的自身,生成输出
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))`` 后获得的对象相同。- 返回:
- self
类实例重置为初始化后的干净状态,但保留当前的超参数值。
- save(path=None, serialization_format='pickle')[source]#
将序列化的 self 保存到字节类对象或 (.zip) 文件。
行为:如果
path
为 None,则返回内存中的序列化自身;如果path
是文件位置,则将自身以 zip 文件格式存储在该位置保存的文件是包含以下内容的 zip 文件:`_metadata` - 包含自身的类,即
type(self)
;`_obj` - 序列化后的自身。此类使用默认的序列化方式 (pickle)。- 参数:
- pathNone 或文件位置(字符串或 Path 对象)
如果为 None,自身将被保存到内存对象中;如果是文件位置,自身将被保存到该文件位置。如果
path="estimator"
,则将在当前工作目录 (cwd) 创建一个名为estimator.zip
的 zip 文件。path="/home/stored/estimator"
,则将创建一个名为estimator.zip
的 zip 文件,该文件将
存储在
/home/stored/
中。- serialization_format: 字符串,默认为 “pickle”
用于序列化的模块。可用选项为 “pickle” 和 “cloudpickle”。请注意,非默认格式可能需要安装其他软依赖项。
- 返回:
- 如果
path
为 None - 内存中的序列化自身 - 如果
path
是文件位置 - 指向该文件的 ZipFile 对象
- 如果
- set_config(**config_dict)[source]#
将配置标志设置为给定值。
- 参数:
- config_dict字典
配置名称 : 配置值 对的字典。有效的配置、值及其含义如下所示:
- display字符串,“diagram”(图示,默认)或“text”(文本)
jupyter 内核如何显示 `self` 的实例
“diagram” = HTML 框图表示
“text” = 字符串打印输出
- print_changed_only布尔类型,默认为 True
打印
self
时是否仅列出与默认值不同的自身参数 (True),或列出所有参数名称和值 (False)。不嵌套,即只影响self
而不影响组件估计器。- 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>
。如果引用明确(例如,没有两个组件参数具有相同的名称<parameter>
),也可以使用不带<component>__
的字符串<parameter>
。- 参数:
- **params字典
BaseObject 参数,键必须是
<component>__<parameter>
形式的字符串。如果__
后缀在 get_params 键中是唯一的,则可以作为完整字符串的别名。
- 返回:
- self对自身的引用(参数设置后)
- set_random_state(random_state=None, deep=True, self_policy='copy')[source]#
为 self 设置 random_state 伪随机种子参数。
通过
self.get_params
查找名为random_state
的参数,并通过set_params
将它们设置为从random_state
派生的整数。这些整数通过sample_dependent_seed
从链式哈希中采样得到,并保证种子随机生成器的伪随机独立性。根据
self_policy
适用于self
中的random_state
参数,并且仅当deep=True
时适用于其余组件对象。注意:即使
self
没有random_state
参数,或者没有一个组件有random_state
参数,也会调用set_params
。因此,set_random_state
会重置任何scikit-base
对象,即使是没有random_state
参数的对象。- 参数:
- random_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字典
标签名称 : 标签值 对的字典。
- 返回:
- self
对自身的引用。
- update(X, y=None)[source]#
根据更多数据更新拟合参数。
如果没有实现估计器特定的更新方法,默认的回退策略是拟合所有目前观察到的数据
- 所需状态
要求状态为“已拟合”(“fitted”)。
- 访问 `self` 中的
以 “_” 结尾的已拟合模型属性。指向已见数据的指针,
self._X
、self._is_fitted
。以 “_” 结尾的模型属性。- 写入 self
通过追加行,使用
X
更新self._X
。更新以 “_” 结尾的已拟合模型属性。
- 参数:
- X sktime 兼容数据容器格式的时间序列。
用于拟合参数估计器的时间序列。
sktime 中的单个数据格式是所谓的 mtype 规范,每个 mtype 实现一个抽象 scitype。
Series
scitype = 单个时间序列,普通预测。pd.DataFrame
、pd.Series
或np.ndarray
(1维或2维)Panel
scitype = 时间序列集合,全局/面板预测。具有2级行MultiIndex
(instance, time)
的pd.DataFrame
,3D np.ndarray
(instance, variable, time)
,或包含 Series 类型pd.DataFrame
的list
Hierarchical
scitype = 分层集合,用于分层预测。具有3级或更多级别行MultiIndex
(hierarchy_1, ..., hierarchy_n, time)
的pd.DataFrame
估计器是否支持面板或分层数据由 scitype 标签
scitype:X
和scitype:y
决定。有关数据格式的更多详情,请参阅词汇表中的 mtype。
- y`sktime` 兼容数据容器格式的时间序列。
用于拟合参数估计器的第二个时间序列。
仅当估计器是成对估计器时才需要,即当标签
capability:pairwise
为 True 时。否则输入将被忽略,并且不会抛出异常。
- 返回:
- self对自身的引用