中位数绝对误差#

class MedianAbsoluteError(multioutput='uniform_average', multilevel='uniform_average', by_index=False)[源文件]#

中位数绝对误差 (MdAE)。

MdAE 输出是非负浮点数。最佳值为 0.0。

与 MAE 类似，MdAE 与数据处于同一量纲。由于 MAE 采用预测误差的绝对值而不是平方，因此 MAE 对大误差的惩罚程度小于 MdSE 或 RdMSE。

采用绝对误差的中位数而不是平均值也使得此指标对误差离群值更加鲁棒，因为中位数在存在离群值的情况下倾向于成为更鲁棒的集中趋势度量。

对于具有真实值 \(y_1, \dots, y_n\) 和预测值 \(\widehat{y}_1, \dots, \widehat{y}_n\) 的单变量非分层样本，在时间索引 \(t_1, \dots, t_n\) 处，调用 evaluate 或直接调用对象将返回中位数绝对误差，\(\text{median}\left(|y_i - \widehat{y}_i|\right)_{i=1}^{n}\)。

multioutput 和 multilevel 控制跨变量和层次索引的平均，详见下文。

evaluate_by_index 返回在时间索引 \(t_i\) 处的绝对误差 \(|y_i - \widehat{y}_i|\)，适用于输入中的所有时间索引 \(t_1, \dots, t_n\)。

参数::
multioutput{‘raw_values’, ‘uniform_average’} 或 shape 为

(n_outputs,) 的 array-like，默认值为 ‘uniform_average’

定义如何聚合多变量（多输出）数据的指标。

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

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

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

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

定义如何聚合层次数据（包含层级）的指标。

  • 如果为 'uniform_average' (默认)，则误差在各层级之间进行平均。

  • 如果为 'uniform_average_time'，则指标应用于所有数据，忽略层级索引。

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

by_indexbool，默认值为 False

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

  • 如果为 False，则直接调用指标对象将按时间点平均，等同于调用 evaluate 方法。

  • 如果为 True，则直接调用指标对象将评估每个时间点的指标，等同于调用 evaluate_by_index 方法。

另请参阅

MeanAbsoluteError
MeanSquaredError
MedianSquaredError

参考文献

Hyndman, R. J and Koehler, A. B. (2006). “Another look at measures of forecast accuracy”，《国际预测杂志》，第 22 卷，第 4 期。

示例

>>> import numpy as np
>>> from sktime.performance_metrics.forecasting import MedianAbsoluteError
>>> y_true = np.array([3, -0.5, 2, 7, 2])
>>> y_pred = np.array([2.5, 0.0, 2, 8, 1.25])
>>> mdae = MedianAbsoluteError()
>>> mdae(y_true, y_pred)
np.float64(0.5)
>>> y_true = np.array([[0.5, 1], [-1, 1], [7, -6]])
>>> y_pred = np.array([[0, 2], [-1, 2], [8, -5]])
>>> mdae(y_true, y_pred)
np.float64(0.75)
>>> mdae = MedianAbsoluteError(multioutput='raw_values')
>>> mdae(y_true, y_pred)
array([0.5, 1. ])
>>> mdae = MedianAbsoluteError(multioutput=[0.3, 0.7])
>>> mdae(y_true, y_pred)
np.float64(0.85)

方法

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

中位数绝对误差 (MdAE)。

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

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

load_from_path(serial)

从文件位置加载对象。

load_from_serial(serial)

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

reset()

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

save([path, serialization_format])

将序列化的自身保存到 bytes-like 对象或 (.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)[源文件]#

中位数绝对误差 (MdAE)。

MdAE 输出是非负浮点数。最佳值为 0.0。

与 MAE 类似，MdAE 与数据处于同一量纲。由于 MAE 采用预测误差的绝对值而不是平方，因此 MAE 对大误差的惩罚程度小于 MdSE 或 RdMSE。

采用绝对误差的中位数而不是平均值也使得此指标对误差离群值更加鲁棒，因为中位数在存在离群值的情况下倾向于成为更鲁棒的集中趋势度量。

参数::
y_truepd.Series, pd.DataFrame 或 shape 为 (fh,) 或 (fh, n_outputs) 的 np.array，其中 fh 是预测范围

