平均相对绝对误差

class MeanRelativeAbsoluteError(multioutput='uniform_average', multilevel='uniform_average', by_index=False)

平均相对绝对误差 (MRAE)。

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

MRAE 将平均绝对误差 (MAE) 应用于生成的相对误差。

参数：

multioutput{‘raw_values’, ‘uniform_average’} 或 array-like of shape (n_outputs,), 默认为’uniform_average’

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

• 如果是 array-like，则值用作平均误差的权重。

• 如果是 '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 方法。

另请参阅

MedianRelativeAbsoluteError

GeometricMeanRelativeAbsoluteError

GeometricMeanRelativeSquaredError

参考文献

Hyndman, R. J and Koehler, A. B. (2006). “对预测精度度量的再探讨”, International Journal of Forecasting, Volume 22, Issue 4.

示例

>>> import numpy as np
>>> from sktime.performance_metrics.forecasting import MeanRelativeAbsoluteError
>>> 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
>>> mrae = MeanRelativeAbsoluteError()
>>> mrae(y_true, y_pred, y_pred_benchmark=y_pred_benchmark)
np.float64(0.9511111111111111)
>>> 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
>>> mrae(y_true, y_pred, y_pred_benchmark=y_pred_benchmark)
np.float64(0.8703703703703702)
>>> mrae = MeanRelativeAbsoluteError(multioutput='raw_values')
>>> mrae(y_true, y_pred, y_pred_benchmark=y_pred_benchmark)
array([0.51851852, 1.22222222])
>>> mrae = MeanRelativeAbsoluteError(multioutput=[0.3, 0.7])
>>> mrae(y_true, y_pred, y_pred_benchmark=y_pred_benchmark)
np.float64(1.0111111111111108)

方法

__call__(y_true, y_pred, **kwargs)	使用底层度量函数计算度量值。
克隆()	获取具有相同超参数和配置的对象的克隆。
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])	平均相对绝对误差 (MRAE)。
get_class_tag(tag_name[, tag_value_default])	从类中获取类标签值，并从父类继承标签级别。
获取类标签()	从类中获取类标签，并从父类继承标签级别。
获取配置()	获取对象的配置标志。
获取参数默认值()	获取对象的默认参数。
get_param_names([sort])	获取对象的参数名称。
get_params([deep])	获取此对象的参数值字典。
get_tag(tag_name[, tag_value_default, ...])	从实例获取标签值，包含标签级别继承和覆盖。
获取标签()	从实例获取标签，包含标签级别继承和覆盖。
get_test_params([parameter_set])	返回skbase对象的测试参数设置。
是复合对象()	检查对象是否由其他 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)	将实例级别的标签覆盖设置为给定值。

func(y_pred, horizon_weight=None, multioutput='uniform_average', **kwargs)

平均相对绝对误差 (MRAE)。

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

MRAE 将平均绝对误差 (MAE) 应用于生成的相对误差。

参数：

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_weightarray-like of shape (fh,), 默认为 None

预测范围权重。

multioutput{‘raw_values’, ‘uniform_average’} 或 array-like of shape (n_outputs,), 默认为’uniform_average’

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

返回值：

lossfloat

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

另请参阅

median_relative_absolute_error

geometric_mean_relative_absolute_error

geometric_mean_relative_squared_error

参考文献

Hyndman, R. J and Koehler, A. B. (2006). “对预测精度度量的再探讨”, International Journal of Forecasting, Volume 22, Issue 4.

示例

>>> import numpy as np
>>> from sktime.performance_metrics.forecasting import 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
>>> mean_relative_absolute_error(y_true, y_pred,     y_pred_benchmark=y_pred_benchmark)
0.9511111111111111
>>> 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
>>> mean_relative_absolute_error(y_true, y_pred,     y_pred_benchmark=y_pred_benchmark)
0.8703703703703702
>>> mean_relative_absolute_error(y_true, y_pred,     y_pred_benchmark=y_pred_benchmark, multioutput='raw_values')
array([0.51851852, 1.22222222])
>>> mean_relative_absolute_error(y_true, y_pred,     y_pred_benchmark=y_pred_benchmark, multioutput=[0.3, 0.7])
1.0111111111111108

