几何平均相对绝对误差#

class GeometricMeanRelativeAbsoluteError(multioutput='uniform_average', multilevel='uniform_average', by_index=False)[source]#

几何平均相对绝对误差 (GMRAE)。

在相对误差度量中，首先通过将单个预测误差按基准方法在相同索引位置计算的误差进行缩放（除以）来计算相对误差。如果基准方法的误差为零，则返回一个很大的值。

GMRAE 将几何平均绝对误差 (GMAE) 应用于结果相对误差。

参数：
multioutput{‘raw_values’, ‘uniform_average’} 或形状为 (n_outputs,) 的类似数组，默认值=’uniform_average’

定义如何聚合多元（多输出）数据的度量。

  • 如果为类似数组，值用作平均误差的权重。

  • 如果是 'raw_values'，则在多输出输入的情况下返回完整的误差集。

  • 如果是 'uniform_average'，则所有输出的误差以均匀权重平均。

multilevel{‘raw_values’, ‘uniform_average’, ‘uniform_average_time’}

定义如何聚合分层数据（带层级）的度量。

  • 如果是 'uniform_average'（默认），误差按层级平均。

  • 如果是 'uniform_average_time'，度量应用于所有数据，忽略层级索引。

  • 如果是 'raw_values'，则不跨层级平均误差，层级结构保留。

by_indexbool，默认值=False

确定是否在直接调用度量对象时按时间点平均。

  • 如果为 False，则直接调用度量对象会按时间点平均，相当于调用 evaluate 方法。

  • 如果为 True，则直接调用度量对象会在每个时间点评估度量，相当于调用 evaluate_by_index 方法。

另请参阅

MeanRelativeAbsoluteError
MedianRelativeAbsoluteError
GeometricMeanRelativeSquaredError

参考文献

Hyndman, R. J and Koehler, A. B. (2006). “Another look at measures of forecast accuracy”, International Journal of Forecasting, Volume 22, Issue 4.

示例

>>> import numpy as np
>>> from sktime.performance_metrics.forecasting import     GeometricMeanRelativeAbsoluteError
>>> 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
>>> gmrae = GeometricMeanRelativeAbsoluteError()
>>> gmrae(y_true, y_pred, y_pred_benchmark=y_pred_benchmark)
np.float64(0.0007839273064064755)
>>> 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
>>> gmrae(y_true, y_pred, y_pred_benchmark=y_pred_benchmark)
np.float64(0.5578632807409556)
>>> gmrae = GeometricMeanRelativeAbsoluteError(multioutput='raw_values')
>>> gmrae(y_true, y_pred, y_pred_benchmark=y_pred_benchmark)
array([4.97801163e-06, 1.11572158e+00])
>>> gmrae = GeometricMeanRelativeAbsoluteError(multioutput=[0.3, 0.7])
>>> gmrae(y_true, y_pred, y_pred_benchmark=y_pred_benchmark)
np.float64(0.7810066018326863)

方法

__call__(y_true, y_pred, **kwargs)

使用底层度量函数计算度量值。

clone()

获取具有相同超参数和配置的对象的克隆。

clone_tags(estimator[, tag_names])

从另一个对象克隆标签作为动态覆盖。

create_test_instance([parameter_set])

使用第一个测试参数集构造类的实例。

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])

几何平均相对绝对误差 (GMRAE)。

get_class_tag(tag_name[, tag_value_default])

从类中获取类标签值，带有来自父类的标签级别继承。

get_class_tags()

从类中获取类标签，带有来自父类的标签级别继承。

get_config()

获取对象的配置标志。

get_param_defaults()

获取对象的默认参数。

get_param_names([sort])

获取对象的参数名称。

get_params([deep])

获取此对象的参数值字典。

get_tag(tag_name[, tag_value_default, ...])

从实例中获取标签值，带有标签级别继承和覆盖。

get_tags()

从实例中获取标签，带有标签级别继承和覆盖。

get_test_params([parameter_set])

返回 skbase 对象的测试参数设置。

is_composite()

检查对象是否由其他 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 伪随机种子参数用于对象本身。