真实 (正确) 目标值。

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

预测值。

horizon_weightshape 为 (fh,) 的 array-like，默认值为 None

预测范围权重。

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

定义如何聚合多变量（多输出）数据的指标。如果是 array-like，则其中的值用作误差平均的权重。如果为 ‘raw_values’，则在多输出输入情况下返回完整的误差集合。如果为 ‘uniform_average’，则所有输出的误差以 uniform 权重平均。

返回值::
lossfloat

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

另请参阅

mean_absolute_error
mean_squared_error
median_squared_error
geometric_mean_absolute_error
geometric_mean_squared_error

参考文献

Hyndman, R. J and Koehler, A. B. (2006). “Another look at measures of forecast accuracy”，《国际预测杂志》，第 22 卷，第 4 期。

示例

>>> import numpy as np
>>> from sktime.performance_metrics.forecasting import median_absolute_error
>>> y_true = np.array([3, -0.5, 2, 7, 2])
>>> y_pred = np.array([2.5, 0.0, 2, 8, 1.25])
>>> median_absolute_error(y_true, y_pred)
0.5
>>> y_true = np.array([[0.5, 1], [-1, 1], [7, -6]])
>>> y_pred = np.array([[0, 2], [-1, 2], [8, -5]])
>>> median_absolute_error(y_true, y_pred)
0.75
>>> median_absolute_error(y_true, y_pred, multioutput='raw_values')
array([0.5, 1. ])
>>> median_absolute_error(y_true, y_pred, multioutput=[0.3, 0.7])
0.85
__call__(y_true, y_pred, **kwargs)[源文件]#

使用底层指标函数计算指标值。