__call__(y_true, y_pred, **kwargs)

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

参数：

y_true时间序列，采用 sktime 兼容的数据容器格式。

真实（正确）目标值。

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

• Series scitype = 单个时间序列，普通预测。pd.DataFrame, pd.Series, 或 np.ndarray (1D 或 2D)

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

• Hierarchical scitype = 分层集合，用于分层预测。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可选，1D array-like, 或 callable, 默认为 None

每个时间点的样本权重。

• 如果为 None，则时间索引被认为权重相等。

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

• 如果是一个 callable，则必须遵循 SampleWeightGenerator 接口，或具有以下签名之一：y_true: pd.DataFrame -> 1D array-like，或 y_true: pd.DataFrame x y_pred: pd.DataFrame -> 1D array-like。

返回值：

lossfloat, np.ndarray, 或 pd.DataFrame

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

• 如果 multioutput="uniform_average" 或 array-like，且 multilevel="uniform_average" 或 “uniform_average_time”，则为 float。值是跨变量和层级平均的度量（参见类文档字符串）

• 如果 multioutput=”raw_values”` 且 multilevel="uniform_average" 或 "uniform_average_time"，则为 np.ndarray，形状为 (y_true.columns,)。第 i 个条目是为第 i 个变量计算的度量。

• 如果 multilevel="raw_values"，则为 pd.DataFrame。如果 multioutput="uniform_average"，形状为 (n_levels, )；如果 multioutput="raw_values"，形状为 (n_levels, y_true.columns)。度量按层级应用，行平均（是/否）与 multioutput 中的一致。

clone()

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

克隆是另一个对象，没有共享引用，处于初始化后状态。此函数等效于返回 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)

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

每个 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 或 list of str, 默认为 None

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

返回值：

self

对 self 的引用。

classmethod create_test_instance(parameter_set='default')

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

参数：

parameter_setstr, 默认为 “default”

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

返回值：

instance具有默认参数的类实例

classmethod create_test_instances_and_names(parameter_set='default')

创建所有测试实例列表及其名称列表。

参数：

parameter_setstr, 默认为 “default”

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

返回值：

objscls 实例列表

第 i 个实例是 cls(**cls.get_test_params()[i])

namesstr 列表，长度与 objs 相同

第 i 个元素是测试中第 i 个 obj 实例的名称。命名约定为 {cls.__name__}-{i} 如果有多个实例，否则为 {cls.__name__}

evaluate(y_true, y_pred, **kwargs)

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

参数：

y_true时间序列，采用 sktime 兼容的数据容器格式。

真实（正确）目标值。

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

• Series scitype = 单个时间序列，普通预测。pd.DataFrame, pd.Series, 或 np.ndarray (1D 或 2D)

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

• Hierarchical scitype = 分层集合，用于分层预测。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可选，1D array-like, 或 callable, 默认为 None

每个时间点的样本权重或 callable。

• 如果为 None，则时间索引被认为权重相等。

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

• 如果是一个 callable，则必须遵循 SampleWeightGenerator 接口，或具有以下签名之一：y_true: pd.DataFrame -> 1D array-like，或 y_true: pd.DataFrame x y_pred: pd.DataFrame -> 1D array-like。

返回值：

lossfloat, np.ndarray, 或 pd.DataFrame

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

• 如果 multioutput="uniform_average" 或 array-like，且 multilevel="uniform_average" 或 “uniform_average_time”，则为 float。值是跨变量和层级平均的度量（参见类文档字符串）

• 如果 multioutput=”raw_values”` 且 multilevel="uniform_average" 或 "uniform_average_time"，则为 np.ndarray，形状为 (y_true.columns,)。第 i 个条目是为第 i 个变量计算的度量。

• 如果 multilevel="raw_values"，则为 pd.DataFrame。如果 multioutput="uniform_average"，形状为 (n_levels, )；如果 multioutput="raw_values"，形状为 (n_levels, y_true.columns)。度量按层级应用，行平均（是/否）与 multioutput 中的一致。

evaluate_by_index(y_true, y_pred, **kwargs)

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

参数：

y_true时间序列，采用 sktime 兼容的数据容器格式。

真实（正确）目标值。

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

