均方误差#

类 MeanSquaredError(multioutput='uniform_average', multilevel='uniform_average', square_root=False, by_index=False)[source]#

均方误差 (MSE) 或均方根误差 (RMSE)。

对于单变量、非分层样本的真实值 \(y_1, \dots, y_n\) 和预测值 \(\widehat{y}_1, \dots, \widehat{y}_n\)（在 \(mathbb{R}\) 中），在时间索引 \(t_1, \dots, t_n\) 处，evaluate 或调用返回：

  • 如果 square_root 为 False，则返回均方误差（Mean Squared Error），\(\frac{1}{n}\sum_{i=1}^n \left(y_i - \widehat{y}_i\right)^2\)

  • 如果 square_root 为 True，则返回均方根误差（Root Mean Squared Error），\(\sqrt{\frac{1}{n}\sum_{i=1}^n \left(y_i - \widehat{y}_i\right)^2}\)

MSE 和 RMSE 都是非负浮点数，值越低越好。可能的最低值为 0.0。

multioutput 和 multilevel 控制跨变量和层级索引的平均，详见下文。如果 square_root 为 True，则平均是针对平方误差的平方根进行的。

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

  • 如果 square_root 为 False，则返回该时间索引处的平方误差，\(\left(y_i - \widehat{y}_i\right)^2\)，适用于输入中的所有时间索引 \(t_1, \dots, t_n\)。

  • 如果 square_root 为 True，则返回该时间索引处的 RMSE 的 jackknife 伪值，\(n * \bar{\varepsilon} - (n-1) * \varepsilon_i\)，其中 \(\bar{\varepsilon}\) 是所有时间索引上的 RMSE，\(\varepsilon_i\) 是移除第 i 个时间索引后的 RMSE，即使用值 \(y_1, \dots, y_{i-1}, y_{i+1}, \dots, y_n\) 和 \(\widehat{y}_1, \dots, \widehat{y}_{i-1}, \widehat{y}_{i+1}, \dots, \widehat{y}_n\) 计算的 RMSE。

MSE 的度量单位是输入数据的平方单位，而 RMSE 与数据的尺度相同。由于 MSE 和 RMSE 对预测误差进行平方而不是取绝对值，它们对大误差的惩罚比 MAE 更重。

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

是否对指标取平方根

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

另请参阅

MeanAbsoluteError
MedianAbsoluteError
MedianSquaredError

参考文献

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 MeanSquaredError
>>> y_true = np.array([3, -0.5, 2, 7, 2])
>>> y_pred = np.array([2.5, 0.0, 2, 8, 1.25])
>>> mse = MeanSquaredError()
>>> mse(y_true, y_pred)
np.float64(0.4125)
>>> y_true = np.array([[0.5, 1], [-1, 1], [7, -6]])
>>> y_pred = np.array([[0, 2], [-1, 2], [8, -5]])
>>> mse(y_true, y_pred)
np.float64(0.7083333333333334)
>>> rmse = MeanSquaredError(square_root=True)
>>> rmse(y_true, y_pred)
np.float64(0.8227486121839513)
>>> rmse = MeanSquaredError(multioutput='raw_values')
>>> rmse(y_true, y_pred)
array([0.41666667, 1.        ])
>>> rmse = MeanSquaredError(multioutput='raw_values', square_root=True)
>>> rmse(y_true, y_pred)
array([0.64549722, 1.        ])
>>> rmse = MeanSquaredError(multioutput=[0.3, 0.7])
>>> rmse(y_true, y_pred)
np.float64(0.825)
>>> rmse = MeanSquaredError(multioutput=[0.3, 0.7], square_root=True)
>>> rmse(y_true, y_pred)
np.float64(0.8936491673103708)

方法

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

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

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)

将实例级别的标签覆盖设置为给定值。
类方法 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_truesktime 兼容数据容器格式的时间序列。

真实（正确）目标值。

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

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

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

  • Hierarchical scitype = 分层集合，用于分层预测。带有 3 级或更多行 MultiIndex (hierarchy_1, ..., hierarchy_n, time) 的 pd.DataFrame。

