中位数相对绝对误差#
- class MedianRelativeAbsoluteError(multioutput='uniform_average', multilevel='uniform_average')[源代码][源代码]#
中位数相对绝对误差 (MdRAE)。
在相对误差指标中,首先通过将单个预测误差按比例(除以)在相同索引位置使用基准方法计算的误差来计算相对误差。如果基准方法的误差为零,则返回一个较大的值。
MdRAE 将中位数绝对误差 (MdAE) 应用于生成的相对误差。
- 参数:
- 多输出{‘raw_values’, ‘uniform_average’} 或形状为 (n_outputs,) 的类数组对象,默认=’uniform_average’
定义如何聚合多元(多输出)数据的度量。如果是类数组,则使用这些值作为权重来平均误差。如果是’raw_values’,则在多输出输入的情况下返回所有误差的完整集合。如果是’uniform_average’,则所有输出的误差以均匀权重平均。
- 多级{‘原始值’, ‘均匀平均’, ‘均匀平均时间’}
定义如何聚合层次数据(具有层次)的指标。如果为 ‘uniform_average’(默认),误差在层次上进行均值平均。如果为 ‘uniform_average_time’,指标应用于所有数据,忽略层次索引。如果为 ‘raw_values’,不在层次上平均误差,保留层次结构。
参考文献
Hyndman, R. J 和 Koehler, A. B. (2006)。《另一种看待预测准确度度量的方法》,《国际预测杂志》,第22卷,第4期。
示例
>>> import numpy as np >>> from sktime.performance_metrics.forecasting import MedianRelativeAbsoluteError >>> y_true = np.array([3, -0.5, 2, 7, 2]) >>> y_pred = np.array([2.5, 0.0, 2, 8, 1.25]) >>> y_pred_benchmark = y_pred*1.1 >>> mdrae = MedianRelativeAbsoluteError() >>> mdrae(y_true, y_pred, y_pred_benchmark=y_pred_benchmark) 1.0 >>> y_true = np.array([[0.5, 1], [-1, 1], [7, -6]]) >>> y_pred = np.array([[0, 2], [-1, 2], [8, -5]]) >>> y_pred_benchmark = y_pred*1.1 >>> mdrae(y_true, y_pred, y_pred_benchmark=y_pred_benchmark) 0.6944444444444443 >>> mdrae = MedianRelativeAbsoluteError(multioutput='raw_values') >>> mdrae(y_true, y_pred, y_pred_benchmark=y_pred_benchmark) array([0.55555556, 0.83333333]) >>> mdrae = MedianRelativeAbsoluteError(multioutput=[0.3, 0.7]) >>> mdrae(y_true, y_pred, y_pred_benchmark=y_pred_benchmark) 0.7499999999999999
方法
__call__
(y_true, y_pred, **kwargs)使用底层度量函数计算度量值。
clone
()获取具有相同超参数的对象副本。
clone_tags
(estimator[, tag_names])从另一个估计器克隆标签作为动态覆盖。
create_test_instance
([parameter_set])如果可能,构造 Estimator 实例。
create_test_instances_and_names
([parameter_set])创建所有测试实例的列表以及它们的名称列表。
evaluate
(y_true, y_pred, **kwargs)在给定的输入上评估所需的指标。
evaluate_by_index
(y_true, y_pred, **kwargs)返回在每个时间点评估的指标。
func
(y_pred[, horizon_weight, multioutput])中位数相对绝对误差 (MdRAE)。
get_class_tag
(tag_name[, tag_value_default])获取类标签的值。
从类及其所有父类中获取类标签。
获取 self 的配置标志
获取对象的参数默认值。
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])将序列化的自身保存到类字节对象或 (.zip) 文件中。
set_config
(**config_dict)将配置标志设置为给定值。
set_params
(**params)设置此对象的参数。
set_random_state
([random_state, deep, ...])设置 random_state 伪随机种子参数为 self。
set_tags
(**tag_dict)将动态标签设置为给定值。
- func(y_pred, horizon_weight=None, multioutput='uniform_average', **kwargs)[源代码]#
中位数相对绝对误差 (MdRAE)。
在相对误差指标中,首先通过将单个预测误差按比例(除以)在相同索引位置使用基准方法计算的误差来计算相对误差。如果基准方法的误差为零,则返回一个较大的值。
MdRAE 将中位数绝对误差 (MdAE) 应用于生成的相对误差。
- 参数:
- y_truepd.Series, pd.DataFrame 或 np.array,形状为 (fh,) 或 (fh, n_outputs),其中 fh 是预测范围
地面真值(正确的)目标值。
- y_predpd.Series, pd.DataFrame 或 np.array,形状为 (fh,) 或 (fh, n_outputs),其中 fh 是预测范围
预测值。
- y_pred_benchmarkpd.Series, pd.DataFrame 或 np.array,形状为 (fh,) 或 (fh, n_outputs),其中 fh 是预测范围,默认=None
来自基准方法的预测值。
- horizon_weight形状为 (fh,) 的类数组,默认=None
预测范围权重。
- 多输出{‘raw_values’, ‘uniform_average’} 或形状为 (n_outputs,) 的类数组对象,默认=’uniform_average’
定义如何聚合多元(多输出)数据的度量。如果是类数组,则使用这些值作为权重来平均误差。如果是’raw_values’,则在多输出输入的情况下返回所有误差的完整集合。如果是’uniform_average’,则所有输出的误差以均匀权重平均。
- 返回:
- 损失浮动
MdRAE 损失。如果 multioutput 是 ‘raw_values’,则分别返回每个输出的 MdRAE。如果 multioutput 是 ‘uniform_average’ 或一个权重 ndarray,则返回所有输出误差的加权平均 MdRAE。
参见
参考文献
Hyndman, R. J 和 Koehler, A. B. (2006)。《另一种看待预测准确度度量的方法》,《国际预测杂志》,第22卷,第4期。
示例
>>> from sktime.performance_metrics.forecasting import median_relative_absolute_error >>> y_true = np.array([3, -0.5, 2, 7, 2]) >>> y_pred = np.array([2.5, 0.0, 2, 8, 1.25]) >>> y_pred_benchmark = y_pred*1.1 >>> median_relative_absolute_error(y_true, y_pred, y_pred_benchmark=y_pred_benchmark) 1.0 >>> y_true = np.array([[0.5, 1], [-1, 1], [7, -6]]) >>> y_pred = np.array([[0, 2], [-1, 2], [8, -5]]) >>> y_pred_benchmark = y_pred*1.1 >>> median_relative_absolute_error(y_true, y_pred, y_pred_benchmark=y_pred_benchmark) 0.6944444444444443 >>> median_relative_absolute_error(y_true, y_pred, y_pred_benchmark=y_pred_benchmark, multioutput='raw_values') array([0.55555556, 0.83333333]) >>> median_relative_absolute_error(y_true, y_pred, y_pred_benchmark=y_pred_benchmark, multioutput=[0.3, 0.7]) 0.7499999999999999
- __call__(y_true, y_pred, **kwargs)[源代码]#
使用底层度量函数计算度量值。
- 参数:
- y_true :
sktime
兼容数据容器格式的时序数据。时间序列在 地面真值(正确的)目标值。
sktime
中的单个数据格式被称为 mtype 规范,每个 mtype 实现了一个抽象的 scitype。Series
类型 = 单个时间序列,传统的预测。pd.DataFrame
、pd.Series
或 ``np.ndarray``(一维或二维)Panel
类型 = 时间序列集合,全局/面板预测。pd.DataFrame
具有两级行MultiIndex
(实例, 时间)
,3D np.ndarray
(实例, 变量, 时间)
,list
类型的Series
pd.DataFrame
Hierarchical
类型 = 分层集合,用于分层预测。pd.DataFrame
带有3个或更多级别的行MultiIndex
(hierarchy_1, ..., hierarchy_n, time)
关于数据格式的更多细节,请参见关于 mtype 的术语表。关于使用方法,请参见预测教程
examples/01_forecasting.ipynb
- y_pred : 时间序列,采用
sktime
兼容的数据容器格式时间序列在 用于评估的预测值。必须与
y_true
格式相同,如果索引了,则索引和列也必须相同。- y_pred_benchmark : 可选,
sktime
兼容数据容器格式的时间序列可选的,时间序列 基准预测用于比较
y_pred
,用于相对指标。仅当指标需要基准预测时才需要,如标签requires-y-pred-benchmark
所示。否则,可以传递以确保接口一致性,但会被忽略。必须与y_true
格式相同,如果索引,则索引和列相同。- y_train : 可选,
sktime
兼容数据容器格式的时间序列可选的,时间序列 用于归一化误差度量的训练数据。仅在度量需要训练数据时(如标签
requires-y-train
所示)才需要。否则,可以传递以确保接口一致性,但会被忽略。必须与y_true
格式相同,如果索引,则列相同,但索引不一定相同。- sample_weight可选,类似一维数组,默认=None
每个时间点的样本权重。
如果
None
,时间索引被认为是等权重的。如果是一个数组,必须是1D。如果
y_true
和y_pred
是单个时间序列,sample_weight
的长度必须与y_true
相同。如果时间序列是面板或层次结构,所有单个时间序列的长度必须相同,并且等于sample_weight
的长度,对于传递的所有时间序列实例。
- y_true :
- 返回:
- 损失float, np.ndarray, 或 pd.DataFrame
计算的指标,按变量平均或计算。如果提供了
sample_weight
,则按其加权。float 如果
multioutput="uniform_average"
或类数组,且multilevel="uniform_average"
或 “uniform_average_time”``。值是指标在变量和层级上的平均值(参见类文档字符串)形状为
(y_true.columns,)
的np.ndarray
,如果 multioutput=”raw_values” 且multilevel="uniform_average"
或"uniform_average_time"
。第 i 个条目是第 i 个变量的指标计算结果。pd.DataFrame
如果multilevel="raw_values"
。形状为(n_levels, )
,如果multioutput="uniform_average"
;形状为(n_levels, y_true.columns)
如果multioutput="raw_values"
。指标按层级应用,行平均(是/否)如multioutput
中所示。
- clone()[源代码]#
获取具有相同超参数的对象副本。
克隆是一个在初始化后状态下的不同对象,没有共享引用。此函数等同于返回 self 的 sklearn.clone。
- 引发:
- 如果克隆不符合规范,由于
__init__
存在错误,将引发 RuntimeError。
- 如果克隆不符合规范,由于
注释
如果成功,值等于
type(self)(**self.get_params(deep=False))
。
- clone_tags(estimator, tag_names=None)[源代码]#
从另一个估计器克隆标签作为动态覆盖。
- 参数:
- 估计器继承自
BaseEstimator
的估计器 - 标签名称str 或 str 列表, 默认 = None
要克隆的标签名称。如果为 None,则使用估计器中的所有标签作为 tag_names。
- 估计器继承自
- 返回:
- 自我
自我引用。
注释
通过在 tag_set 中设置来自估计器的标签值,将对象状态更改为 self 中的动态标签。
- classmethod create_test_instance(parameter_set='default')[源代码]#
如果可能,构造 Estimator 实例。
- 参数:
- 参数集str, 默认值=”default”
要返回的测试参数集的名称,用于测试。如果没有为某个值定义特殊参数,将返回 “default” 集。
- 返回:
- 实例使用默认参数的类实例
注释
get_test_params 可以返回字典或字典列表。此函数获取 get_test_params 返回的第一个或单个字典,并使用该字典构建对象。
- classmethod create_test_instances_and_names(parameter_set='default')[源代码]#
创建所有测试实例的列表以及它们的名称列表。
- 参数:
- 参数集str, 默认值=”default”
要返回的测试参数集的名称,用于测试。如果没有为某个值定义特殊参数,将返回 “default” 集。
- 返回:
- objscls 实例列表
第 i 个实例是 cls(**cls.get_test_params()[i])
- 名称list of str, 与 objs 长度相同
第 i 个元素是测试中第 i 个 obj 实例的名称,约定为 {cls.__name__}-{i},如果存在多个实例,否则为 {cls.__name__}。
- evaluate(y_true, y_pred, **kwargs)[源代码]#
在给定的输入上评估所需的指标。
- 参数:
- y_true :
sktime
兼容数据容器格式的时序数据。时间序列在 地面真值(正确的)目标值。
sktime
中的单个数据格式被称为 mtype 规范,每个 mtype 实现了一个抽象的 scitype。Series
类型 = 单个时间序列,传统的预测。pd.DataFrame
、pd.Series
或 ``np.ndarray``(一维或二维)Panel
类型 = 时间序列集合,全局/面板预测。pd.DataFrame
具有两级行MultiIndex
(实例, 时间)
,3D np.ndarray
(实例, 变量, 时间)
,list
类型的Series
pd.DataFrame
Hierarchical
类型 = 分层集合,用于分层预测。pd.DataFrame
带有3个或更多级别的行MultiIndex
(hierarchy_1, ..., hierarchy_n, time)
关于数据格式的更多细节,请参见关于 mtype 的术语表。关于使用方法,请参见预测教程
examples/01_forecasting.ipynb
- y_pred : 时间序列,采用
sktime
兼容的数据容器格式时间序列在 用于评估的预测值。必须与
y_true
格式相同,如果索引了,则索引和列也必须相同。- y_pred_benchmark : 可选,
sktime
兼容数据容器格式的时间序列可选的,时间序列 基准预测用于比较
y_pred
,用于相对指标。仅当指标需要基准预测时才需要,如标签requires-y-pred-benchmark
所示。否则,可以传递以确保接口一致性,但会被忽略。必须与y_true
格式相同,如果索引,则索引和列相同。- y_train : 可选,
sktime
兼容数据容器格式的时间序列可选的,时间序列 用于归一化误差度量的训练数据。仅在度量需要训练数据时(如标签
requires-y-train
所示)才需要。否则,可以传递以确保接口一致性,但会被忽略。必须与y_true
格式相同,如果索引,则列相同,但索引不一定相同。- sample_weight可选,类似一维数组,默认=None
每个时间点的样本权重。
如果
None
,时间索引被认为是等权重的。如果是一个数组,必须是1D。如果
y_true
和y_pred
是单个时间序列,sample_weight
的长度必须与y_true
相同。如果时间序列是面板或层次结构,所有单个时间序列的长度必须相同,并且等于sample_weight
的长度,对于传递的所有时间序列实例。
- y_true :
- 返回:
- 损失float, np.ndarray, 或 pd.DataFrame
计算的指标,按变量平均或计算。如果提供了
sample_weight
,则按其加权。float 如果
multioutput="uniform_average"
或类数组,且multilevel="uniform_average"
或 “uniform_average_time”``。值是指标在变量和层级上的平均值(参见类文档字符串)形状为
(y_true.columns,)
的np.ndarray
,如果 multioutput=”raw_values” 且multilevel="uniform_average"
或"uniform_average_time"
。第 i 个条目是第 i 个变量的指标计算结果。pd.DataFrame
如果multilevel="raw_values"
。形状为(n_levels, )
,如果multioutput="uniform_average"
;形状为(n_levels, y_true.columns)
如果multioutput="raw_values"
。指标按层级应用,行平均(是/否)如multioutput
中所示。
- evaluate_by_index(y_true, y_pred, **kwargs)[源代码]#
返回在每个时间点评估的指标。
- 参数:
- y_true :
sktime
兼容数据容器格式的时序数据。时间序列在 地面真值(正确的)目标值。
sktime
中的单个数据格式被称为 mtype 规范,每个 mtype 实现了一个抽象的 scitype。Series
类型 = 单个时间序列,传统的预测。pd.DataFrame
、pd.Series
或 ``np.ndarray``(一维或二维)Panel
类型 = 时间序列集合,全局/面板预测。pd.DataFrame
具有两级行MultiIndex
(实例, 时间)
,3D np.ndarray
(实例, 变量, 时间)
,list
类型的Series
pd.DataFrame
Hierarchical
类型 = 分层集合,用于分层预测。pd.DataFrame
带有3个或更多级别的行MultiIndex
(hierarchy_1, ..., hierarchy_n, time)
关于数据格式的更多细节,请参见关于 mtype 的术语表。关于使用方法,请参见预测教程
examples/01_forecasting.ipynb
- y_pred : 时间序列,采用
sktime
兼容的数据容器格式时间序列在 用于评估的预测值。必须与
y_true
格式相同,如果索引了,则索引和列也必须相同。- y_pred_benchmark : 可选,
sktime
兼容数据容器格式的时间序列可选的,时间序列 基准预测用于比较
y_pred
,用于相对指标。仅当指标需要基准预测时才需要,如标签requires-y-pred-benchmark
所示。否则,可以传递以确保接口一致性,但会被忽略。必须与y_true
格式相同,如果索引,则索引和列相同。- y_train : 可选,
sktime
兼容数据容器格式的时间序列可选的,时间序列 用于归一化误差度量的训练数据。仅在度量需要训练数据时(如标签
requires-y-train
所示)才需要。否则,可以传递以确保接口一致性,但会被忽略。必须与y_true
格式相同,如果索引,则列相同,但索引不一定相同。- sample_weight可选,类似一维数组,默认=None
每个时间点的样本权重。
如果
None
,时间索引被认为是等权重的。如果是一个数组,必须是1D。如果
y_true
和y_pred
是单个时间序列,sample_weight
的长度必须与y_true
相同。如果时间序列是面板或层次结构,所有单个时间序列的长度必须相同,并且等于sample_weight
的长度,对于传递的所有时间序列实例。
- y_true :
- 返回:
- 损失pd.Series 或 pd.DataFrame
按时间点计算的指标(默认=刀切法伪值)。如果提供了
sample_weight
,则按权重计算。pd.Series
如果multioutput="uniform_average"
或类数组。索引与y_true
的索引相同;索引 i 处的条目是时间 i 处的指标,在变量上取平均值pd.DataFrame
如果multioutput="raw_values"
。索引和列与y_true
相同;第 i,j 个条目是变量 j 在时间 i 的指标值
- classmethod get_class_tag(tag_name, tag_value_default=None)[源代码]#
获取类标签的值。
不返回在实例上定义的动态标签(通过 set_tags 或 clone_tags 设置)的信息。
- 参数:
- 标签名称str
标签值的名称。
- tag_value_default任何
如果未找到标签,则使用默认/回退值。
- 返回:
- 标签值
self 中 tag_name 标签的值。如果未找到,则返回 tag_value_default。
- classmethod get_class_tags()[源代码]#
从类及其所有父类中获取类标签。
从 _tags 类属性中检索标签:值对。不返回在实例上通过 set_tags 或 clone_tags 设置的动态标签信息。
- 返回:
- collected_tags字典
类标签名称字典:标签值对。通过嵌套继承从 _tags 类属性中收集。
- get_config()[源代码]#
获取 self 的配置标志
- 返回:
- config_dict字典
配置名称 : 配置值对的字典。通过嵌套继承从 _config 类属性收集,然后从 _config_dynamic 对象属性中覆盖和新标签。
- classmethod get_param_defaults()[源代码]#
获取对象的参数默认值。
- 返回:
- default_dict: dict[str, Any]
键是 cls 中所有在 __init__ 中定义了默认值的参数,值是 __init__ 中定义的默认值。
- classmethod get_param_names(sort=True)[源代码]#
获取对象的参数名称。
- 参数:
- 排序bool, 默认=True
是否按字母顺序返回参数名称(True),或者按它们在类
__init__
中出现的顺序返回(False)。
- 返回:
- param_names: list[str]
cls 的参数名称列表。如果
sort=False
,则按它们在类__init__
中出现的顺序排列。如果sort=True
,则按字母顺序排列。
- get_params(deep=True)[源代码]#
获取此对象的参数值字典。
- 参数:
- 深度bool, 默认=True
是否返回组件的参数。
如果为 True,将返回此对象的参数名称 : 值的字典,包括组件的参数(= BaseObject 值的参数)。
如果为 False,将返回此对象的参数名称 : 值的字典,但不包括组件的参数。
- 返回:
- 参数带有字符串键的字典
参数字典,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)[源代码]#
从估计器类获取标签值并动态覆盖标签。
- 参数:
- 标签名称str
要检索的标签名称
- tag_value_default任何类型,可选;默认=None
如果未找到标签,则使用默认/回退值
- raise_error布尔值
当找不到标签时是否引发 ValueError
- 返回:
- 标签值任何
self 中 tag_name 标签的值。如果未找到,当 raise_error 为 True 时返回错误,否则返回 tag_value_default。
- 引发:
- 如果 raise_error 为 True,即如果 tag_name 不在其中,则引发 ValueError。
- self.get_tags().keys()
- get_tags()[源代码]#
从估计器类和动态标签覆盖中获取标签。
- 返回:
- collected_tags字典
标签名称 : 标签值对的字典。通过嵌套继承收集自 _tags 类属性,然后是 _tags_dynamic 对象属性的任何覆盖和新标签。
- classmethod get_test_params(parameter_set='default')[源代码]#
返回估计器的测试参数设置。
- 参数:
- 参数集str, 默认值=”default”
要返回的测试参数集的名称,用于测试。如果没有为某个值定义特殊参数,将返回 “default” 集。
- 返回:
- 参数字典或字典列表,默认 = {}
创建类的测试实例的参数 每个字典都是构造一个“有趣的”测试实例的参数,即 MyClass(**params) 或 MyClass(**params[i]) 创建一个有效的测试实例。create_test_instance 使用 params 中的第一个(或唯一一个)字典
- is_composite()[源代码]#
检查对象是否由其他 BaseObjects 组成。
复合对象是一个包含对象的对象,作为参数。在实例上调用,因为这可能因实例而异。
- 返回:
- composite: bool
一个对象是否有任何参数的值是 BaseObjects。
- classmethod load_from_path(serial)[源代码]#
从文件位置加载对象。
- 参数:
- 串行ZipFile(path).open(“object”) 的结果
- 返回:
- 反序列化自身,结果输出到
path
,通过cls.save(path)
- 反序列化自身,结果输出到
- classmethod load_from_serial(serial)[源代码]#
从序列化的内存容器中加载对象。
- 参数:
- serial :
cls.save(None)
输出的第一个元素输出结果的第一个元素
- serial :
- 返回:
- 反序列化自身,结果输出为
serial
,由cls.save(None)
产生
- 反序列化自身,结果输出为
- reset()[源代码]#
将对象重置为初始化后的干净状态。
使用 reset,使用当前的超参数值(get_params 的结果)运行 __init__。这将移除任何对象属性,除了:
超参数 = __init__ 的参数
包含双下划线的对象属性,即字符串”__”
类和对象方法,以及类属性也不受影响。
- 返回:
- 自身
类的实例重置为干净的初始化后状态,但保留当前的超参数值。
注释
等同于 sklearn.clone 但覆盖了 self。在调用 self.reset() 之后,self 的值等于 type(self)(**self.get_params(deep=False))
- save(path=None, serialization_format='pickle')[源代码]#
将序列化的自身保存到类字节对象或 (.zip) 文件中。
行为:如果
path
是 None,则返回内存中的序列化自身;如果path
是一个文件位置,则将自身存储在该位置作为一个 zip 文件。保存的文件是包含以下内容的zip文件:_metadata - 包含自身的类,即 type(self) _obj - 序列化的自身。此类使用默认的序列化(pickle)。
- 参数:
- 路径无或文件位置(字符串或路径)
如果为 None,则将 self 保存到内存中的对象;如果为文件位置,则将 self 保存到该文件位置。如果:
path=”estimator” 则会在当前工作目录(cwd)生成一个名为
estimator.zip
的压缩文件。path=”/home/stored/estimator” 则会在/home/stored/
目录下存储一个名为estimator.zip
的压缩文件。- serialization_format: str, default = “pickle”
用于序列化的模块。可用的选项是“pickle”和“cloudpickle”。请注意,非默认格式可能需要安装其他软依赖项。
- 返回:
- 如果
path
为 None - 内存中序列化的自身 - 如果
path
是文件位置 - 带有文件引用的 ZipFile
- 如果
- set_config(**config_dict)[源代码]#
将配置标志设置为给定值。
- 参数:
- config_dict字典
配置名称 : 配置值对的字典。有效的配置、值及其含义如下所示:
- 显示str, “diagram” (默认), 或 “text”
jupyter 内核如何显示 self 的实例
“diagram” = html 盒子图表示
“text” = 字符串打印输出
- print_changed_onlybool, 默认=True
是否仅打印与默认值不同的自身参数(False),或打印所有参数名称和值(False)。不嵌套,即仅影响自身,不影响组件估计器。
- 警告str, “on” (默认), 或 “off”
是否引发警告,仅影响来自 sktime 的警告
“on” = 将引发来自 sktime 的警告
“off” = 不会从 sktime 引发警告
- 后端:并行str, 可选, 默认=”None”
在广播/矢量化时用于并行化的后端,是以下之一
“None”: 按顺序执行循环,简单的列表推导
“loky”, “multiprocessing” 和 “threading”: 使用
joblib.Parallel
“joblib”:自定义和第三方
joblib
后端,例如,spark
“dask”: 使用
dask
,需要在环境中安装dask
包
- 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
- 返回:
- self自我引用。
注释
更改对象状态,将 config_dict 中的配置复制到 self._config_dynamic。
- set_params(**params)[源代码]#
设置此对象的参数。
该方法适用于简单的估计器以及复合对象。对于复合对象,即包含其他对象的对象,可以使用参数键字符串
<component>__<parameter>
来访问组件<component>
中的<parameter>
。如果这使得引用明确,例如没有两个组件的参数名称相同,也可以使用不带<component>__
的字符串<parameter>
。- 参数:
- **参数字典
BaseObject 参数,键必须是
<组件>__<参数>
字符串。如果 get_params 键中唯一,__ 后缀可以别名完整字符串。
- 返回:
- self引用自身(在参数设置之后)
- set_random_state(random_state=None, deep=True, self_policy='copy')[源代码]#
设置 random_state 伪随机种子参数为 self。
通过
estimator.get_params
查找名为random_state
的参数,并通过set_params
将其设置为由random_state
派生的整数。这些整数通过sample_dependent_seed
的链哈希采样获得,并保证种子随机生成器的伪随机独立性。根据
self_policy
应用于estimator
中的random_state
参数,并且仅当deep=True
时应用于剩余的组件估计器。注意:即使
self
没有random_state
,或者没有任何组件有random_state
参数,也会调用set_params
。因此,set_random_state
将重置任何scikit-base
估计器,即使它们没有random_state
参数。- 参数:
- random_stateint, RandomState 实例或 None, 默认=None
伪随机数生成器,用于控制随机整数的生成。传递 int 以在多次函数调用中获得可重复的输出。
- 深度bool, 默认=True
是否在子估计器中设置随机状态。如果为 False,则仅设置
self
的random_state
参数(如果存在)。如果为 True,则还会在子估计器中设置random_state
参数。- self_policystr, 可选值为 {“copy”, “keep”, “new”}, 默认值为 “copy”
“复制” :
estimator.random_state
被设置为输入random_state
“保持” :
estimator.random_state
保持不变“new” :
estimator.random_state
被设置为一个新的随机状态,
源自输入
random_state
,并且通常与它不同
- 返回:
- self自我引用