GeometricMeanSquaredError#

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

几何均方误差 (GMSE) 或根几何均方误差 (RGMSE)。

如果 square_root 为 False，则计算 GMSE；如果 square_root 为 True，则计算 RGMSE。GMSE 和 RGMSE 都返回非负浮点数。最优值约等于零，而不是精确的零。

与 MSE 和 MdSE 类似，GMSE 以输入数据的平方单位衡量。RMdSE 与输入数据在同一量级上，类似于 RMSE 和 RdMSE。由于 GMSE 和 RGMSE 对预测误差进行平方而不是取绝对值，因此它们比 GMAE 更大地惩罚大误差。

参数:
square_root布尔值, 默认为 False

是否计算均方误差的平方根。如果为 True，则返回根几何均方误差 (RGMSE)；如果为 False，则返回几何均方误差 (GMSE)。

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_index布尔值, 默认为 False

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

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

  • 如果为 True，则直接调用指标对象时会在每个时间点评估指标，相当于调用 evaluate_by_index 方法。

另请参阅

mean_absolute_error
median_absolute_error
mean_squared_error
median_squared_error
geometric_mean_absolute_error

注意

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

参考文献

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 GeometricMeanSquaredError
>>> y_true = np.array([3, -0.5, 2, 7, 2])
>>> y_pred = np.array([2.5, 0.0, 2, 8, 1.25])
>>> gmse = GeometricMeanSquaredError()
>>> gmse(y_true, y_pred)  
np.float64(2.80399089461488e-07)
>>> rgmse = GeometricMeanSquaredError(square_root=True)
>>> rgmse(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]])
>>> gmse = GeometricMeanSquaredError()
>>> gmse(y_true, y_pred)  
np.float64(0.5000000000115499)
>>> rgmse = GeometricMeanSquaredError(square_root=True)
>>> rgmse(y_true, y_pred)  
np.float64(0.5000024031086919)
>>> gmse = GeometricMeanSquaredError(multioutput='raw_values')
>>> gmse(y_true, y_pred)  
array([2.30997255e-11, 1.00000000e+00])
>>> rgmse = GeometricMeanSquaredError(multioutput='raw_values', square_root=True)
>>> rgmse(y_true, y_pred)
array([4.80621738e-06, 1.00000000e+00])
>>> gmse = GeometricMeanSquaredError(multioutput=[0.3, 0.7])
>>> gmse(y_true, y_pred)  
np.float64(0.7000000000069299)
>>> rgmse = GeometricMeanSquaredError(multioutput=[0.3, 0.7], square_root=True)
>>> rgmse(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, ...])

几何均方误差 (GMSE) 或根几何均方误差 (RGMSE)。

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

几何均方误差 (GMSE) 或根几何均方误差 (RGMSE)。

如果 square_root 为 False，则计算 GMSE；如果 square_root 为 True，则计算 RGMSE。GMSE 和 RGMSE 都返回非负浮点数。最优值约等于零，而不是精确的零。

与 MSE 和 MdSE 类似，GMSE 以输入数据的平方单位衡量。RMdSE 与输入数据在同一量级上，类似于 RMSE 和 RdMSE。由于 GMSE 和 RGMSE 对预测误差进行平方而不是取绝对值，因此它们比 GMAE 更大地惩罚大误差。

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

真实（正确）目标值。

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

预测值。

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

预测范围权重。

multioutput{'raw_values', 'uniform_average'} 或形状为 (n_outputs,) 的数组, 默认为 'uniform_average'

定义如何聚合多变量（多输出）数据的指标。如果为数组类型，则其值用作误差加权平均的权重。如果为 ‘raw_values’，则对于多输出输入，返回完整的误差集合。如果为 ‘uniform_average’，则所有输出的误差以均匀权重进行平均。

square_root布尔值, 默认为 False

是否计算均方误差的平方根。如果为 True，则返回根几何均方误差 (RGMSE)；如果为 False，则返回几何均方误差 (GMSE)。

返回:
loss浮点数

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

另请参阅

mean_absolute_error
median_absolute_error
mean_squared_error
median_squared_error
geometric_mean_absolute_error

注意

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

参考文献

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     geometric_mean_squared_error as gmse
>>> y_true = np.array([3, -0.5, 2, 7, 2])
>>> y_pred = np.array([2.5, 0.0, 2, 8, 1.25])
>>> gmse(y_true, y_pred)  
2.80399089461488e-07
>>> gmse(y_true, y_pred, square_root=True)  
0.000529527232030127
>>> y_true = np.array([[0.5, 1], [-1, 1], [7, -6]])
>>> y_pred = np.array([[0, 2], [-1, 2], [8, -5]])
>>> gmse(y_true, y_pred)  
0.5000000000115499
>>> gmse(y_true, y_pred, square_root=True)  
0.5000024031086919
>>> gmse(y_true, y_pred, multioutput='raw_values')  
array([2.30997255e-11, 1.00000000e+00])
>>> gmse(y_true, y_pred, multioutput='raw_values',     square_root=True)  
array([4.80621738e-06, 1.00000000e+00])
>>> gmse(y_true, y_pred, multioutput=[0.3, 0.7])  
0.7000000000069299
>>> gmse(y_true, y_pred, multioutput=[0.3, 0.7],     square_root=True)  
0.7000014418652152
classmethod get_test_params(parameter_set='default')[source]#

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

参数:
parameter_set字符串, 默认为“default”

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

返回:
params字典或字典列表, 默认为 {}