有关数据格式的更多详细信息，请参阅 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``are a single time series, ``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" or array-like, and ``multilevel="uniform_average" or “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]#

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

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

类方法 create_test_instance(parameter_set='default')[source]#

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

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

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

返回:
instance带有默认参数的类实例
类方法 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_truesktime 兼容数据容器格式的时间序列。

真实（正确）目标值。

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

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

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

  • Hierarchical scitype = 分层集合，用于分层预测。带有 3 级或更多行 MultiIndex (hierarchy_1, ..., hierarchy_n, time) 的 pd.DataFrame。

有关数据格式的更多详细信息，请参阅 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``are a single time series, ``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" or array-like, and ``multilevel="uniform_average" or “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_truesktime 兼容数据容器格式的时间序列。

真实（正确）目标值。

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

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

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

  • Hierarchical scitype = 分层集合，用于分层预测。带有 3 级或更多行 MultiIndex (hierarchy_1, ..., hierarchy_n, time) 的 pd.DataFrame。

有关数据格式的更多详细信息，请参阅 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``are a single time series, ``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 处的指标。

类方法 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任意类型

如果未找到标签，则使用的默认/回退值。

返回:
标签值

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

类方法 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 对象属性的任何覆盖和新标签。

类方法 get_param_defaults()[source]#

获取对象的默认参数。

返回:
default_dict: dict[str, Any]

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

类方法 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，将返回此对象的参数名称 : 值字典，包括组件的参数（= BaseObject 值的参数）。

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

返回:
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_value任意类型

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 的派生实例。

类方法 load_from_path(serial)[source]#

从文件位置加载对象。

参数:
serialZipFile(path).open(“object) 的结果
返回:
在 path 处产生输出的自反序列化，是 cls.save(path) 的输出。
类方法 load_from_serial(serial)[source]#

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

参数:
serialcls.save(None) 输出的第一个元素
返回:
产生输出 serial 的自反序列化，是 cls.save(None) 的输出。
reset()[source]#

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

结果是将 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')[source]#

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

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

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

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

如果为 None，则将对象保存到内存中；如果为文件位置，则将对象保存到该文件位置。如果

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

  • path=”/home/stored/estimator” 则会在 /home/stored/ 中

存储一个 zip 文件 estimator.zip。

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

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

返回:
如果 path 为 None - 内存中的序列化对象
如果 path 是文件位置 - 指向文件的 ZipFile 对象
set_config(**config_dict)[source]#

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

参数:
config_dict字典

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

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

jupyter kernel 如何显示对象的实例

  • “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:params字典，可选，默认为 {}（不传递参数）

作为配置传递给并行化后端的附加参数。有效键取决于 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”：布尔值，默认为 True；False 防止 ray 在

      并行化后关闭。

    • “logger_name”：字符串，默认为“ray”；要使用的日志记录器名称。

    • “mute_warnings”：布尔值，默认为 False；如果为 True，则抑制警告

返回:
self对象的引用。

注意

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

set_params(**params)[source]#

设置此对象的参数。

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

参数:
**params字典

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_state整数，RandomState 实例或 None，默认为 None

用于控制随机整数生成的伪随机数生成器。传入整数可在多次函数调用中获得可复现的输出。

deep布尔值，默认为 True

是否在 skbase 对象值参数中设置随机状态，即组件估计器。

  • 如果为 False，则仅设置 self 的 random_state 参数（如果存在）。

  • 如果为 True，则也会设置组件对象中的 random_state 参数。

self_policy字符串，可选值为 {“copy”, “keep”, “new”} 之一，默认为 “copy”

  • “copy” : self.random_state 设置为输入的 random_state

  • “keep” : self.random_state 保持原样

  • “new” : self.random_state 设置为一个新的随机状态，

派生自输入的 random_state，通常与输入的不同

返回:
self对 self 的引用
set_tags(**tag_dict)[source]#

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

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

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

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

set_tags 方法只能在对象的 __init__ 方法中被调用，即在构建期间，或通过 __init__ 直接构建之后调用。

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

参数:
**tag_dict字典

标签名称与标签值配对的字典。

返回:
自身

对自身的引用。