set_tags(**tag_dict)

将实例级别标签覆盖设置为给定值。
func(y_pred, horizon_weight=None, multioutput='uniform_average', **kwargs)[source]#

几何平均相对绝对误差 (GMRAE)。

在相对误差度量中，首先通过将单个预测误差按基准方法在相同索引位置计算的误差进行缩放（除以）来计算相对误差。如果基准方法的误差为零，则返回一个很大的值。

GMRAE 将几何平均绝对误差 (GMAE) 应用于结果相对误差。

参数：
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_benchmark可选，pd.Series, pd.DataFrame 或 np.array，形状为 (fh,) 或 (fh, n_outputs)，其中 fh 是预测范围，默认值=None

来自基准方法的预测值。

horizon_weight可选，形状为 (fh,) 的类似数组，默认值=None

预测范围权重。

multioutput{‘raw_values’, ‘uniform_average’} 或形状为 (n_outputs,) 的类似数组，默认值=’uniform_average’

定义如何聚合多元（多输出）数据的度量。如果为类似数组，值用作平均误差的权重。如果是 ‘raw_values’，则在多输出输入的情况下返回完整的误差集。如果是 ‘uniform_average’，则所有输出的误差以均匀权重平均。

返回值：
lossfloat

GMRAE 损失。如果 multioutput 是 ‘raw_values’，则分别返回每个输出的 GMRAE。如果 multioutput 是 ‘uniform_average’ 或权重的 ndarray，则返回所有输出误差的加权平均 GMRAE。

另请参阅

mean_relative_absolute_error
median_relative_absolute_error
geometric_mean_relative_squared_error

参考文献

Hyndman, R. J and Koehler, A. B. (2006). “Another look at measures of forecast accuracy”, International Journal of Forecasting, Volume 22, Issue 4.

示例

>>> import numpy as np
>>> from sktime.performance_metrics.forecasting import         geometric_mean_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
>>> geometric_mean_relative_absolute_error(y_true, y_pred,     y_pred_benchmark=y_pred_benchmark)
0.0007839273064064755
>>> 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
>>> geometric_mean_relative_absolute_error(y_true, y_pred,     y_pred_benchmark=y_pred_benchmark)
0.5578632807409556
>>> geometric_mean_relative_absolute_error(y_true, y_pred,     y_pred_benchmark=y_pred_benchmark, multioutput='raw_values')
array([4.97801163e-06, 1.11572158e+00])
>>> geometric_mean_relative_absolute_error(y_true, y_pred,     y_pred_benchmark=y_pred_benchmark, multioutput=[0.3, 0.7])
0.7810066018326863
__call__(y_true, y_pred, **kwargs)[source]#

使用底层度量函数计算度量值。

参数：
y_true以 sktime 兼容数据容器格式表示的时间序列。

真实值（正确）目标值。

sktime 中的个体数据格式是所谓的 mtype 规范，每个 mtype 实现一个抽象 scitype。

  • Series scitype = 单个时间序列，普通预测。pd.DataFrame, pd.Series, 或 np.ndarray（一维或二维）

  • Panel scitype = 时间序列集合，全局/面板预测。带有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame，三维 np.ndarray (instance, variable, time)，Series 类型的 pd.DataFrame 列表

  • Hierarchical scitype = 分层集合，用于分层预测。带有 3 个或更多级别行 MultiIndex (hierarchy_1, ..., hierarchy_n, time) 的 pd.DataFrame

有关数据格式的更多详细信息，请参阅 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，则时间索引被视为权重相等。

  • 如果为数组，必须是一维的。如果 y_true 和 y_pred 是单个时间序列，则 sample_weight 的长度必须与 y_true 相同。如果时间序列是面板或分层的，则所有单个时间序列的长度必须相同，并等于 sample_weight 的长度，对于传入的所有时间序列实例都如此。

  • 如果是一个可调用对象，它必须遵循 SampleWeightGenerator 接口，或具有以下签名之一：y_true: pd.DataFrame -> 一维类似数组，或 y_true: pd.DataFrame x y_pred: pd.DataFrame -> 一维类似数组。

