MedianSquaredError#

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

中位数平方误差 (MdSE) 或均方根中位数误差 (RMdSE)。

如果 square_root 为 False，则计算 MdSE；如果 square_root 为 True，则计算 RMdSE。MdSE 和 RMdSE 都返回非负浮点数。最佳值为 0.0。

中位数平方误差 (MdSE) 计算如下：

\[\begin{split}\\text{MdSE} = \text{median}\left((y_{i} - \\widehat{y}_{i})^2\right)_{i=1}^{n}\end{split}\]

其中： - \( y_i \) 是真实值， - \( \hat{y}_i \) 是预测值， - \( n \) 是观测数量。

如果将 square_root 设置为 True，则计算均方根中位数误差 (RMdSE)

\[\begin{split}\\text{RMdSE} = \\sqrt{ \\text{MdSE} }\end{split}\]

与 MSE 类似，MdSE 以输入数据的平方单位衡量。RMdSE 与输入数据具有相同的度量单位，类似于 RMSE。

与基于均值的指标相比，取平方误差的中位数而非均值，使得该指标对误差异常值更加鲁棒，因为在存在异常值的情况下，中位数通常是更鲁棒的中心趋势度量。

由于中位数与单调变换可交换，MdSE 和 RMdSE 对大误差的惩罚不会超过 MdAE。

evaluate_by_index 在时间索引 \(t_i\) 处返回

如果 square_root 为 False，则返回该时间索引处的平方误差，
\((y_i - \widehat{y}_i)^2\),
如果 square_root 为 True，则返回该时间索引处的绝对误差，即 \(|y_i - \widehat{y}_i|\)，

对于输入中的所有时间索引 \(t_1, \dots, t_n\)。

参数:

square_rootbool, 默认 = False

是否对指标取平方根

multioutput{'raw_values', 'uniform_average'} 或 shape 为 (n_outputs,) 的类数组对象, 默认=’uniform_average’

