相对损失

class RelativeLoss(multioutput='uniform_average', multilevel='uniform_average', relative_loss_function=<function mean_absolute_error>, by_index=False)

计算预测值相对于基准预测值的相对损失。

将一个预测性能指标应用于一组预测值和基准预测值，并报告预测值指标与基准预测值指标的比率。相对损失输出是非负浮点数。最优值为 0.0。

如果给定损失函数下基准预测值的得分为零，则返回一个较大值。

此函数允许计算无尺度相对损失指标。与平均绝对尺度误差 (MASE) 不同，此函数计算相对于基准方法上定义的损失函数的无尺度指标，而不是使用样本内训练数据。与 MASE 类似，使用此函数创建的指标可用于比较单一系列上的预测方法，也可用于比较不同系列之间的预测精度。

当无尺度比较有利，但用于生成部分（或全部）预测值的训练数据未知时，例如比较第三方预测或专业预测师调查的损失时，此功能非常有用。

目前仅支持不需要 y_train 的指标。

参数:

relative_loss_function函数

用于计算相对损失的函数。

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 方法。

参考资料

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 RelativeLoss
>>> from sktime.performance_metrics.forecasting import mean_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
>>> relative_mae = RelativeLoss()
>>> relative_mae(y_true, y_pred, y_pred_benchmark=y_pred_benchmark)
np.float64(0.8148148148148147)
>>> relative_mse = RelativeLoss(relative_loss_function=mean_squared_error)
>>> relative_mse(y_true, y_pred, y_pred_benchmark=y_pred_benchmark)
np.float64(0.5178095088655261)
>>> 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
>>> relative_mae = RelativeLoss()
>>> relative_mae(y_true, y_pred, y_pred_benchmark=y_pred_benchmark)
np.float64(0.8490566037735847)
>>> relative_mae = RelativeLoss(multioutput='raw_values')
>>> relative_mae(y_true, y_pred, y_pred_benchmark=y_pred_benchmark)
array([0.625     , 1.03448276])
>>> relative_mae = RelativeLoss(multioutput=[0.3, 0.7])
>>> relative_mae(y_true, y_pred, y_pred_benchmark=y_pred_benchmark)
np.float64(0.927272727272727)

方法

__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[, relative_loss_function, ...])	给定指标下，预测值相对于基准预测值的相对损失。
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, relative_loss_function=<function mean_absolute_error>, horizon_weight=None, multioutput='uniform_average', **kwargs)

给定指标下，预测值相对于基准预测值的相对损失。

将一个预测性能指标应用于一组预测值和基准预测值，并报告预测值指标与基准预测值指标的比率。相对损失输出是非负浮点数。最优值为 0.0。

如果给定损失函数下基准预测值的得分为零，则返回一个较大值。

此函数允许计算无尺度相对损失指标。与平均绝对尺度误差 (MASE) 不同，此函数计算相对于基准方法上定义的损失函数的无尺度指标，而不是使用样本内训练数据。与 MASE 类似，使用此函数创建的指标可用于比较单一系列上的预测方法，也可用于比较不同系列之间的预测精度。

当无尺度比较有利，但用于生成部分（或全部）预测值的训练数据未知时，例如比较第三方预测或专业预测师调查的损失时，此功能非常有用。

目前仅支持不需要 y_train 的指标。

参数:

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

真实（正确）目标值。

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

预测值。

y_pred_benchmark可选，pd.Series, pd.DataFrame 或 形状为 (fh,) 或 (fh, n_outputs) 的 np.array，其中 fh 是预测范围，默认值=None

基准方法的预测值。

relative_loss_function函数, 默认值=mean_absolute_error

用于计算相对损失的函数。该函数必须符合 sktime 预测性能指标的 API 接口。不支持需要 y_train 或 y_pred_benchmark 的指标。

horizon_weight形状为 (fh,) 的数组状对象，默认值=None

预测范围权重。

multioutput{‘raw_values’, ‘uniform_average’} 或 形状为 (n_outputs,) 的数组状对象, 默认值为’uniform_average’

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

返回值:

relative_loss浮点数

给定损失指标下，一个方法的损失相对于基准方法的损失。如果 multioutput 为 ‘raw_values’，则单独返回每个输出的相对损失。如果 multioutput 为 ‘uniform_average’ 或权重 ndarray，则返回所有输出误差的加权平均相对损失。

参考资料

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 relative_loss
>>> from sktime.performance_metrics.forecasting import mean_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
>>> relative_loss(y_true, y_pred, y_pred_benchmark=y_pred_benchmark)
0.8148148148148147
>>> relative_loss(y_true, y_pred, y_pred_benchmark=y_pred_benchmark,     relative_loss_function=mean_squared_error)
0.5178095088655261
>>> 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
>>> relative_loss(y_true, y_pred, y_pred_benchmark=y_pred_benchmark)
0.8490566037735847
>>> relative_loss(y_true, y_pred, y_pred_benchmark=y_pred_benchmark,     multioutput='raw_values')
array([0.625     , 1.03448276])
>>> relative_loss(y_true, y_pred, y_pred_benchmark=y_pred_benchmark,     multioutput=[0.3, 0.7])
0.927272727272727

