经验覆盖率

class EmpiricalCoverage(multioutput='uniform_average', score_average=True, coverage=None)

区间预测的经验覆盖率百分比。

参数:

multioutput{‘raw_values’, ‘uniform_average’} 或 shape 为 (n_outputs,) 的 array-like 对象, 默认为 ‘uniform_average’

定义是否以及如何跨变量聚合指标。

• 如果是 ‘uniform_average’ (默认值), 则对跨变量的误差取平均值。

• 如果是 array-like, 则对跨变量的误差进行加权平均, 值作为权重。

• 如果是 ‘raw_values’, 则不对跨变量的误差取平均值, 保留列。

score_averagebool 类型, 可选, 默认为 True

指定是否应对每个覆盖率值的分数进行平均。

• 如果为 True, 则对 y_pred 中存在的所有覆盖率的指标/损失进行平均。

• 如果为 False, 则不对覆盖率的指标/损失取平均值。

coverage (可选)float, float 列表, 或 1D array-like 对象, 默认为 None

用于评估指标的名义覆盖率。如果在直接使用该指标时没有显式指定覆盖率（例如通过 evaluate 进行基准测试，或通过 ForecastingGridSearchCV 进行调优），则可以指定此参数。

方法

__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[, multioutput])	在给定输入上评估所需的指标。
evaluate_by_index(y_true, y_pred[, multioutput])	返回在每个时间点评估的指标。
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()	检索测试参数。
is_composite()	检查对象是否由其他 BaseObjects 组成。
load_from_path(serial)	从文件位置加载对象。
load_from_serial(serial)	从序列化的内存容器加载对象。
reset()	将对象重置为干净的初始化后状态。
save([path, serialization_format])	将序列化的自身保存到 bytes-like 对象或 (.zip) 文件。
set_config(**config_dict)	将配置标志设置为给定值。
set_params(**params)	设置此对象的参数。
set_random_state([random_state, deep, ...])	设置自身的 random_state 伪随机种子参数。
set_tags(**tag_dict)	将实例级标签覆盖设置为给定值。

classmethod get_test_params()

检索测试参数。

__call__(y_true, y_pred, **kwargs)

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

参数:

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

真实 (正确) 目标值。

y_pred概率预测方法 scitype:y_pred 的返回对象

必须在 fh 处且变量与 y_true 中的变量相等。

返回值:

lossfloat 或 包含计算出的指标值(s) 的单列 pd.DataFrame

如果 multioutput = “raw_values”, 则指标始终对 fh 值取平均值 (算术平均),

将有一个列级别对应于 y_true 中的变量

如果 multioutput = “uniform_average” 或 array-like

条目将对输出变量列取平均值

如果 score_average = False,

将有对应于分位数/区间的列级别

如果 score_average = True,

条目将对分位数/区间列取平均值

clone()

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

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

从另一个对象克隆标签作为动态覆盖。

每个 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 或 str 列表，默认为 None

要克隆的标签名称。默认值 (None) 克隆 estimator 中的所有标签。

返回值:

self

对 self 的引用。

classmethod create_test_instance(parameter_set='default')

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

参数:

parameter_setstr 类型，默认为 “default”

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

返回值:

instance带有默认参数的类实例

classmethod create_test_instances_and_names(parameter_set='default')

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

参数:

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, multioutput=None, **kwargs)

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

参数:

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

真实 (正确) 目标值。

y_pred概率预测方法 scitype:y_pred 的返回对象

必须在 fh 处且变量与 y_true 中的变量相等

multioutput字符串 “uniform_average” 或 “raw_values” 决定了如何处理多输出结果。

返回值:

lossfloat 或 包含计算出的指标值(s) 的单列 pd.DataFrame

如果 multioutput = “raw_values”, 则指标始终对 fh 值取平均值 (算术平均),

将有一个列级别对应于 y_true 中的变量

如果 multioutput = “uniform_average” 或 array-like

条目将对输出变量列取平均值

如果 score_average = False,

将有对应于分位数/区间的列级别

如果 score_average = True,

条目将对分位数/区间列取平均值

evaluate_by_index(y_true, y_pred, multioutput=None, **kwargs)

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

参数:

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

真实 (正确) 目标值。

y_pred概率预测方法 scitype:y_pred 的返回对象

必须在 fh 处且变量与 y_true 中的变量相等

multioutput字符串 “uniform_average” 或 “raw_values” 决定了如何处理多输出结果。

返回值:

loss长度为 len(fh) 的 pd.DataFrame，包含计算出的指标值(s)

如果 multioutput = “raw_values”, 则第 i 列包含在第 i 个 fh 元素处的预测指标值(s),

将有一个列级别对应于 y_true 中的变量

如果 multioutput = “uniform_average” 或 array-like

条目将对输出变量列取平均值

如果 score_average = False,

将有对应于分位数/区间的列级别

如果 score_average = True,

条目将对分位数/区间列取平均值

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_namestr 类型

标签值的名称。

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_tagsdict 类型

标签名称 : 标签值 对的字典。通过嵌套继承从 _tags 类属性中收集。不会被通过 set_tags 或 clone_tags 设置的动态标签覆盖。

get_config()

获取自身的配置标志。

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

get_config 返回动态配置，这些配置会覆盖默认配置。

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

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

返回值:

config_dictdict 类型

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

classmethod get_param_defaults()

获取对象的默认参数。

返回值:

default_dict: dict[str, Any]

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

classmethod get_param_names(sort=True)

获取对象的参数名称。

参数:

sortbool 类型，默认为 True

是否按字母顺序 (True) 或在类 __init__ 中出现的顺序 (False) 返回参数名称。

返回值:

param_names: list[str]

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

get_params(deep=True)

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

参数:

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)

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

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

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

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

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

在实例构造时。

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

3. 在父类的 _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()

从实例中获取标签，并应用标签级别继承和覆盖。

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

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

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

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

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

在实例构造时。

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

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

按照继承顺序。

返回值:

collected_tagsdict 类型

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

is_composite()

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

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

返回值:

composite: bool

对象是否包含任何参数，其值是 BaseObject 的派生实例。

classmethod load_from_path(serial)

从文件位置加载对象。

参数:

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

返回值:

在 path 处输出的反序列化后的 self，来自 cls.save(path)

classmethod load_from_serial(serial)

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

参数:

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

返回值:

输出 serial 的反序列化后的 self，来自 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))`` 后获得的对象相同。

返回值:

self

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

save(path=None, serialization_format='pickle')

将序列化的自身保存到 bytes-like 对象或 (.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” 则将在 /home/stored/ 中创建 zip 文件 estimator.zip。

存储在 /home/stored/ 中。

serialization_format: str, default = “pickle”

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

返回值:

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

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

set_config(**config_dict)

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

参数:

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，则抑制警告

返回值:

self

注意事项

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

set_params(**params)

设置此对象的参数。

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

参数:

**paramsdict 类型

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

返回值:

self自身引用 (参数设置后)

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

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自身引用

set_tags(**tag_dict)

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

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

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

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

set_tags 方法应仅在对象的 __init__ 方法中调用，在构建期间，或通过 __init__ 构建后直接调用。

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

参数:

**tag_dictdict

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

返回值:

Self

自身引用。