用于创建类测试实例的参数 每个字典是构造一个“有趣”测试实例的参数，例如 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 或 2D)

  • Panel scitype = 时间序列集合，全局/面板预测。行具有两级 MultiIndex (instance, time) 的 pd.DataFrame，`3D np.ndarray (instance, variable, time)，或 Series 类型的 pd.DataFrame list

  • Hierarchical scitype = 分层集合，用于分层预测。行具有三级或更多级 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。

返回:
loss浮点数、np.ndarray 或 pd.DataFrame

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

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

  • 如果 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]#

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

克隆是一个没有共享引用、处于初始化后状态的不同对象。此函数相当于返回 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__ 方法中调用，即在构造期间或通过 __init__ 构造后立即调用。

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

tag_names 的默认设置将 estimator 中的所有标签写入到 self 中。

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

参数:
estimator:class:BaseObject 或其派生类的实例
tag_names字符串或字符串列表, 默认为 None

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

返回:
自身

对 self 的引用。

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

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

参数:
parameter_set字符串, 默认为“default”

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

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

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

参数:
parameter_set字符串, 默认为“default”

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

返回:
objscls 实例列表

第 i 个实例是 cls(**cls.get_test_params()[i])

names字符串列表, 长度与 objs 相同

第 i 个元素是测试中 obj 的第 i 个实例的名称。如果实例多于一个，命名约定为 {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 或 2D)

  • Panel scitype = 时间序列集合，全局/面板预测。行具有两级 MultiIndex (instance, time) 的 pd.DataFrame，`3D np.ndarray (instance, variable, time)，或 Series 类型的 pd.DataFrame list

  • Hierarchical scitype = 分层集合，用于分层预测。行具有三级或更多级 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。

返回:
loss浮点数、np.ndarray 或 pd.DataFrame

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

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

  • 如果 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 或 2D)

  • Panel scitype = 时间序列集合，全局/面板预测。行具有两级 MultiIndex (instance, time) 的 pd.DataFrame，`3D np.ndarray (instance, variable, time)，或 Series 类型的 pd.DataFrame list

  • Hierarchical scitype = 分层集合，用于分层预测。行具有三级或更多级 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)[source]#

从类中获取类标签值，带有从父类继承的标签级别。

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

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

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

它从对象中返回名称为 tag_name 的标签值，考虑了标签覆盖，优先级从高到低如下所示

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

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

按继承顺序。

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

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

参数:
tag_name字符串

标签值的名称。

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_tags字典

标签名称 : 标签值 对的字典。通过嵌套继承从 _tags 类属性收集。不受通过 set_tags 或 clone_tags 设置的动态标签覆盖。

get_config()[source]#

获取自身的配置标志。

配置是 self 的键值对，通常用作控制行为的临时标志。

get_config 返回动态配置，这些配置会覆盖默认配置。

默认配置在类或其父类的类属性 _config 中设置，并被通过 set_config 设置的动态配置覆盖。

配置在 clone 或 reset 调用中保留。

返回:
config_dict字典

配置名称 : 配置值 对的字典。通过嵌套继承从 _config 类属性收集，然后从 _onfig_dynamic 对象属性获取任何覆盖和新标签。

classmethod get_param_defaults()[source]#

获取对象的默认参数。

返回:
default_dict: dict[str, Any]

键是 cls 中所有在 __init__ 中定义了默认值的参数。值是在 __init__ 中定义的默认值。

classmethod get_param_names(sort=True)[source]#

获取对象的参数名称。

参数:
sort布尔值, 默认为 True

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

返回:
param_names: list[str]

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

get_params(deep=True)[source]#

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

参数:
deep布尔值, 默认为 True

是否返回组件的参数。

  • 如果为 True，将返回此对象的参数名称 : 值 的 dict，包括组件的参数（= BaseObject 类型的参数）。

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

返回:
params键为字符串的字典

参数字典，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_name字符串

要检索的标签名称

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

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

raise_error布尔值

当找不到标签时是否引发 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_tags字典

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

is_composite()[source]#

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

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

返回:
composite: 布尔值

对象是否具有任何参数，其值是 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)) 后获得的对象相等。

返回:
自身

类实例重置为干净的初始化后状态，但保留当前超参数值。

save(path=None, serialization_format='pickle')[source]#

将序列化的自身保存到字节类对象或 (.zip) 文件。

行为：如果 path 为 None，则返回内存中的序列化自身；如果 path 是文件位置，则将自身在该位置存储为 zip 文件

保存的文件是 zip 文件，内容如下： _metadata - 包含自身的类，即 type(self) _obj - 序列化的自身。此类使用默认的序列化方法 (pickle)。

参数:
pathNone 或文件位置（字符串或 Path）

如果为 None，自身保存到内存对象；如果为文件位置，自身保存到该文件位置。如果

  • path=”estimator” 则会在当前工作目录创建 zip 文件 estimator.zip。

  • path=”/home/stored/estimator” 则会在 /home/stored/ 创建 zip 文件 estimator.zip。

存储在 /home/stored/ 中。

serialization_format: 字符串, 默认为 “pickle”

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

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

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

参数:
config_dict字典

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

display字符串, “diagram”（默认）或 “text”

jupyter 内核如何显示自身实例

  • “diagram” = html 框图表示

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

print_changed_only布尔值, 默认为 True

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

warnings字符串, “on”（默认）或 “off”

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

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

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

backend:parallel字符串, 可选, 默认为 “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，则抑制警告

返回:
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 中采样，并保证 seeded 随机生成器的伪随机独立性。

取决于 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 可在多次函数调用中获得可重现的输出。

deep布尔值, 默认为 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

指向自身的引用。