平均绝对误差#

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

平均绝对误差 (MAE)。

对于单变量、非分层的真实值样本 \(y_1, \dots, y_n\) 和预测值 \(\widehat{y}_1, \dots, \widehat{y}_n\) (在 \(mathbb{R}\) 中)，在时间索引 \(t_1, \dots, t_n\)，调用 evaluate 或直接调用返回平均绝对误差，\(\frac{1}{n}\sum_{i=1}^n |y_i - \widehat{y}_i|\)。(时间索引未使用)

multioutput 和 multilevel 控制变量和层次索引的平均方式，详见下文。

evaluate_by_index 返回输入中所有时间索引 \(t_1, \dots, t_n\) 下对应时间索引 \(t_i\) 的绝对误差 \(|y_i - \widehat{y}_i|\)。

MAE 输出为非负浮点数。最佳值为 0.0。

MAE 与数据具有相同的尺度。因为 MAE 取预测误差的绝对值而不是平方，所以 MAE 对大误差的惩罚程度小于 MSE 或 RMSE。

参数:

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

另请参阅

中位数绝对误差
均方误差
中位数均方误差

参考文献

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 MeanAbsoluteError
>>> y_true = np.array([3, -0.5, 2, 7, 2])
>>> y_pred = np.array([2.5, 0.0, 2, 8, 1.25])
>>> mae = MeanAbsoluteError()
>>> mae(y_true, y_pred)
np.float64(0.55)
>>> y_true = np.array([[0.5, 1], [-1, 1], [7, -6]])
>>> y_pred = np.array([[0, 2], [-1, 2], [8, -5]])
>>> mae(y_true, y_pred)
np.float64(0.75)
>>> mae = MeanAbsoluteError(multioutput='raw_values')
>>> mae(y_true, y_pred)
array([0.5, 1. ])
>>> mae = MeanAbsoluteError(multioutput=[0.3, 0.7])
>>> mae(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)	返回在每个时间点评估的指标。
`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])	返回 skbase 对象的测试参数设置。
`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)	将实例级别标签覆盖设置为给定值。

__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 组成的 list
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 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，则按其加权。

float 如果 multioutput="uniform_average" 或 array-like，并且 ``multilevel="uniform_average"`` 或 “uniform_average_time”。该值是按变量和级别平均后的指标（参见类 docstring）
形状为 (y_true.columns,) 的 np.ndarray 如果 multioutput=”raw_values” 并且 multilevel="uniform_average" 或 "uniform_average_time"。第 i 个条目是为第 i 个变量计算的指标
pd.DataFrame 如果 multilevel="raw_values"。形状为 (n_levels, )，如果 multioutput="uniform_average"；形状为 (n_levels, y_true.columns) 如果 multioutput="raw_values"。指标按级别应用，行平均（是/否）按照 multioutput 设置。

clone()[source]#

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

克隆是一个没有共享引用、处于初始化后状态的不同对象。此函数相当于返回 self 的 sklearn.clone。

相当于构造一个 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_namesstr 或 list of 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_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 组成的 list
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 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，则按其加权。

float 如果 multioutput="uniform_average" 或 array-like，并且 ``multilevel="uniform_average"`` 或 “uniform_average_time”。该值是按变量和级别平均后的指标（参见类 docstring）
形状为 (y_true.columns,) 的 np.ndarray 如果 multioutput=”raw_values” 并且 multilevel="uniform_average" 或 "uniform_average_time"。第 i 个条目是为第 i 个变量计算的指标
pd.DataFrame 如果 multilevel="raw_values"。形状为 (n_levels, )，如果 multioutput="uniform_average"；形状为 (n_levels, y_true.columns) 如果 multioutput="raw_values"。指标按级别应用，行平均（是/否）按照 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 组成的 list
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 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，则按其加权。

pd.Series 如果 multioutput="uniform_average" 或 array-like。索引与 y_true 的索引相同；索引 i 处的条目是时间 i 处的指标，按变量平均
pd.DataFrame 如果 multioutput="raw_values"。索引和列与 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，将返回此对象的参数名 : 值的 dict，包括组件的参数（= BaseObject 类型参数）。
如果为 False，将返回此对象的参数名 : 值的 dict，但不包括组件的参数。

返回:

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 对象属性收集任何覆盖和新标签。

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

返回 skbase 对象的测试参数设置。

get_test_params 是用于存储测试目的参数设置的统一接口点。此函数也用于 create_test_instance 和 create_test_instances_and_names 来构造测试实例。

get_test_params 应返回单个 dict，或 dict 的 list。

每个 dict 都是用于测试的参数配置，可用于构造一个“有趣”的测试实例。对于 get_test_params 返回中的所有字典 params，调用 cls(**params) 都应有效。

get_test_params 无需返回固定的字典列表，它也可以返回动态或随机参数设置。

参数:

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

返回:

paramsdict 或 dict 列表，默认值 = {}: 用于创建类测试实例的参数每个 dict 都是构造“有趣”测试实例的参数，即 MyClass(**params) 或 MyClass(**params[i]) 创建一个有效的测试实例。create_test_instance 使用 params 中的第一个（或唯一一个）字典

is_composite()[source]#

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

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

返回:

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

返回:

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”，则将在当前工作目录创建 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 参数 (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，则抑制警告
- “mute_warnings”: 布尔类型, 默认为 False; 如果为 True，则抑制警告

返回:

self对 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对 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

deepbool，默认值=True

控制随机整数生成的伪随机数生成器。传递 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 的引用

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

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

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

set_tags(**tag_dict)[source]#

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

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

参数:

set_tags 方法只能在对象的 __init__ 方法中调用，即在构建过程中，或通过 __init__ 直接构建后调用。: **tag_dictdict

返回:

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