参数::
y_true\code{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 typed pd.DataFrame

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

有关数据格式的更多详细信息，请参阅 mtype 术语表。有关用法，请参阅预测教程 examples/01_forecasting.ipynb

y_pred\code{sktime} 兼容数据容器格式的时间序列

用于与真实值进行评估的预测值。格式必须与 y_true 相同，如果带有索引，则索引和列也必须相同。

y_pred_benchmark可选，\code{sktime} 兼容数据容器格式的时间序列

用于比较 y_pred 的基准预测值，用于相对指标。仅当指标需要基准预测值时才需要提供，由标签 requires-y-pred-benchmark 指示。否则，可以传递以确保接口一致性，但会被忽略。格式必须与 y_true 相同，如果带有索引，则索引和列也必须相同。

y_train可选，\code{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”``。该值为跨变量和层级平均后的指标值（参阅类文档字符串）

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

  • 如果 multilevel="raw_values"，则为 pd.DataFrame。如果 multioutput="uniform_average"，shape 为 (n_levels, )；如果 multioutput="raw_values"，shape 为 (n_levels, y_true.columns)。指标按层级应用，行平均（是/否）与 multioutput 中的设置相同。

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 兼容对象都有一个标签字典。标签可用于存储关于对象的元数据，或控制对象的行为。

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

在直接通过 __init__ 构造后，clone_tags 方法应仅在对象的 __init__ 方法中调用。

或者在构造期间。

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

tag_names 的默认值将 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”

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

返回值::
instance带有默认参数的类实例
classmethod create_test_instances_and_names(parameter_set='default')[源文件]#

创建所有测试实例的列表以及它们的名称列表。

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

要返回的测试参数集的名称，用于测试。如果未为某个值定义特殊参数，将返回 \cite{“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\code{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 typed pd.DataFrame

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

有关数据格式的更多详细信息，请参阅 mtype 术语表。有关用法，请参阅预测教程 examples/01_forecasting.ipynb

y_pred\code{sktime} 兼容数据容器格式的时间序列

用于与真实值进行评估的预测值。格式必须与 y_true 相同，如果带有索引，则索引和列也必须相同。

y_pred_benchmark可选，\code{sktime} 兼容数据容器格式的时间序列

用于比较 y_pred 的基准预测值，用于相对指标。仅当指标需要基准预测值时才需要提供，由标签 requires-y-pred-benchmark 指示。否则，可以传递以确保接口一致性，但会被忽略。格式必须与 y_true 相同，如果带有索引，则索引和列也必须相同。

y_train可选，\code{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”``。该值为跨变量和层级平均后的指标值（参阅类文档字符串）

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

  • 如果 multilevel="raw_values"，则为 pd.DataFrame。如果 multioutput="uniform_average"，shape 为 (n_levels, )；如果 multioutput="raw_values"，shape 为 (n_levels, y_true.columns)。指标按层级应用，行平均（是/否）与 multioutput 中的设置相同。

evaluate_by_index(y_true, y_pred, **kwargs)[源文件]#

返回在每个时间点评估的指标。

参数::
y_true\code{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 typed pd.DataFrame

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

有关数据格式的更多详细信息，请参阅 mtype 术语表。有关用法，请参阅预测教程 examples/01_forecasting.ipynb

y_pred\code{sktime} 兼容数据容器格式的时间序列

用于与真实值进行评估的预测值。格式必须与 y_true 相同，如果带有索引，则索引和列也必须相同。

y_pred_benchmark可选，\code{sktime} 兼容数据容器格式的时间序列

用于比较 y_pred 的基准预测值，用于相对指标。仅当指标需要基准预测值时才需要提供，由标签 requires-y-pred-benchmark 指示。否则，可以传递以确保接口一致性，但会被忽略。格式必须与 y_true 相同，如果带有索引，则索引和列也必须相同。

y_train可选，\code{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-th 条目是时间点 i、变量 j 的指标值。

classmethod get_class_tag(tag_name, tag_value_default=None)[源文件]#

从类获取类标签值，包含从父类继承的标签级别。

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

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

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

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

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

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

按继承顺序排列。

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

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

参数::
tag_namestr

标签值的名称。

tag_value_default任意类型

如果未找到标签，则为默认/备用值。

返回值::
tag_value

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

classmethod get_class_tags()[源文件]#

从类获取类标签，包含从父类继承的标签级别。

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

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

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

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

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

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

get_tag(tag_name, tag_value_default=None, raise_error=True)[源文件]#

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

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

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

  2. 在父类的 _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。

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

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

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

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

get_tags()[源文件]#

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

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

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

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

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

按继承顺序排列。

返回值::
collected_tagsdict

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

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

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

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

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

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

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

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

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

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

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

is_composite()[source]#

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

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

返回值::
composite: bool

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

classmethod load_from_path(serial)[source]#

从文件位置加载对象。

参数::
serialZipFile(path).open(“object) 的结果
返回值::
反序列化 self，结果输出到 path，是 cls.save(path) 的输出。
classmethod load_from_serial(serial)[source]#

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

参数::
serialcls.save(None) 输出的第一个元素
返回值::
反序列化 self，结果输出是 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]#

将序列化的自身保存到 bytes-like 对象或 (.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" 则会在

/home/stored/ 中存储一个 zip 文件 estimator.zip。

serialization_format: str, 默认 = “pickle”

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

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

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

参数::
config_dictdict

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

displaystr, “diagram” (默认), 或 “text”

jupyter kernel 如何显示 self 的实例

  • “diagram” = html 框图表示

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

print_changed_onlybool, 默认=True

打印 self 时是否只列出与默认值不同的 self 参数 (True)，或所有参数名称和值 (False)。不会嵌套，即只影响 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”; 要使用的 logger 名称。

    • “mute_warnings”: bool, 默认=False; 如果为 True，则抑制警告。

返回值::
selfself 的引用。

注意

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

set_params(**params)[source]#

设置此对象的参数。

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

参数::
**paramsdict

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

返回值::
self对 self 的引用（参数设置后）
set_random_state(random_state=None, deep=True, self_policy='copy')[source]#

为自身设置 random_state 伪随机种子参数。

通过 self.get_params 查找名为 random_state 的参数，并通过 set_params 将它们设置为通过 sample_dependent_seed 从 random_state 派生的整数。这些整数通过链式哈希采样，保证种子随机生成器的伪随机独立性。

根据 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 对象的参数（即组件估计器）中设置 random state。

  • 如果为 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，

从输入的 random_state 派生，通常与其不同

返回值::
self对 self 的引用
set_tags(**tag_dict)[source]#

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

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

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

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

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

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

参数::
**tag_dictdict

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

返回值::
Self

对 self 的引用。