MeanAsymmetricError#

class MeanAsymmetricError(multioutput='uniform_average', multilevel='uniform_average', asymmetric_threshold=0, left_error_function='squared', right_error_function='absolute', left_error_penalty=1.0, right_error_penalty=1.0, by_index=False)[source]#

计算非对称损失函数的均值。

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

小于非对称阈值的误差值应用 left_error_function。大于或等于非对称阈值的误差值应用 right_error_function。

许多预测损失函数（例如 [1] 中讨论的那些）假设高估和低估应该受到同等的惩罚。然而，这可能与预测用户面临的实际成本不符。当低估和高估的成本不同时，非对称损失函数很有用。

将 asymmetric_threshold 设置为零，left_error_function 设置为“squared”，right_error_function 设置为“absolute” 会对高估（y_true - y_pred < 0）施加更大的惩罚。将 left_error_function 设置为“absolute”，将 right_error_function 设置为“squared” 则效果相反。

left_error_penalty 和 right_error_penalty 可用于对高估和低估施加不同的乘法惩罚。

参数:
asymmetric_thresholdfloat, default = 0.0

用于非对称损失函数阈值化的值。小于非对称阈值的误差值应用 left_error_function。大于或等于非对称阈值的误差值应用 right_error_function。

left_error_function{‘squared’, ‘absolute’}, default=’squared’

应用于小于非对称阈值的误差值的损失惩罚。

right_error_function{‘squared’, ‘absolute’}, default=’absolute’

应用于大于或等于非对称阈值的误差值的损失惩罚。

left_error_penaltyint or float, default=1.0

对小于非对称阈值的误差值施加额外的乘法惩罚。

right_error_penaltyint or float, default=1.0

对大于非对称阈值的误差值施加额外的乘法惩罚。

multioutput{‘raw_values’, ‘uniform_average’} or array-like of shape (n_outputs,), default=’uniform_average’

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

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

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

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

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

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

  • 如果是 'uniform_average' (默认)，误差在各层级平均。

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

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

by_indexbool, default=False

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

  • 如果为 False，直接调用指标对象会在时间点上平均，等同于调用 ``evaluate`` 方法。

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

另请参阅

mean_linex_error

备注

将 left_error_function 和 right_error_function 设置为“absolute”，但为 left_error_penalty 和 right_error_penalty 选择不同的值，会得到 [2] 中讨论的“lin-lin”误差函数。

参考文献

[1]

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

[2]

Diebold, Francis X. (2007). “Elements of Forecasting (4th ed.)”, Thomson, South-Western: Ohio, US.

示例

>>> import numpy as np
>>> from sktime.performance_metrics.forecasting import MeanAsymmetricError
>>> y_true = np.array([3, -0.5, 2, 7, 2])
>>> y_pred = np.array([2.5, 0.0, 2, 8, 1.25])
>>> asymmetric_error = MeanAsymmetricError()
>>> asymmetric_error(y_true, y_pred)  
np.float64(0.5)
>>> asymmetric_error = MeanAsymmetricError(left_error_function='absolute',     right_error_function='squared')
>>> asymmetric_error(y_true, y_pred)  
np.float64(0.4625)
>>> y_true = np.array([[0.5, 1], [-1, 1], [7, -6]])
>>> y_pred = np.array([[0, 2], [-1, 2], [8, -5]])
>>> asymmetric_error = MeanAsymmetricError()
>>> asymmetric_error(y_true, y_pred)  
np.float64(0.75)
>>> asymmetric_error = MeanAsymmetricError(left_error_function='absolute',     right_error_function='squared')
>>> asymmetric_error(y_true, y_pred)  
np.float64(0.7083333333333334)
>>> asymmetric_error = MeanAsymmetricError(multioutput='raw_values')
>>> asymmetric_error(y_true, y_pred)  
array([0.5, 1. ])
>>> asymmetric_error = MeanAsymmetricError(multioutput=[0.3, 0.7])
>>> asymmetric_error(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[, asymmetric_threshold, ...])

计算非对称损失函数的均值。

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

返回估计器的测试参数设置。

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, asymmetric_threshold=0.0, left_error_function='squared', right_error_function='absolute', left_error_penalty=1.0, right_error_penalty=1.0, horizon_weight=None, multioutput='uniform_average', **kwargs)[source]#