返回值：
lossfloat, np.ndarray, 或 pd.DataFrame

计算出的度量，平均或按变量。如果提供 sample_weight，则按其加权。

  • float，如果 multioutput="uniform_average" 或 类似数组，并且 ``multilevel="uniform_average" 或 “uniform_average_time”。值是按变量和层级平均的度量（参见类文档字符串）

  • np.ndarray，形状为 (y_true.columns,)，如果 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()[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。

异常：
如果克隆不符合规范，则引发 RuntimeError，这是由于有缺陷的 __init__。
clone_tags(estimator, tag_names=None)[source]#

从另一个对象克隆标签作为动态覆盖。

每个 scikit-base 兼容对象都有一个标签字典。标签可用于存储有关对象的元数据，或控制对象的行为。

标签是特定于实例 self 的键值对，它们是静态标志，在对象构造后不会更改。

clone_tags 设置来自另一个对象 estimator 的动态标签覆盖。

clone_tags 方法只能在对象的 __init__ 方法中调用，在构造期间，或在构造后直接通过 __init__ 调用。

动态标签被设置为 estimator 中的标签值，名称在 tag_names 中指定。

tag_names 的默认值 (None) 将所有标签从 estimator 写入到 self。

当前标签值可以通过 get_tags 或 get_tag 检查。

参数：
estimator:class:BaseObject 或派生类的一个实例
tag_namesstr 或 str 列表，默认值 = None

要克隆的标签名称。默认值 (None) 克隆来自 estimator 的所有标签。

返回值：
self

对 self 的引用。

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__}

evaluate(y_true, y_pred, **kwargs)[source]#

在给定输入上评估所需度量。

参数：
y_true以 sktime 兼容数据容器格式表示的时间序列。

真实值（正确）目标值。

sktime 中的个体数据格式是所谓的 mtype 规范，每个 mtype 实现一个抽象 scitype。

  • Series scitype = 单个时间序列，普通预测。pd.DataFrame, pd.Series, 或 np.ndarray（一维或二维）

  • Panel scitype = 时间序列集合，全局/面板预测。带有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame，三维 np.ndarray (instance, variable, time)，Series 类型的 pd.DataFrame 列表

  • Hierarchical scitype = 分层集合，用于分层预测。带有 3 个或更多级别行 MultiIndex (hierarchy_1, ..., hierarchy_n, time) 的 pd.DataFrame

有关数据格式的更多详细信息，请参阅 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，则时间索引被视为权重相等。

  • 如果为数组，必须是一维的。如果 y_true 和 y_pred 是单个时间序列，则 sample_weight 的长度必须与 y_true 相同。如果时间序列是面板或分层的，则所有单个时间序列的长度必须相同，并等于 sample_weight 的长度，对于传入的所有时间序列实例都如此。

  • 如果是一个可调用对象，它必须遵循 SampleWeightGenerator 接口，或具有以下签名之一：y_true: pd.DataFrame -> 一维类似数组，或 y_true: pd.DataFrame x y_pred: pd.DataFrame -> 一维类似数组。

返回值：
lossfloat, np.ndarray, 或 pd.DataFrame

计算出的度量，平均或按变量。如果提供 sample_weight，则按其加权。

  • float，如果 multioutput="uniform_average" 或 类似数组，并且 ``multilevel="uniform_average" 或 “uniform_average_time”。值是按变量和层级平均的度量（参见类文档字符串）

  • np.ndarray，形状为 (y_true.columns,)，如果 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)[source]#

返回在每个时间点评估的度量。

参数：
y_true以 sktime 兼容数据容器格式表示的时间序列。

真实值（正确）目标值。

sktime 中的个体数据格式是所谓的 mtype 规范，每个 mtype 实现一个抽象 scitype。

  • Series scitype = 单个时间序列，普通预测。pd.DataFrame, pd.Series, 或 np.ndarray（一维或二维）

  • Panel scitype = 时间序列集合，全局/面板预测。带有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame，三维 np.ndarray (instance, variable, time)，Series 类型的 pd.DataFrame 列表

  • Hierarchical scitype = 分层集合，用于分层预测。带有 3 个或更多级别行 MultiIndex (hierarchy_1, ..., hierarchy_n, time) 的 pd.DataFrame

