MedianRelativeAbsoluteError

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

中位数相对绝对误差 (MdRAE)。

在相对误差指标中，首先通过将个体预测误差除以使用基准方法在同一索引位置计算的误差来计算相对误差。如果基准方法的误差为零，则返回一个大值。

MdRAE 将中位数绝对误差 (MdAE) 应用于结果相对误差。

参数:

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

GeometricMeanRelativeAbsoluteError

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 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)
np.float64(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)
np.float64(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)
np.float64(0.7499999999999999)

方法

__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])	中位数相对绝对误差 (MdRAE)。
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)

中位数相对绝对误差 (MdRAE)。

在相对误差指标中，首先通过将个体预测误差除以使用基准方法在同一索引位置计算的误差来计算相对误差。如果基准方法的误差为零，则返回一个大值。

MdRAE 将中位数绝对误差 (MdAE) 应用于结果相对误差。

参数:

y_truepd.Series, pd.DataFrame 或形状为 (fh,) 或 (fh, n_outputs) 的 np.array，其中 fh 是预测范围

真实（正确）目标值。

y_predpd.Series, pd.DataFrame 或形状为 (fh,) 或 (fh, n_outputs) 的 np.array，其中 fh 是预测范围

预测值。

y_pred_benchmark可选，pd.Series, pd.DataFrame 或形状为 (fh,) 或 (fh, n_outputs) 的 np.array，其中 fh 是预测范围，默认值=None

来自基准方法的预测值。

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

预测范围权重。

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

定义了如何聚合多变量（多输出）数据的指标。如果是数组类型，则使用这些值作为权重来平均误差。如果为 ‘raw_values’，则在多输出输入的情况下返回完整的误差集合。如果为 ‘uniform_average’，所有输出的误差以均匀权重进行平均。

返回值:

lossfloat

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

另请参阅

mean_relative_absolute_error

geometric_mean_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         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 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

• 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 -> 1D array-like，或 y_true: pd.DataFrame x y_pred: pd.DataFrame -> 1D array-like。

返回值:

lossfloat, 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 个变量计算的指标。

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

clone()

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

克隆是另一个没有共享引用且处于初始化后状态的对象。此函数等同于返回 self 的 sklearn.clone。

等同于构造一个新的 type(self) 实例，使用 self 的参数，即 type(self)(**self.get_params(deep=False))。

如果在 self 上设置了配置，则克隆也会具有与原始对象相同的配置，等同于调用 cloned_self.set_config(**self.get_config())。

在值上，也等同于调用 self.reset，但例外在于 clone 返回一个新对象，而不是像 reset 那样修改自身。

抛出异常:

如果克隆不符合规范，由于 faulty __init__ 方法的原因，则抛出 RuntimeError。

clone_tags(estimator, tag_names=None)

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

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

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

参数:

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 个元素是测试中 obj 的第 i 个实例的名称。命名约定为 {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 (1维或2维)

• Panel scitype = 时间序列集合，全局/面板预测。具有2级行 MultiIndex (instance, time) 的 pd.DataFrame，3D 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 -> 1D array-like，或 y_true: pd.DataFrame x y_pred: pd.DataFrame -> 1D array-like。

返回值:

lossfloat, 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 个变量计算的指标。

• 如果为 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 (1维或2维)

• Panel scitype = 时间序列集合，全局/面板预测。具有2级行 MultiIndex (instance, time) 的 pd.DataFrame，3D 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 -> 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" 或数组类型，则为 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_default任何类型，可选；默认值=None

如果找不到标签，则使用的默认/备用值。

返回值:

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_default任何类型，可选；默认值=None

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

raise_errorbool

当未找到标签时是否抛出 ValueError 异常

返回值:

tag_valueAny

self 中标签 tag_name 的值。如果找不到，则如果 raise_error 为 True 则抛出错误，否则返回 tag_value_default。

抛出异常:

ValueError, 如果 raise_error 为 True。

ValueError 异常会在 tag_name 不在 self.get_tags().keys() 的键中时抛出。

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 的 list 列表。

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

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

组合对象是一个包含其他对象作为参数的对象。在实例上调用，因为这可能因实例而异。

返回值:

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，则返回内存中序列化的 self；如果 path 是文件位置，则将 self 以 zip 文件形式存储在该位置

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

参数:

pathNone 或 文件位置 (str 或 Path)

如果是 None，self 将被保存到内存对象中；如果是文件位置，self 将被保存到该文件位置。如果

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

• path=”/home/stored/estimator” 时，zip 文件 estimator.zip 将被

存储在 /home/stored/ 中。

serialization_format：str，默认为 “pickle”

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

返回值:

如果 path 是 None - 内存中序列化的 self

如果 path 是文件位置 - 指向该文件的 ZipFile 对象

set_config(**config_dict)

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

参数:

config_dictdict

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

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

jupyter 内核如何显示 self 的实例

• “diagram” = html 框图表示

• “text” = 字符串输出

print_changed_onlybool，默认为 True

控制打印 self 时是仅列出自默认值不同的参数，还是列出所有参数名称和值。不嵌套，即仅影响 self，而不影响组件估计器。

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对 self 的引用。

注意

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

set_params(**params)

设置此对象的参数。

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

参数:

**paramsdict

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

返回值:

self对 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

用于控制随机整数生成的伪随机数生成器。传递整数可在多次函数调用中获得可重现的输出。

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对 self 的引用

set_tags(**tag_dict)

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

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

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

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

set_tags 方法应该只在对象的 __init__ 方法中、构造期间或通过 __init__ 构造后立即调用。

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

参数:

**tag_dictdict

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

返回值:

Self

对 self 的引用。