MeanLinexError#

class MeanLinexError(a=1.0, b=1.0, multioutput='uniform_average', multilevel='uniform_average', by_index=False)[source]#

计算均值 Linex 误差。

输出是非负浮点数。最优值为 0.0。

许多预测损失函数（例如[Rcdfa90ae2edf-1] 中讨论的那些）假设高估和低估应受到同等惩罚。然而，这可能与预测用户面临的实际成本不符。当低估和高估的成本不同时，非对称损失函数非常有用。

Linex 误差函数通过对阈值一侧的误差进行近似线性惩罚，而对另一侧的误差进行近似指数惩罚来解决这个问题。如果 a > 0，则负误差（高估）受到近似线性惩罚，正误差（低估）受到近似指数惩罚。如果 a < 0，则情况相反。

参数:

aint 或 float

控制高估或低估是受到近似线性还是指数惩罚。如果 a > 0，则负误差（高估）受到近似线性惩罚，正误差（低估）受到近似指数惩罚。如果 a < 0，则情况相反。

bint 或 float

应用于计算误差的乘法惩罚。

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

另请参见

mean_asymmetric_error

注意

根据 [2]_ 中的公式，计算为 b * (np.exp(a * error) - a * error - 1)，其中 a != 0 且 b > 0。

参考文献

[1]

Hyndman, R. J 和 Koehler, A. B. (2006)。“再看预测精度测量”，《国际预测杂志》，第 22 卷，第 4 期。

[1]

Diebold, Francis X. (2007)。《预测要素（第 4 版）》，Thomson, South-Western：美国俄亥俄州。

示例

>>> import numpy as np
>>> from sktime.performance_metrics.forecasting import MeanLinexError
>>> linex_error = MeanLinexError()
>>> y_true = np.array([3, -0.5, 2, 7, 2])
>>> y_pred = np.array([2.5, 0.0, 2, 8, 1.25])
>>> linex_error(y_true, y_pred)  
np.float64(0.19802627763937575)
>>> linex_error = MeanLinexError(b=2)
>>> linex_error(y_true, y_pred)  
np.float64(0.3960525552787515)
>>> linex_error = MeanLinexError(a=-1)
>>> linex_error(y_true, y_pred)  
np.float64(0.2391800623225643)
>>> y_true = np.array([[0.5, 1], [-1, 1], [7, -6]])
>>> y_pred = np.array([[0, 2], [-1, 2], [8, -5]])
>>> linex_error = MeanLinexError()
>>> linex_error(y_true, y_pred)  
np.float64(0.2700398392309829)
>>> linex_error = MeanLinexError(a=-1)
>>> linex_error(y_true, y_pred)  
np.float64(0.49660966225813563
>>> linex_error = MeanLinexError(multioutput='raw_values')
>>> linex_error(y_true, y_pred)  
array([0.17220024, 0.36787944])
>>> linex_error = MeanLinexError(multioutput=[0.3, 0.7])
>>> linex_error(y_true, y_pred)  
np.float64(0.30917568000716666)

方法

`__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[, a, b, horizon_weight, multioutput])	计算均值 Linex 误差。
`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, a=1.0, b=1.0, horizon_weight=None, multioutput='uniform_average', **kwargs)[source]#

计算均值 Linex 误差。

输出是非负浮点数。最优值为 0.0。

许多预测损失函数（例如[Ra2d964b4c637-1] 中讨论的那些）假设高估和低估应受到同等惩罚。然而，这可能与预测用户面临的实际成本不符。当低估和高估的成本不同时，非对称损失函数非常有用。

Linex 误差函数通过对阈值一侧的误差进行近似线性惩罚，而对另一侧的误差进行近似指数惩罚来解决这个问题。

参数:

y_truepd.Series、pd.DataFrame 或 np.array，形状为 (fh,) 或 (fh, n_outputs)，其中 fh 是预测范围: 真实（正确）目标值。
y_predpd.Series、pd.DataFrame 或 np.array，形状为 (fh,) 或 (fh, n_outputs)，其中 fh 是预测范围: 预测值。
aint 或 float: 控制高估或低估是受到近似线性还是指数惩罚。如果 a > 0，则负误差（高估）受到近似线性惩罚，正误差（低估）受到近似指数惩罚。如果 a < 0，则情况相反。
bint 或 float: 应用于计算误差的乘法惩罚。
horizon_weightarray-like，形状为 (fh,)，默认=None: 预测范围权重。
multioutput{‘raw_values’, ‘uniform_average’} 或 array-like，形状为 (n_outputs,)，默认=’uniform_average’: 定义如何聚合多变量（多输出）数据的指标。如果为 array-like，则使用这些值作为权重来平均误差。如果为 ‘raw_values’，则在多输出输入的情况下返回完整的误差集。如果为 ‘uniform_average’，则所有输出的误差都以均匀权重平均。

返回:

asymmetric_lossfloat: 使用误差的非对称惩罚计算的损失。如果 multioutput 是 ‘raw_values’，则为每个输出分别返回非对称损失。如果 multioutput 是 ‘uniform_average’ 或权重的 ndarray，则返回所有输出误差的加权平均非对称损失。

另请参见

mean_asymmetric_error

注意

根据 [2]_ 中的公式，计算为 b * (np.exp(a * error) - a * error - 1)，其中 a != 0 且 b > 0。

参考文献

[1]