计算非对称损失函数的均值。

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

小于非对称阈值的误差值应用 left_error_function。大于或等于非对称阈值的误差值应用 right_error_function。

许多预测损失函数（例如 [1] 中讨论的那些）假设高估和低估应该受到同等的惩罚。然而，这可能与预测用户面临的实际成本不符。当低估和高估的成本不同时，非对称损失函数很有用。

将 asymmetric_threshold 设置为零，left_error_function 设置为“squared”，right_error_function 设置为“absolute” 会对高估（y_true - y_pred < 0）施加更大的惩罚。将 left_error_function 设置为“absolute”，将 right_error_function 设置为“squared” 则效果相反。

left_error_penalty 和 right_error_penalty 可用于对高估和低估施加不同的乘法惩罚。

参数:
y_truepd.Series, pd.DataFrame or np.array of shape (fh,) or (fh, n_outputs) where fh is the forecasting horizon

真实（正确）目标值。

y_predpd.Series, pd.DataFrame or np.array of shape (fh,) or (fh, n_outputs) where fh is the forecasting horizon

预测值。

asymmetric_thresholdfloat, default = 0.0

用于非对称损失函数阈值化的值。小于非对称阈值的误差值应用 left_error_function。大于或等于非对称阈值的误差值应用 right_error_function。

left_error_function{‘squared’, ‘absolute’}, default=’squared’

应用于小于非对称阈值的误差值的损失惩罚。

right_error_function{‘squared’, ‘absolute’}, default=’absolute’

应用于大于或等于非对称阈值的误差值的损失惩罚。

left_error_penaltyint or float, default=1.0

对小于非对称阈值的误差值施加额外的乘法惩罚。

right_error_penaltyint or float, default=1.0

对大于非对称阈值的误差值施加额外的乘法惩罚。

horizon_weightarray-like of shape (fh,), default=None

预测期权重。

multioutput{‘raw_values’, ‘uniform_average’} or array-like of shape (n_outputs,), default=’uniform_average’

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

返回值:
asymmetric_lossfloat

使用误差上的非对称惩罚计算的损失。如果 multioutput 为“raw_values”，则为每个输出单独返回非对称损失。如果 multioutput 为“uniform_average”或权重 ndarray，则返回所有输出误差的加权平均非对称损失。

另请参阅

mean_linex_error

备注

将 left_error_function 和 right_error_function 设置为“absolute”，但为 left_error_penalty 和 right_error_penalty 选择不同的值，会得到 [2] 中讨论的“lin-lin”误差函数。

参考文献

[1]

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

[2]

Diebold, Francis X. (2007). “Elements of Forecasting (4th ed.)”, Thomson, South-Western: Ohio, US.

示例

>>> import numpy as np
>>> from sktime.performance_metrics.forecasting import mean_asymmetric_error
>>> y_true = np.array([3, -0.5, 2, 7, 2])
>>> y_pred = np.array([2.5, 0.0, 2, 8, 1.25])
>>> mean_asymmetric_error(y_true, y_pred)
0.5
>>> mean_asymmetric_error(y_true, y_pred, left_error_function='absolute',     right_error_function='squared')
0.4625
>>> y_true = np.array([[0.5, 1], [-1, 1], [7, -6]])
>>> y_pred = np.array([[0, 2], [-1, 2], [8, -5]])
>>> mean_asymmetric_error(y_true, y_pred)
0.75
>>> mean_asymmetric_error(y_true, y_pred, left_error_function='absolute',     right_error_function='squared')
0.7083333333333334
>>> mean_asymmetric_error(y_true, y_pred, multioutput='raw_values')
array([0.5, 1. ])
>>> mean_asymmetric_error(y_true, y_pred, multioutput=[0.3, 0.7])
0.85
classmethod get_test_params(parameter_set='default')[source]#

返回估计器的测试参数设置。

参数:
parameter_setstr, default=”default”

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

返回值:
paramsdict or list of dict, default = {}

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

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

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

参数:
y_true符合 sktime 兼容数据容器格式的时间序列。