有关数据格式的更多详细信息，请参阅 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，则时间索引被视为权重相等。

  • 如果为数组，必须是一维的。如果 y_true 和 y_pred 是单个时间序列，则 sample_weight 的长度必须与 y_true 相同。如果时间序列是面板或分层的，则所有单个时间序列的长度必须相同，并等于 sample_weight 的长度，对于传入的所有时间序列实例都如此。

  • 如果是一个可调用对象，它必须遵循 SampleWeightGenerator 接口，或具有以下签名之一：y_true: pd.DataFrame -> 一维类似数组，或 y_true: pd.DataFrame x y_pred: pd.DataFrame -> 一维类似数组。

返回值：
losspd.Series 或 pd.DataFrame

计算出的度量，按时间点（默认=jackknife 伪值）。如果提供 sample_weight，则按其加权。

  • pd.Series，如果 multioutput="uniform_average" 或类似数组。索引等于 y_true 的索引；索引 i 处的条目是时间 i 处的度量，按变量平均

  • pd.DataFrame，如果 multioutput="raw_values"。索引和列等于 y_true 的索引和列；i,j 处的条目是时间 i、变量 j 处的度量

classmethod get_class_tag(tag_name, tag_value_default=None)[source]#

从类中获取类标签值，带有来自父类的标签级别继承。

每个 scikit-base 兼容对象都有一个标签字典。标签可用于存储有关对象的元数据，或控制对象的行为。

标签是特定于实例 self 的键值对，它们是静态标志，在对象构造后不会更改。

get_class_tag 方法是一个类方法，它检索标签的值，仅考虑类级别的标签值和覆盖。

它从对象中返回名称为 tag_name 的标签的值，考虑标签覆盖，按以下降序优先级：

  1. 在类的 _tags 属性中设置的标签。

  2. 在父类的 _tags 属性中设置的标签，

按继承顺序。

不考虑在实例上设置的动态标签覆盖，这些覆盖通过 set_tags 或 clone_tags 设置，并且定义在实例上。

要检索具有潜在实例覆盖的标签值，请改用 get_tag 方法。

参数：
tag_namestr

标签值的名称。

tag_value_default任意类型，可选；默认值=None

如果未找到标签时的默认/回退值

返回值：
tag_value

tag_name 标签在 self 中的值。如果未找到，则在 raise_error 为 True 时引发错误，否则返回 tag_value_default。

classmethod get_class_tags()[source]#

从类中获取类标签，带有来自父类的标签级别继承。

每个 scikit-base 兼容对象都有一个标签字典。标签可用于存储有关对象的元数据，或控制对象的行为。

标签是特定于实例 self 的键值对，它们是静态标志，在对象构造后不会更改。

get_class_tags 方法是一个类方法，它检索标签的值，仅考虑类级别的标签值和覆盖。

它返回一个字典，键是类或其任何父类中设置的任何属性的键 _tags。

值是相应的标签值，覆盖按以下降序优先级：

  1. 在类的 _tags 属性中设置的标签。

  2. 在父类的 _tags 属性中设置的标签，

按继承顺序。

实例可以根据超参数覆盖这些标签。

要包含来自动态标签的覆盖，请使用 get_tags。

不考虑在实例上设置的动态标签覆盖，这些覆盖通过 set_tags 或 clone_tags 设置，并且定义在实例上。

要包含来自动态标签的覆盖，请使用 get_tags。

返回值：
collected_tagsdict

标签名 : 标签值 对字典。通过嵌套继承从 _tags 类属性收集。不受通过 set_tags 或 clone_tags 设置的动态标签覆盖。

get_config()[source]#

获取对象的配置标志。

配置是 self 的键值对，通常用作临时标志，用于控制行为。

get_config 返回动态配置，这会覆盖默认配置。

默认配置在类或其父类的类属性 _config 中设置，并被通过 set_config 设置的动态配置覆盖。

配置在 clone 或 reset 调用下会保留。

返回值：
config_dictdict