• Series scitype = 单个时间序列，普通预测。pd.DataFrame, pd.Series, 或 np.ndarray (1D 或 2D)

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

• Hierarchical scitype = 分层集合，用于分层预测。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可选，1D array-like, 或 callable, 默认为 None

每个时间点的样本权重或 callable。

• 如果为 None，则时间索引被认为权重相等。

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

• 如果是一个 callable，则必须遵循 SampleWeightGenerator 接口，或具有以下签名之一：y_true: pd.DataFrame -> 1D array-like，或 y_true: pd.DataFrame x y_pred: pd.DataFrame -> 1D array-like。

返回值：

losspd.Series 或 pd.DataFrame

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

• 如果 multioutput="uniform_average" 或 array-like，则为 pd.Series。索引与 y_true 的索引相同；索引 i 处的条目是时间点 i 的度量，按变量平均。

• 如果 multioutput="raw_values"，则为 pd.DataFrame。索引和列与 y_true 的相同；i,j 条目是时间点 i、变量 j 的度量。

classmethod get_class_tag(tag_name, tag_value_default=None)

从类中获取类标签值，并从父类继承标签级别。

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

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

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

它返回名称为 tag_name 的标签值，考虑标签覆盖，优先级按降序排列如下：

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

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

按继承顺序。

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

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

参数：

tag_namestr

标签值的名称。

tag_value_defaultany type

如果未找到标签，则使用的默认/回退值。

返回值：

tag_value

self 中 tag_name 标签的值。如果未找到，则返回 tag_value_default。

classmethod get_class_tags()

从类中获取类标签，并从父类继承标签级别。

每个 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()

获取对象的配置标志。

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

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

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

在 clone 或 reset 调用期间，配置会保留。

返回值：

config_dictdict

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

classmethod get_param_defaults()

获取对象的默认参数。

返回值：

default_dict: dict[str, Any]

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

classmethod get_param_names(sort=True)

获取对象的参数名称。

参数：

sortbool, 默认为 True

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

返回值：

param_names: list[str]

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

get_params(deep=True)

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

参数：

deepbool, 默认为 True

是否返回组件的参数。

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

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

返回值：

params键为 str 值的 dict

参数字典，键为 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)

从实例获取标签值，包含标签级别继承和覆盖。

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

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

get_tag 方法从实例中检索名称为 tag_name 的单个标签值，考虑标签覆盖，优先级按降序排列如下：

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

在实例构造时。

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

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

按继承顺序。

参数：

tag_namestr

要检索的标签名称

tag_value_defaultany type, 可选；默认为 None

如果未找到标签，则使用的默认/回退值。

raise_errorbool

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

返回值：

tag_valueAny

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

引发：

ValueError，如果 raise_error 为 True。

如果 tag_name 不在 self.get_tags().keys() 中，则会引发 ValueError。

get_tags()

从实例获取标签，包含标签级别继承和覆盖。

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

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

get_tags 方法返回一个标签字典，其键是类或其任何父类中设置的 _tags 的任何属性的键，或通过 set_tags 或 clone_tags 设置的标签。

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

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

在实例构造时。

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

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

按继承顺序。

返回值：

collected_tagsdict

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

classmethod get_test_params(parameter_set='default')

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

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

get_test_params 应该返回一个 dict，或一个 dict 列表。

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

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

参数：

parameter_setstr, 默认为 “default”

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

返回值：

paramsdict 或 list of dict, 默认为 {}

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

is_composite()

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

复合对象是指参数中包含其他对象的对象。在实例上调用，因为这可能因实例而异。

返回值：

composite: bool

对象是否包含任何值为 BaseObject 后代实例的参数。

classmethod load_from_path(serial)

从文件位置加载对象。

参数：

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 调用删除任何对象属性，除了

• 超参数 = __init__ 的参数写入 self，例如 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

打印对象时是否仅列出与默认值不同的对象参数 (False)，或所有参数名称和值 (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>__。

参数：

**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_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 以在多次函数调用中获得可重现的输出。

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 中指定的值，键为标签名称，字典值为要设置的标签值。

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

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

参数：

**tag_dictdict

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

返回值：

对象

对对象的引用。