Hyndman, R. J 和 Koehler, A. B. (2006)。“再看预测精度测量”，《国际预测杂志》，第 22 卷，第 4 期。

[1]

Diebold, Francis X. (2007)。《预测要素（第 4 版）》，Thomson, South-Western：美国俄亥俄州。

示例

>>> import numpy as np
>>> from sktime.performance_metrics.forecasting import mean_linex_error
>>> y_true = np.array([3, -0.5, 2, 7, 2])
>>> y_pred = np.array([2.5, 0.0, 2, 8, 1.25])
>>> mean_linex_error(y_true, y_pred)  
0.19802627763937575
>>> mean_linex_error(y_true, y_pred, b=2)  
0.3960525552787515
>>> mean_linex_error(y_true, y_pred, a=-1)  
0.2391800623225643
>>> y_true = np.array([[0.5, 1], [-1, 1], [7, -6]])
>>> y_pred = np.array([[0, 2], [-1, 2], [8, -5]])
>>> mean_linex_error(y_true, y_pred)  
0.2700398392309829
>>> mean_linex_error(y_true, y_pred, a=-1)  
0.49660966225813563
>>> mean_linex_error(y_true, y_pred, multioutput='raw_values')  
array([0.17220024, 0.36787944])
>>> mean_linex_error(y_true, y_pred, multioutput=[0.3, 0.7])  
0.30917568000716666

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

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

参数:

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

返回:

paramsdict 或 dict 列表，默认 = {}: 创建类的测试实例的参数。每个 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 = 时间序列集合，全局/面板预测。pd.DataFrame 具有 2 级行 MultiIndex (instance, time)，3D np.ndarray (instance, variable, time)，类型为 Series 的 pd.DataFrame 的 list
Hierarchical scitype = 分层集合，用于分层预测。pd.DataFrame 具有 3 级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)

有关数据格式的更多详细信息，请参见 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。值为跨变量和层级平均的指标（参见类 docstring）
如果 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 检查。

参数:

estimatorBaseObject 或派生类的实例
tag_namesstr 或 str 列表，默认 = None: 要克隆的标签名称。默认值 (None) 克隆 estimator 中的所有标签。

返回:

self: 对 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 个元素是测试中 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 = 时间序列集合，全局/面板预测。pd.DataFrame 具有 2 级行 MultiIndex (instance, time)，3D np.ndarray (instance, variable, time)，类型为 Series 的 pd.DataFrame 的 list
Hierarchical scitype = 分层集合，用于分层预测。pd.DataFrame 具有 3 级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)

有关数据格式的更多详细信息，请参见 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。值为跨变量和层级平均的指标（参见类 docstring）
如果 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 = 时间序列集合，全局/面板预测。pd.DataFrame 具有 2 级行 MultiIndex (instance, time)，3D np.ndarray (instance, variable, time)，类型为 Series 的 pd.DataFrame 的 list
Hierarchical scitype = 分层集合，用于分层预测。pd.DataFrame 具有 3 级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)

有关数据格式的更多详细信息，请参见 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)[source]#

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

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

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

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

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

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

按继承顺序。

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

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

参数:

tag_namestr: 标签值的名称。
tag_value_default任意类型: 如果未找到标签，则使用的默认/备用值。

返回:

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

classmethod get_class_tags()[source]#

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

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

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

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

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

值是相应的标签值，覆盖优先级从高到低如下：

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

按继承顺序。

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

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

不考虑在实例上设置的动态标签覆盖，通过 set_tags 或 clone_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 的 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)[source]#

从实例中获取标签值，具有标签级别继承和覆盖。

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

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

get_tag 方法从实例中检索名称为 tag_name 的单个标签的值，考虑标签覆盖，优先级从高到低如下：

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

在实例构造时。

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

按继承顺序。

参数:

tag_namestr: 要检索的标签名称
tag_value_default任意类型，可选；默认=None: 如果未找到标签，则使用的默认/备用值
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()[source]#

从实例中获取标签，具有标签级别继承和覆盖。

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

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

get_tags 方法返回一个标签字典，其键是类或其任何父类中设置的 _tags 任何属性的键，或通过 set_tags 或 clone_tags 设置的标签。

值是相应的标签值，覆盖优先级从高到低如下：

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

在实例构造时。

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

按继承顺序。

返回:

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

is_composite()[source]#

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

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

返回:

composite: bool: 对象的任何参数值是否是 BaseObject 的派生实例。

classmethod load_from_path(serial)[source]#

从文件位置加载对象。

参数:

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

返回:

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

classmethod load_from_serial(serial)[source]#

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

参数:

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

返回:

反序列化的 self，结果输出 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)) 后获得的对象相等。

返回:

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

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

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

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

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

参数:

pathNone 或文件位置 (str 或 Path)

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

path=”estimator”，则会在当前工作目录 (cwd) 创建一个 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)[source]#

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

参数:

config_dictdict

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

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

jupyter 内核如何显示 self 的实例

“diagram” = html 框图表示
“text” = 字符串输出

print_changed_onlybool，默认值=True

打印 self 时，是只列出与默认值不同的 self 参数，还是列出所有参数名称和值。不进行嵌套，即仅影响 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，则抑制警告

返回:

self对 self 的引用。

注意

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

set_params(**params)[source]#

设置此对象的参数。

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

参数:

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

返回:

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

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对 self 的引用

set_tags(**tag_dict)[source]#

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

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

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

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

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

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

参数:

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

返回:

self: 对 self 的引用。