几何平均绝对误差#

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

几何平均绝对误差 (GMAE)。

GMAE 输出为非负浮点数。最佳值近似于零，而不是零。

与 MAE 和 MdAE 类似，GMAE 的度量单位与输入数据相同。由于 GMAE 使用预测误差的绝对值而不是平方，MAE 对大误差的惩罚程度低于平方误差变体，如 MSE、RMSE、GMSE 或 RGMSE。

参数:
multioutput{‘raw_values’, ‘uniform_average’} 或 shape (n_outputs,) 的类似数组，默认为 ‘uniform_average’

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

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

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

另请参阅

mean_absolute_error
median_absolute_error
mean_squared_error
median_squared_error
geometric_mean_squared_error

注释

几何平均数在其计算中使用了值的乘积。零值的存在将导致结果为零，即使所有其他值都很大。为了在 y_true 和 y_pred 元素相等（误差为零）的情况下部分解决此问题，计算中的零误差值会被替换为一个小值。这导致指标可以取的最小值（当 y_true 等于 y_pred 时）接近零，但不是完全为零。

参考资料

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 GeometricMeanAbsoluteError
>>> y_true = np.array([3, -0.5, 2, 7, 2])
>>> y_pred = np.array([2.5, 0.0, 2, 8, 1.25])
>>> gmae = GeometricMeanAbsoluteError()
>>> gmae(y_true, y_pred)
np.float64(0.000529527232030127)
>>> y_true = np.array([[0.5, 1], [-1, 1], [7, -6]])
>>> y_pred = np.array([[0, 2], [-1, 2], [8, -5]])
>>> gmae(y_true, y_pred)
np.float64(0.5000024031086919)
>>> gmae = GeometricMeanAbsoluteError(multioutput='raw_values')
>>> gmae(y_true, y_pred)
array([4.80621738e-06, 1.00000000e+00])
>>> gmae = GeometricMeanAbsoluteError(multioutput=[0.3, 0.7])
>>> gmae(y_true, y_pred)
np.float64(0.7000014418652152)

方法

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

几何平均绝对误差 (GMAE)。

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

将序列化的自身保存到字节类对象或 (.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]#

几何平均绝对误差 (GMAE)。

GMAE 输出为非负浮点数。最佳值近似于零，而不是零。

与 MAE 和 MdAE 类似，GMAE 的度量单位与输入数据相同。由于 GMAE 使用预测误差的绝对值而不是平方，MAE 对大误差的惩罚程度低于平方误差变体，如 MSE、RMSE、GMSE 或 RGMSE。

参数:
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,) 的类似数组，默认为 None

预测范围权重。

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

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

返回:
lossfloat

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

另请参阅

mean_absolute_error
median_absolute_error
mean_squared_error
median_squared_error
geometric_mean_squared_error

注释

几何平均数在其计算中使用了值的乘积。零值的存在将导致结果为零，即使所有其他值都很大。为了在 y_true 和 y_pred 元素相等（误差为零）的情况下部分解决此问题，计算中的零误差值会被替换为一个小值。这导致指标可以取的最小值（当 y_true 等于 y_pred 时）接近零，但不是完全为零。

参考资料

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     geometric_mean_absolute_error
>>> y_true = np.array([3, -0.5, 2, 7, 2])
>>> y_pred = np.array([2.5, 0.0, 2, 8, 1.25])
>>> geometric_mean_absolute_error(y_true, y_pred)
0.000529527232030127
>>> y_true = np.array([[0.5, 1], [-1, 1], [7, -6]])
>>> y_pred = np.array([[0, 2], [-1, 2], [8, -5]])
>>> geometric_mean_absolute_error(y_true, y_pred)
0.5000024031086919
>>> geometric_mean_absolute_error(y_true, y_pred, multioutput='raw_values')
array([4.80621738e-06, 1.00000000e+00])
>>> geometric_mean_absolute_error(y_true, y_pred, multioutput=[0.3, 0.7])
0.7000014418652152
__call__(y_true, y_pred, **kwargs)[source]#

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

