GeometricMeanRelativeSquaredError#

class GeometricMeanRelativeSquaredError(multioutput='uniform_average', multilevel='uniform_average', square_root=False, by_index=False)[源码]#

几何平均相对平方误差 (GMRSE)。

如果 square_root 为 False，则计算 GMRSE；如果 square_root 为 True，则计算均方根几何平均相对误差 (RGMRSE)。

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

GMRSE 将几何平均平方误差 (GMSE) 应用于所得的相对误差。RGMRSE 将均方根几何平均误差 (RGMSE) 应用于所得的相对误差。

参数：
square_rootbool, 默认值 = False

是否对指标取平方根

multioutput{'raw_values', 'uniform_average'} 或 array-like, 形状为 (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 方法。

另请参阅

MeanRelativeAbsoluteError
MedianRelativeAbsoluteError
GeometricMeanRelativeAbsoluteError

参考文献

Hyndman, R. J 和 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     GeometricMeanRelativeSquaredError
>>> 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
>>> gmrse = GeometricMeanRelativeSquaredError()
>>> gmrse(y_true, y_pred, y_pred_benchmark=y_pred_benchmark)
np.float64(0.0008303544925949156)
>>> 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
>>> gmrse(y_true, y_pred, y_pred_benchmark=y_pred_benchmark)
np.float64(0.622419372049448)
>>> gmrse = GeometricMeanRelativeSquaredError(multioutput='raw_values')
>>> gmrse(y_true, y_pred, y_pred_benchmark=y_pred_benchmark)
array([4.09227746e-06, 1.24483465e+00])
>>> gmrse = GeometricMeanRelativeSquaredError(multioutput=[0.3, 0.7])
>>> gmrse(y_true, y_pred, y_pred_benchmark=y_pred_benchmark)
np.float64(0.8713854839582426)

方法

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

几何平均相对平方误差 (GMRSE)。

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

检查对象是否由其他 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', square_root=False, **kwargs)[源码]#

几何平均相对平方误差 (GMRSE)。

如果 square_root 为 False，则计算 GMRSE；如果 square_root 为 True，则计算均方根几何平均相对误差 (RGMRSE)。

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

GMRSE 将几何平均平方误差 (GMSE) 应用于所得的相对误差。RGMRSE 将均方根几何平均误差 (RGMSE) 应用于所得的相对误差。

参数：
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_benchmark可选，pd.Series, pd.DataFrame 或 np.array, 形状为 (fh,) 或 (fh, n_outputs)，其中 fh 是预测范围，默认值=None

来自基准方法的预测值。

horizon_weightarray-like, 形状为 (fh,), 默认值=None

预测范围权重。

multioutput{'raw_values', 'uniform_average'} 或 array-like, 形状为 (n_outputs,), 默认值='uniform_average'

定义如何聚合多元（多输出）数据的指标。如果是 array-like，则其值用作权重视误进行平均。如果是 ‘raw_values’，对于多输出输入，返回一套完整的误差。如果是 ‘uniform_average’，所有输出的误差以统一权重平均。

square_rootbool, 默认值=False

是否取均方误差的平方根。如果为 True，返回均方根百分比误差 (RMSPE)；如果为 False，返回均方百分比误差 (MSPE)。

返回：
lossfloat

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

另请参阅

mean_relative_absolute_error
median_relative_absolute_error
geometric_mean_relative_absolute_error

参考文献

Hyndman, R. J 和 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         geometric_mean_relative_squared_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
>>> geometric_mean_relative_squared_error(y_true, y_pred,     y_pred_benchmark=y_pred_benchmark)
0.0008303544925949156
>>> 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
>>> geometric_mean_relative_squared_error(y_true, y_pred,     y_pred_benchmark=y_pred_benchmark)
0.622419372049448
>>> geometric_mean_relative_squared_error(y_true, y_pred,     y_pred_benchmark=y_pred_benchmark, multioutput='raw_values')
array([4.09227746e-06, 1.24483465e+00])
>>> geometric_mean_relative_squared_error(y_true, y_pred,     y_pred_benchmark=y_pred_benchmark, multioutput=[0.3, 0.7])
0.8713854839582426
classmethod get_test_params(parameter_set='default')[源码]#

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

参数：
parameter_setstr, 默认值=”default”

要返回的测试参数集的名称，用于测试。如果未定义特定参数集，则返回 "default" 参数集。

返回：
paramsdict 或 list of dict, 默认值 = {}

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

__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 (实例, 时间)，3D np.ndarray (实例, 变量, 时间)，list of Series 类型的 pd.DataFrame。

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

有关数据格式的更多详细信息，请参见 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"，则为形状为 (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()[源码]#

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

克隆是另一个没有共享引用、处于初始化后状态的对象。此函数等同于返回 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)[源码]#

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

每个 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 个元素是测试中 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 (1D 或 2D)。

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

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

有关数据格式的更多详细信息，请参见 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"，则为形状为 (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)[源码]#

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

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

地面真实（正确）目标值。

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

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

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

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

有关数据格式的更多详细信息，请参见 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_default任意类型

如果找不到标签时的默认/ fallback 值。

返回：
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 类属性通过嵌套继承收集，然后收集来自 _config_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，则返回此对象的参数名 : 值字典，包括组件（= BaseObject 值的参数）的参数。

  • 如果为 False，则返回此对象的参数名 : 值字典，但不包括组件的参数。

返回：
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 设置的标签，

在实例构建时设置。

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

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

按继承顺序排列。

参数：
tag_namestr

要检索的标签名称

tag_value_default任意类型，可选；默认值=None

如果找不到标签时的默认/ fallback 值

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 设置的标签，

在实例构建时设置。

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

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

按继承顺序排列。

返回：
collected_tagsdict

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

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" 的属性会保留。

  • 配置属性，配置会保留不变。也就是说，get_config 在 reset 之前和之后的结果相等。

类和对象方法以及类属性也不受影响。

等同于 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，则将 self 保存到内存对象；如果为文件位置，则将 self 保存到该文件位置。如果

  • path=”estimator”，则将在当前工作目录创建一个名为 estimator.zip 的 zip 文件。

  • path=”/home/stored/estimator”，则将在 /home/stored/ 中保存一个名为 estimator.zip 的 zip 文件。

。如果您希望保存到特定的 .zip 文件名，例如 estimator.zip，请提供完整路径，包括 .zip 扩展名。

serialization_format: str, 默认值 = “pickle”

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

返回：
如果 path 为 None - 内存中的序列化 self
如果 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>__）也可以使用，如果这样可以使引用清晰无歧义，例如，没有两个组件参数同名为 <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 instance 或 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)[source]#

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

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

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

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

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

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

参数：
**tag_dictdict

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

返回：
Self

对自身的引用。