(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, 默认=False

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

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

另请参阅

MeanAbsoluteError
MedianAbsoluteError
MeanSquaredError

参考文献

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 MedianSquaredError
>>> y_true = np.array([3, -0.5, 2, 7, 2])
>>> y_pred = np.array([2.5, 0.0, 2, 8, 1.25])
>>> mdse = MedianSquaredError()
>>> mdse(y_true, y_pred)
np.float64(0.25)
>>> rmdse = MedianSquaredError(square_root=True)
>>> rmdse(y_true, y_pred)
np.float64(0.5)
>>> y_true = np.array([[0.5, 1], [-1, 1], [7, -6]])
>>> y_pred = np.array([[0, 2], [-1, 2], [8, -5]])
>>> mdse(y_true, y_pred)
np.float64(0.625)
>>> rmdse(y_true, y_pred)
np.float64(0.75)
>>> mdse = MedianSquaredError(multioutput='raw_values')
>>> mdse(y_true, y_pred)
array([0.25, 1.  ])
>>> rmdse = MedianSquaredError(multioutput='raw_values', square_root=True)
>>> rmdse(y_true, y_pred)
array([0.5, 1. ])
>>> mdse = MedianSquaredError(multioutput=[0.3, 0.7])
>>> mdse(y_true, y_pred)
np.float64(0.7749999999999999)
>>> rmdse = MedianSquaredError(multioutput=[0.3, 0.7], square_root=True)
>>> rmdse(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[, horizon_weight, multioutput, ...])	中位数平方误差 (MdSE) 或均方根中位数误差 (RMdSE)。
`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, horizon_weight=None, multioutput='uniform_average', square_root=False, **kwargs)[source]#

中位数平方误差 (MdSE) 或均方根中位数误差 (RMdSE)。

如果 square_root 为 False，则计算 MdSE；如果 square_root 为 True，则计算 RMdSE。MdSE 和 RMdSE 都返回非负浮点数。最佳值为 0.0。

类似于 MSE，MdSE 以输入数据的平方单位衡量。RMdSE 与 RMSE 一样，与输入数据具有相同的度量单位。由于 MdSE 和 RMdSE 对误差进行平方而不是取绝对值，它们对大误差的惩罚比 MAE 或 MdAE 更重。

与基于均值的指标相比，取平方误差的中位数而非均值，使得该指标对误差异常值更加鲁棒，因为在存在异常值的情况下，中位数通常是更鲁棒的中心趋势度量。

参数:

y_trueshape 为 (fh,) 或 (fh, n_outputs) 的 pd.Series, pd.DataFrame 或 np.array，其中 fh 是预测范围: 真实（正确）目标值。
y_predshape 为 (fh,) 或 (fh, n_outputs) 的 pd.Series, pd.DataFrame 或 np.array，其中 fh 是预测范围: 预测值。
horizon_weightshape 为 (fh,) 的类数组对象, 默认=None: 预测范围权重。
multioutput{'raw_values', 'uniform_average'} 或 shape 为 (n_outputs,) 的类数组对象, 默认=’uniform_average’: 定义了如何为多元（多输出）数据聚合指标。如果为类数组对象，则将其值用作权重来平均误差。如果为 ‘raw_values’，则在多输出输入情况下返回完整的误差集合。如果为 ‘uniform_average’，则所有输出的误差以均匀权重平均。
square_rootbool, 默认=False: 是否对指标取平方根。如果为 True，则返回均方根中位数误差 (RMdSE)；如果为 False，则返回中位数平方误差 (MdSE)。

返回值:

lossfloat: MdSE 损失。如果 multioutput 是 ‘raw_values’，则为每个输出分别返回 MdSE。如果 multioutput 是 ‘uniform_average’ 或权重数组，则返回所有输出误差的加权平均 MdSE。

另请参阅

mean_absolute_error
median_absolute_error
mean_squared_error
geometric_mean_absolute_error
geometric_mean_squared_error

参考文献

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 median_squared_error
>>> y_true = np.array([3, -0.5, 2, 7, 2])
>>> y_pred = np.array([2.5, 0.0, 2, 8, 1.25])
>>> median_squared_error(y_true, y_pred)
0.25
>>> median_squared_error(y_true, y_pred, square_root=True)
0.5
>>> y_true = np.array([[0.5, 1], [-1, 1], [7, -6]])
>>> y_pred = np.array([[0, 2], [-1, 2], [8, -5]])
>>> median_squared_error(y_true, y_pred)
0.625
>>> median_squared_error(y_true, y_pred, square_root=True)
0.75
>>> median_squared_error(y_true, y_pred, multioutput='raw_values')
array([0.25, 1.  ])
>>> median_squared_error(y_true, y_pred, multioutput='raw_values', square_root=True)
array([0.5, 1. ])
>>> median_squared_error(y_true, y_pred, multioutput=[0.3, 0.7])
0.7749999999999999
>>> median_squared_error(y_true, y_pred, multioutput=[0.3, 0.7], square_root=True)
0.85

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

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

参数:

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

返回值:

paramsdict 或 list of 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 或 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可选，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，则按其加权。

如果 multioutput="uniform_average" or array-like, and ``multilevel="uniform_average" or “uniform_average_time”``，则为 float 类型。该值是变量和级别上的平均指标（参见类文档字符串）。
如果 multioutput=”raw_values”` 并且 multilevel="uniform_average" 或 "uniform_average_time"，则为 shape 为 (y_true.columns,) 的 np.ndarray。第 i 个条目是为第 i 个变量计算的指标。
如果 multilevel="raw_values"，则为 pd.DataFrame 类型。如果 multioutput="uniform_average"，其 shape 为 (n_levels, )；如果 multioutput="raw_values"，其 shape 为 (n_levels, y_true.columns)。指标应用于每个级别，并根据 multioutput 进行行平均（是/否）。

clone()[source]#

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

获取具有相同超参数和配置的对象的克隆。克隆是一个不同的对象，没有共享引用，处于初始化后状态。此函数等效于返回 sklearn.clone of self。

等效于构造 type(self) 的新实例，使用 self 的参数，即 type(self)(**self.get_params(deep=False))。

如果在 self 上设置了配置，克隆也将具有与原始相同的配置，等效于调用 cloned_self.set_config(**self.get_config())。

其值也等效于调用 self.reset，不同之处在于 clone 返回一个新对象，而不是像 reset 那样改变 self。

Raises:

RuntimeError 如果克隆不符合要求，原因在于 __init__ 有误。

clone_tags(estimator, tag_names=None)[source]#

将另一个对象的标签克隆为动态覆盖。

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

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

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

The clone_tags method should be called only in the __init__ method of an object, during construction, or directly after construction via __init__.

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

tag_names 的默认值会将 estimator 的所有标签写入 self。

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

参数:

estimator`BaseObject` 或派生类的实例
tag_namesstr 或 list of str, 默认 = None: 要克隆的标签名称。默认值 (None) 克隆 estimator 中的所有标签。

返回值:

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 个元素是测试中第 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 或 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可选，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，则按其加权。

如果 multioutput="uniform_average" or array-like, and ``multilevel="uniform_average" or “uniform_average_time”``，则为 float 类型。该值是变量和级别上的平均指标（参见类文档字符串）。
如果 multioutput=”raw_values”` 并且 multilevel="uniform_average" 或 "uniform_average_time"，则为 shape 为 (y_true.columns,) 的 np.ndarray。第 i 个条目是为第 i 个变量计算的指标。
如果 multilevel="raw_values"，则为 pd.DataFrame 类型。如果 multioutput="uniform_average"，其 shape 为 (n_levels, )；如果 multioutput="raw_values"，其 shape 为 (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可选，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)[source]#

从类中获取类标签值，继承自父类。

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

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

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

它返回对象中名称为 tag_name 的标签值，按以下优先级降序考虑标签覆盖

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

按继承顺序。

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

要检索可能包含实例覆盖的标签值，请改用 get_tag 方法。

参数:

tag_namestr: 标签名称。
tag_value_defaultany type: 如果未找到标签，则使用的默认/回退值。

返回值:

tag_value: `self` 中 tag_name 标签的值。如果未找到，则返回 tag_value_default。

classmethod get_class_tags()[source]#

从类中获取类标签，继承自父类。

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

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

`get_class_tags` 方法是类方法，仅考虑类级别标签值和覆盖来检索标签值。

它返回一个字典，其键是类或其任何父类中设置的 _tags 属性的任何键。

值是相应的标签值，覆盖按以下优先级降序

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

按继承顺序。

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

2. 父类 _tags 属性中设置的标签，按继承顺序。

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

实例可以根据超参数覆盖这些标签。

返回值:

要检索可能包含实例覆盖的标签，请改用 get_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，将返回此对象的参数名称：值字典，包括组件的参数（=BaseObject 值的参数）。

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

始终：此对象的所有参数，如通过 get_param_names 获取的值是该键对应的参数值，属于此对象。值始终与构造时传递的值相同。

从实例中获取标签值，考虑继承和覆盖。

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

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

如果 deep=True，还包含组件参数的键/值对。组件的参数以 [componentname]__[paramname] 的形式索引。`componentname` 的所有参数都以 paramname 及其值的形式出现。

如果 deep=True，还包含任意级别的组件递归，例如 [componentname]__[componentcomponentname]__[paramname] 等。

get_tag(tag_name, tag_value_default=None, raise_error=True)[source]#

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

按继承顺序。

参数:

tag_namestr: `get_tag` 方法从实例中检索名称为 tag_name 的单个标签值，按以下优先级降序考虑标签覆盖
1. 通过 set_tags 或 clone_tags 在实例上设置的标签，: 在实例构造时。
2. 类 _tags 属性中设置的标签。: 3. 父类 _tags 属性中设置的标签，按继承顺序。

返回值:

tag_namestr: 要检索的标签名称

Raises:

tag_value_defaultany type, optional; default=None: 如果未找到标签，则使用的默认/回退值

raise_errorbool

从实例中获取标签，考虑继承和覆盖。

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

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

如果未找到标签时是否引发 ValueError

值是相应的标签值，覆盖按以下优先级降序

如果 deep=True，还包含任意级别的组件递归，例如 [componentname]__[componentcomponentname]__[paramname] 等。

get_tag(tag_name, tag_value_default=None, raise_error=True)[source]#

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

按继承顺序。

返回值:

要检索可能包含实例覆盖的标签，请改用 get_tags 方法。: tag_valueAny

`self` 中 tag_name 标签的值。如果未找到，如果 raise_error 为 True 则引发错误，否则返回 tag_value_default。

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

ValueError, 如果 raise_error 为 True。

返回值:

如果 tag_name 不在 self.get_tags().keys() 中，则引发 ValueError。: get_tags()[source]#

`get_tags` 方法返回一个标签字典，其键是类或其任何父类中设置的 _tags 属性的任何键，或者通过 set_tags 或 clone_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]#

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

serial`cls.save(None)` 输出的第一个元素

反序列化的自身，其结果是 serial，是 cls.save(None) 的输出。

返回值:

self: reset()[source]#

将对象重置到初始状态。其结果是将 self 设置为构造函数调用后立即所处的状态，具有相同的超参数。通过 set_config 设置的配置值也会保留。

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

A reset call deletes any object attributes, except

超参数 = 写入 self 的 __init__ 参数，例如 self.paramname，其中 paramname 是 __init__ 的参数。

参数:

包含双下划线的对象属性，即字符串 "__"。例如，名为 "__myattr" 的属性会被保留。

配置属性，配置保持不变。也就是说，在 reset 前后调用 get_config 的结果相同。

类和对象方法以及类属性也不受影响。
等效于 clone，不同之处在于 reset 改变 self，而不是返回一个新对象。

在 self.reset() 调用后，self 的值和状态等于构造函数调用``type(self)(**self.get_params(deep=False))``后获得的对象。

returns对象

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

返回值:

save(path=None, serialization_format='pickle')[source]#
将序列化后的自身保存到字节类对象或 (.zip) 文件。行为：如果 path 为 None，则返回内存中的序列化自身；如果 path 为文件位置，则将自身在该位置保存为 zip 文件。

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

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

参数:

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

pathNone 或文件位置 (str 或 Path)

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

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

如果 path=”/home/stored/estimator”，则会在 /home/stored/ 中存储一个名为 estimator.zip 的 zip 文件。
serialization_format: str, 默认 = “pickle”

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

是否仅打印与默认值不同的参数（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)[source]#

设置此对象的参数。

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

参数:

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

`cls` 的参数名称列表。如果 sort=False，则按它们在类的 __init__ 中出现的顺序排列。如果 sort=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: 对自身的引用。