classmethod get_test_params(parameter_set='default')

检索测试参数。

__call__(y_true, y_pred, **kwargs)

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

参数:

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。

返回值:

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

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

克隆是与原对象没有共享引用的不同对象，处于初始化后的状态。此函数等同于返回 self 的 sklearn.clone。

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

标签是特定于实例 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')

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

参数:

parameter_set字符串，默认值=”default”

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

返回值:

instance带默认参数的类的实例

classmethod create_test_instances_and_names(parameter_set='default')

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

参数:

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)

在给定输入上评估所需的指标。

参数:

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。

返回值:

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)

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

参数:

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，则按其加权。

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

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

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

从类中获取类标签，并继承父类的标签级别。

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

获取自身的配置标志。

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

get_config 返回动态配置，它们会覆盖默认配置。

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

配置在 clone 或 reset 调用下被保留。

返回值:

config_dict字典

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

classmethod get_param_defaults()

获取对象的默认参数。

返回值:

default_dict: dict[str, Any]

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

classmethod get_param_names(sort=True)

获取对象的参数名称。

参数:

sort布尔值，默认值=True

是按字母顺序排序返回参数名称 (True)，还是按它们在类 __init__ 中出现的顺序返回 (False)。

返回值:

param_names: list[str]

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

get_params(deep=True)

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

参数:

deep布尔值，默认值=True

是否返回组件的参数。

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

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

返回值:

params键为字符串的字典

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

• 始终：此对象的所有参数，通过 get_param_names 获取的值是该键的参数值，此对象的值始终与构造时传入的值相同

• 如果 deep=True，还包含组件参数的键/值对，组件参数的索引格式为 [组件名称]__[参数名称]，组件名称 的所有参数以 参数名称 形式出现，并带有其值

• 如果 deep=True，还包含任意级别的组件递归，例如 [组件名称]__[组件组件名称]__[参数名称] 等

get_tag(tag_name, tag_value_default=None, raise_error=True)

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

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

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

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

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

在实例构造时。

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

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

按继承顺序。

参数:

tag_name字符串

要检索的标签名称

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

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

raise_error布尔值

未找到标签时是否抛出 ValueError

返回值:

tag_value任意类型

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 在实例上设置的标签，

在实例构造时。

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

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

按继承顺序。

返回值:

collected_tags字典

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

is_composite()

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

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

返回值:

composite: 布尔值

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

classmethod load_from_path(serial)

从文件位置加载对象。

参数:

serialZipFile(path).open(“object) 的结果

返回值:

反序列化 self，结果输出到 path，即 cls.save(path) 的输出

classmethod load_from_serial(serial)

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

参数:

serialcls.save(None) 输出的第1个元素

返回值:

反序列化 self，结果输出 serial，即 cls.save(None) 的输出

reset()

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

将 self 设置为其在构造函数调用后立即所处的状态，并保留相同的超参数。通过 set_config 设置的配置值也会被保留。

一个 reset 调用会删除所有对象属性，除了

• 超参数 = __init__ 的参数，这些参数被写入到 self，例如 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')

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

行为：如果 path 是 None，返回一个内存中的序列化 self；如果 path 是文件位置，则将 self 保存为 zip 文件到该位置

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

参数:

pathNone 或文件位置 (str 或 Path)

如果是 None，`self` 会保存为内存对象；如果 path 是文件位置，则将 self 保存到该文件位置。如果

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

• path=”/home/stored/estimator”，则 zip 文件 estimator.zip 将会

存储在 /home/stored/ 中。

serialization_format: str，默认 = “pickle”

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

返回值:

如果 path 为 None - 内存中的序列化 self

如果 path 是文件位置 - 引用该文件的 ZipFile

set_config(**config_dict)

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

参数:

config_dict字典

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

displaystr，“diagram”（默认）或 “text”

jupyter 内核如何显示 self 的实例

• “diagram” = html 框图表示

• “text” = 字符串输出

print_changed_onlybool，默认=True

打印 self 时是否仅列出自参数与默认值不同的参数（False），或列出所有参数名称和值（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”；要使用的日志记录器名称。

  • “mute_warnings”: bool，默认=False；如果为 True，则禁止显示警告。

返回值:

selfself 的引用。

注意

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

set_params(**params)

设置此对象的参数。

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

参数:

**paramsdict

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

返回值:

selfself 的引用（设置参数后）

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 中的 random_state 参数（取决于 self_policy）以及剩余组件对象（仅当 deep=True 时）。

注意：即使 self 没有 random_state 参数，或者任何组件都没有 random_state 参数，也会调用 set_params。因此，set_random_state 将重置任何 scikit-base 对象，即使是没有 random_state 参数的对象。

参数:

random_stateint, RandomState 实例或 None，默认=None

伪随机数生成器，用于控制随机整数的生成。传递 int 以在多次函数调用中获得可重现的输出。

deep布尔值，默认值=True

deep 是否在值为 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，通常与输入不同

返回值:

selfself 的引用

set_tags(**tag_dict)

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

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

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

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

set_tags 方法只能在对象的 __init__ 方法中（在构建过程中）或通过 __init__ 直接构建后调用。

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

参数:

**tag_dictdict

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

返回值:

Self

self 的引用。