配置名 : 配置值 对字典。通过嵌套继承从 _config 类属性收集，然后从 _onfig_dynamic 对象属性获取任何覆盖和新标签。

classmethod get_param_defaults()[source]#

获取对象的默认参数。

返回值：
default_dict: dict[str, Any]

键是 cls 的所有在 __init__ 中定义了默认值的参数。值是 __init__ 中定义的默认值。

classmethod get_param_names(sort=True)[source]#

获取对象的参数名称。

参数：
sortbool，默认值=True

是否按字母顺序 (True) 或按它们在类 __init__ 中出现的顺序 (False) 返回参数名称。

返回值：
param_names: list[str]

cls 的参数名称列表。如果 sort=False，则按它们在类 __init__ 中出现的相同顺序。如果 sort=True，则按字母顺序排列。

get_params(deep=True)[source]#

获取此对象的参数值字典。

参数：
deepbool，默认值=True

是否返回组件的参数。

  • 如果为 True，将返回此对象的参数名 : 值 的 dict，包括组件的参数（= BaseObject 值参数）。

  • 如果为 False，将返回此对象的参数名 : 值 的 dict，但不包括组件的参数。

返回值：
paramsdict with str-valued keys

参数字典，参数名 : 参数值 键值对包括

  • 总是：此对象的所有参数，通过 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 的单个标签的值，考虑标签覆盖，按以下降序优先级：

  1. 在实例上通过 set_tags 或 clone_tags 设置的标签，

在实例构造时。

  1. 在类的 _tags 属性中设置的标签。

  2. 在父类的 _tags 属性中设置的标签，

按继承顺序。

参数：
tag_namestr

要检索的标签名称

tag_value_default任意类型，可选；默认值=None

如果未找到标签时的默认/回退值

raise_errorbool

当未找到标签时是否引发 ValueError

返回值：
tag_valueAny

tag_name 标签在 self 中的值。如果未找到，则在 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 设置的标签。

值是相应的标签值，覆盖按以下降序优先级：

  1. 在实例上通过 set_tags 或 clone_tags 设置的标签，

在实例构造时。

  1. 在类的 _tags 属性中设置的标签。

  2. 在父类的 _tags 属性中设置的标签，

按继承顺序。

返回值：
collected_tagsdict

标签名 : 标签值 对字典。通过嵌套继承从 _tags 类属性收集，然后从 _tags_dynamic 对象属性获取任何覆盖和新标签。

classmethod get_test_params(parameter_set='default')[source]#

返回 skbase 对象的测试参数设置。

get_test_params 是一个统一的接口点，用于存储测试目的的参数设置。此函数也用于 create_test_instance 和 create_test_instances_and_names 来构造测试实例。

get_test_params 应该返回一个 dict，或一个 list 的 dict。

每个 dict 都是用于测试的参数配置，并且可用于构造一个“有趣”的测试实例。对 cls(**params) 的调用对于 get_test_params 的返回值中的所有字典 params 都应该有效。

get_test_params 不需要返回固定的字典列表，它也可以返回动态或随机参数设置。

参数：
parameter_setstr，默认值=”default”

要返回的测试参数集的名称，用于测试。如果某个值未定义特殊参数，将返回 “default” 集合。

返回值：
paramsdict 或 dict 列表，默认值 = {}

用于创建类测试实例的参数。每个 dict 都是用于构造一个“有趣”的测试实例的参数，即 MyClass(**params) 或 MyClass(**params[i]) 创建一个有效的测试实例。create_test_instance 使用 params 中的第一个（或唯一一个）字典。

is_composite()[source]#

检查对象是否由其他 BaseObjects 组成。

复合对象是对象，它包含对象作为参数。在实例上调用，因为这可能因实例而异。

返回值：
composite: bool

对象是否有任何参数，其值是 BaseObject 的后代实例。

classmethod load_from_path(serial)[source]#

从文件位置加载对象。

参数：
serialZipFile(path).open(“object) 的结果
返回值：
反序列化自身，输出位于 path，来自 cls.save(path) 的输出
classmethod load_from_serial(serial)[源]#