参数:
y_truesktime 兼容数据容器格式的时间序列。

真实（正确）目标值。

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

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

  • Panel scitype = 时间序列集合，全局/面板预测。pd.DataFrame 具有 2 级行 MultiIndex (实例, 时间)，3D np.ndarray (实例, 变量, 时间)，list 的 Series 类型 pd.DataFrame

  • Hierarchical scitype = 层次集合，用于层次预测。pd.DataFrame 具有 3 级或更多级行 MultiIndex (层次_1, ..., 层次_n, 时间)

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

y_predsktime 兼容数据容器格式的时间序列

用于评估真实值的预测值。必须与 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 类似数组或可调用对象，默认为 None

每个时间点的样本权重。

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

  • 如果是数组，则必须是 1D。如果 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”``。值是变量和级别上的平均指标（参见类 docstring）

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

  • pd.DataFrame 如果 multilevel="raw_values"。shape 为 (n_levels, )，如果 multioutput="uniform_average"；shape 为 (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。

引发:
如果克隆不符合要求，由于错误的 __init__，则引发 RuntimeError。
clone_tags(estimator, tag_names=None)[source]#

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

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

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

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

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')[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_truesktime 兼容数据容器格式的时间序列。

真实（正确）目标值。

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

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

  • Panel scitype = 时间序列集合，全局/面板预测。pd.DataFrame 具有 2 级行 MultiIndex (实例, 时间)，3D np.ndarray (实例, 变量, 时间)，list 的 Series 类型 pd.DataFrame

  • Hierarchical scitype = 层次集合，用于层次预测。pd.DataFrame 具有 3 级或更多级行 MultiIndex (层次_1, ..., 层次_n, 时间)

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

y_predsktime 兼容数据容器格式的时间序列

用于评估真实值的预测值。必须与 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 类似数组或可调用对象，默认为 None

每个时间点的样本权重或可调用对象。

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

  • 如果是数组，则必须是 1D。如果 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”``。值是变量和级别上的平均指标（参见类 docstring）

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

  • pd.DataFrame 如果 multilevel="raw_values"。shape 为 (n_levels, )，如果 multioutput="uniform_average"；shape 为 (n_levels, y_true.columns)，如果 multioutput="raw_values"。指标按级别应用，行平均（是/否）如 multioutput 中所述。

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

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

参数:
y_truesktime 兼容数据容器格式的时间序列。

真实（正确）目标值。

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

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

  • Panel scitype = 时间序列集合，全局/面板预测。pd.DataFrame 具有 2 级行 MultiIndex (实例, 时间)，3D np.ndarray (实例, 变量, 时间)，list 的 Series 类型 pd.DataFrame

  • Hierarchical scitype = 层次集合，用于层次预测。pd.DataFrame 具有 3 级或更多级行 MultiIndex (层次_1, ..., 层次_n, 时间)

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

y_predsktime 兼容数据容器格式的时间序列

用于评估真实值的预测值。必须与 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 类似数组或可调用对象，默认为 None

每个时间点的样本权重或可调用对象。

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

  • 如果是数组，则必须是 1D。如果 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，则按其加权。

  • 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任何类型

如果找不到标签，则为默认/回退值。

返回:
tag_value

self 中 tag_name 标签的值。如果找不到，返回 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，但不包括组件的参数。

返回:
params键为 str 值的 dict

参数字典，paramname : paramvalue 键值对包括

  • always: 此对象的所有参数，如通过 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

self 中 tag_name 标签的值。如果找不到，且 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，或 dict 列表。

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

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

参数:
parameter_setstr，默认为“default”

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

返回:
paramsdict 或 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 调用会删除所有对象属性，除了

  • 超参数 = 写入 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”，则将在当前工作目录 (cwd) 创建一个 zip 文件 estimator.zip。

  • path=”/home/stored/estimator”，则将在 /home/stored/ 中创建一个 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 kernels 如何显示对象实例

  • “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>。如果引用是明确的，也可以使用不带 <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_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

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

返回:
Self

对自身的引用。