真实（正确）目标值。

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

  • Series scitype = 单个时间序列，普通预测。pd.DataFrame, pd.Series, 或 np.ndarray (1D or 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符合 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 数组状，或可调用对象，默认=None

每个时间点的样本权重。

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

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

  • 如果是可调用对象，必须遵循 SampleWeightGenerator 接口，或具有以下签名之一： y_true: pd.DataFrame -> 1D array-like, or y_true: pd.DataFrame x y_pred: pd.DataFrame -> 1D array-like。

返回值:
lossfloat, np.ndarray, or pd.DataFrame

计算的指标，按变量平均或分开。如果提供 sample_weight，则按其加权。

  • 如果 multioutput="uniform_average" 或 数组状，且 ``multilevel="uniform_average" 或 “uniform_average_time”``，则为 float。该值是变量和层级上的平均指标（参见类文档字符串）

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

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

clone()[source]#

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

克隆是与原始对象不同的对象，不共享引用，处于初始化后状态。此函数等同于返回 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 会改变 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 的默认值会将 estimator 中的所有标签写入 self。

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

参数:
estimator:class:BaseObject 或派生类的实例
tag_namesstr 或 list of str, default = None

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

返回值:
self

对 self 的引用。

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

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

参数:
parameter_setstr, default=”default”

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

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

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

参数:
parameter_setstr, default=”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)[source]#

根据给定输入评估所需的指标。

参数:
y_true符合 sktime 兼容数据容器格式的时间序列。

真实（正确）目标值。

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

  • Series scitype = 单个时间序列，普通预测。pd.DataFrame, pd.Series, 或 np.ndarray (1D or 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符合 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 数组状，或可调用对象，默认=None

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

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

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

  • 如果是可调用对象，必须遵循 SampleWeightGenerator 接口，或具有以下签名之一： y_true: pd.DataFrame -> 1D array-like, or y_true: pd.DataFrame x y_pred: pd.DataFrame -> 1D array-like。

返回值:
lossfloat, np.ndarray, or pd.DataFrame

计算的指标，按变量平均或分开。如果提供 sample_weight，则按其加权。

  • 如果 multioutput="uniform_average" 或 数组状，且 ``multilevel="uniform_average" 或 “uniform_average_time”``，则为 float。该值是变量和层级上的平均指标（参见类文档字符串）

  • 如果 multioutput=”raw_values”` 且 multilevel="uniform_average" 或 "uniform_average_time"，则为形状为 (y_true.columns,) 的 np.ndarray。第 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)[source]#

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

参数:
y_true符合 sktime 兼容数据容器格式的时间序列。

真实（正确）目标值。

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

  • Series scitype = 单个时间序列，普通预测。pd.DataFrame, pd.Series, 或 np.ndarray (1D or 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符合 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 数组状，或可调用对象，默认=None

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

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

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

  • 如果是可调用对象，必须遵循 SampleWeightGenerator 接口，或具有以下签名之一： y_true: pd.DataFrame -> 1D array-like, or y_true: pd.DataFrame x y_pred: pd.DataFrame -> 1D array-like。

返回值:
losspd.Series or 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)[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, default=True

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

返回值:
param_names: list[str]

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

get_params(deep=True)[source]#

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

参数:
deepbool, default=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)[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 对象属性的任何覆盖和新标签。

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)[source]#

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

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

将序列化的自身保存到字节状对象或 (.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, default = “pickle”

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

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

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

参数:
config_dictdict

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

displaystr, “diagram” (default), or “text”

jupyter 内核如何显示自身实例

  • “diagram” = html 框图表示

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

print_changed_onlybool, default=True

打印自身时是否只列出与默认值不同的自身参数（False），或列出所有参数名称和值（False）。不嵌套，即仅影响自身而不影响组件估计器。

warningsstr, “on” (default), or “off”

是否引发警告，仅影响 sktime 的警告

  • “on” = 将引发 sktime 的警告

  • “off” = 将不引发 sktime 的警告

backend:parallelstr, optional, default=”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 在并行化后关闭。

      shutting down after parallelization.

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

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

返回值:
self对自身的引用。

备注

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

set_params(**params)[source]#

设置此对象的参数。

该方法适用于简单的 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')[source]#

设置自身的 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, default=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)[source]#

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

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

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

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

set_tags 方法应仅在对象的 __init__ 方法中调用（在构建期间），或在通过 __init__ 构建后直接调用。

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

参数:
**tag_dictdict

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

返回值:
自身

对自身的引用。