从序列化内存容器加载对象。

参数：
serialcls.save(None) 输出的第一个元素
返回值：
反序列化自身，输出 serial，来自 cls.save(None) 的输出
reset()[源]#

将对象重置到初始化后的干净状态。

结果是将 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')[源]#

将序列化对象保存到字节状对象或保存到 (.zip) 文件。

行为：如果 path 为 None，则返回内存中的序列化自身；如果 path 是文件位置，则将自身以 zip 文件形式存储在该位置

保存的文件是 zip 文件，包含以下内容：_metadata - 包含自身的类，即 type(self) _obj - 序列化的自身。此类使用默认序列化方式 (pickle)。

参数：
pathNone 或文件位置 (str 或 Path)

如果为 None，则将自身保存到内存对象；如果为文件位置，则将自身保存到该文件位置。如果

  • path=”estimator”，则会在当前工作目录创建 zip 文件 estimator.zip。

  • path=”/home/stored/estimator”，则会是 zip 文件 estimator.zip 将被

存储在 /home/stored/。

serialization_format: str，默认 = “pickle”

用于序列化的模块。可用选项有“pickle”和“cloudpickle”。请注意，非默认格式可能需要安装其他软依赖。

返回值：
如果 path 为 None - 内存中的序列化自身
如果 path 是文件位置 - 引用该文件的 ZipFile
set_config(**config_dict)[源]#

将配置标志设置为给定值。

参数：
config_dictdict

配置名称 : 配置值 对的字典。有效的配置、值及其含义如下所示

displaystr，“diagram”（默认）或“text”

jupyter 内核如何显示自身的实例

  • “diagram” = html 框图表示

  • “text” = 字符串打印输出

print_changed_onlybool，默认=True

打印自身时，是否只列出与默认值不同的自身参数 (True)，还是列出所有参数名称和值 (False)。不进行嵌套，即只影响自身，不影响组件估计器。

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 在并行化后

      关闭。

    • “logger_name”：str，默认=”ray”；要使用的日志记录器的名称。

    • “mute_warnings”：bool，默认=False；如果为 True，则禁止警告

返回值：
self自身引用。

注释

更改对象状态，将 config_dict 中的配置复制到 self._config_dynamic。

set_params(**params)[源]#

设置此对象的参数。

此方法适用于简单的 skbase 对象以及组合对象。参数键字符串 <component>__<parameter> 可用于组合对象（即包含其他对象的对象），以访问组件 <component> 中的 <parameter>。如果引用明确，例如没有两个组件的参数同名 <parameter>，也可以使用不带 <component>__ 的字符串 <parameter>。

参数：
**paramsdict

BaseObject 参数，键必须是 <component>__<parameter> 字符串。如果 __ 后缀在 get_params 键中是唯一的，则可以作为完整字符串的别名。

返回值：
self自身引用（参数设置后）
set_random_state(random_state=None, deep=True, self_policy='copy')[源]#

设置 random_state 伪随机种子参数用于对象本身。

通过 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 参数的对象。

参数：
random_stateint, RandomState 实例或 None，默认=None

控制随机整数生成的伪随机数生成器。传递 int 以实现跨多次函数调用的可重现输出。

deepbool，默认值=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 保持不变

  • “new”：self.random_state 被设置为一个新的随机状态，

源自输入的 random_state，并且通常与其不同

返回值：
self自身引用
set_tags(**tag_dict)[源]#

将实例级别标签覆盖设置为给定值。

每个 scikit-base 兼容对象都有一个标签字典。标签可用于存储有关对象的元数据，或控制对象的行为。

标签是特定于实例 self 的键值对，它们是静态标志，在对象构造后不会更改。

set_tags 将动态标签覆盖设置为 tag_dict 中指定的值，其中键是标签名称，字典值是要将标签设置的值。

The set_tags 方法只能在对象的 __init__ 方法中调用，即在构造期间，或通过 __init__ 构造后直接调用。

当前标签值可以通过 get_tags 或 get_tag 检查。

参数：
**tag_dictdict

标签名称：标签值对的字典。

返回值：
自身

自身引用。