AUCalibration#

class AUCalibration(multioutput='uniform_average', multivariate=False)[source]#

分布预测的校准曲线下面积。

计算校准曲线与对角线之间的无符号面积。

校准曲线是根据真实值评估的预测累积分布函数样本的累积曲线。

数学上，设 \(d_1, \dots, d_N\) 为预测分布，设 \(y_1, \dots, y_N\) 为真实值，设 \(F_i\) 为 \(d_i\) 的累积分布函数。

定义校准样本为 \(c_i := F_i(y_i)\)，对于 \(i = 1, \dots, N\)。对于完美预测，\(c_i\) 的样本将均匀分布在 [0, 1] 上，并且独立同分布于该均匀分布。

设 \(c_{(i)}\) 是 \(c_i\) 样本的第 \(i\) 个顺序统计量，即样本中第 \(i\) 小的值。

校准曲线下的（无符号）面积 - 或者更精确地说，是对角线与校准曲线之间的面积 - 定义为

\[\frac{1}{N} \sum_{i=1}^N \left| c_{(i)} - \frac{i}{N} \right|.\]

  • evaluate 返回校准曲线与对角线之间的无符号面积，即上述量。

  • evaluate_by_index 返回对于第 \(i\) 个测试样本的值 \(\left| c_i - \frac{r_i}{N} \right|\)，其中 \(r_i\) 是 \(c_i\) 在 \(c_i\) 样本中的秩。如果存在并列，则取并列秩的平均值。

  • multivariate 控制跨变量的平均。

参数：
multioutput{‘raw_values’, ‘uniform_average’} 或形状为 (n_outputs,) 的数组类型，默认为’uniform_average’

(n_outputs,), default=’uniform_average’

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

  • 如果为’uniform_average’（默认），则在变量间平均误差。

  • 如果为数组类型，则按权重在变量间加权平均误差，值作为权重。

  • 如果为’raw_values’，则不在变量间平均误差，保留列。

multivariatebool，可选，默认为False

  • 如果为True，则表现为多变量指标（分数之和）：对整个行计算指标，每行产生一个分数

  • 如果为False，则为单变量指标，按变量计算：对每个变量的边际计算指标，每行产生多个分数

方法

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

将实例级别标签覆盖设置为给定值。
classmethod get_test_params(parameter_set='default')[source]#

检索测试参数。

__call__(y_true, y_pred, **kwargs)[source]#

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

参数：
y_truepd.Series, pd.DataFrame 或 形状为 (fh,) 或 (fh, n_outputs) 的 np.array，其中 fh 是预测范围

真实（正确）目标值。

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

必须位于预测范围 fh 且变量与 y_true 中的变量相同。

返回：
lossfloat 或 包含计算指标值（一个或多个）的 1 列 pd.DataFrame

如果 multioutput = “raw_values”，则指标始终在预测范围 fh 值上平均（算术平均），

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

如果 multioutput = multioutput = “uniform_average” 或数组类型

条目将在输出变量列上平均

如果 score_average = False，

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

如果 score_average = True，

条目将在分位数/区间列上平均

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 查看。

参数：
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 个元素是测试中第 i 个 obj 实例的名称。如果实例多于一个，命名约定为 {cls.__name__}-{i}，否则为 {cls.__name__}

evaluate(y_true, y_pred, multioutput=None, **kwargs)[source]#

对给定输入评估所需指标。

参数：
y_truepd.Series, pd.DataFrame 或 形状为 (fh,) 或 (fh, n_outputs) 的 np.array，其中 fh 是预测范围

真实（正确）目标值。

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

必须位于预测范围 fh 且变量与 y_true 中的变量相同

multioutput{‘raw_values’, ‘uniform_average’} 或形状为 (n_outputs,) 的数组类型，默认为’uniform_average’

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

  • 如果为’uniform_average’（默认），则在变量间平均误差。

  • 如果为数组类型，则按权重在变量间加权平均误差，

值作为权重。* 如果为’raw_values’，则不在变量间平均误差，保留列。

返回：
lossfloat 或 包含计算指标值（一个或多个）的 1 列 pd.DataFrame

如果 multioutput = “uniform_average”，则为 float 指标始终在预测范围 fh 值上平均（算术平均）

evaluate_by_index(y_true, y_pred, multioutput='uniform_average', **kwargs)[source]#

寻找在每个索引处评估的指标的逻辑。

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

真实（正确）目标值。

y_pred与 y_true 形状相同的 sktime BaseDistribution

预测分布。必须具有与 y_true 相同的索引和列。

返回：
losspd.Series 或 pd.DataFrame

计算的指标，按时间点计算（默认=jackknife 伪值）。

如果 self.multioutput="uniform_average" 或数组类型，则为 pd.Series

  • 索引等于 y_true 的索引

  • 索引 i 处的条目是时间 i 的指标，在变量上平均

如果 self.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_default任意类型

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

返回：
tag_value

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

classmethod get_class_tags()[source]#

从类获取类标签，包括来自父类的标签级别继承。

每个 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()[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 值的字典

参数字典，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_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 设置的标签。

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

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

在实例构造时设置的标签。

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

  2. 在父类的 _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]#

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

参数：
serialcls.save(None) 输出的第 1 个元素
返回：
在 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)) 后获得的对象相等。

返回：
self

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

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

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

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

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

参数：
pathNone 或文件位置 (str 或 Path)

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

  • path=”estimator”，则将在当前工作目录中创建一个 zip 文件 estimator.zip。

  • path=”/home/stored/estimator”，则将创建一个 zip 文件 estimator.zip

存储在 /home/stored/ 中。

serialization_format: str, default = “pickle”

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

返回：
如果 path 为 None - 内存中的序列化自身
如果 path 是文件位置 - 引用该文件的 ZipFile
set_config(**config_dict)[source]#

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

参数：
config_dictdict

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

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

jupyter 内核如何显示自身实例

  • “diagram”= html 方框图表示

  • “text”= 字符串打印输出

print_changed_onlybool，默认为True

打印自身时是仅列出与默认值不同的自身参数（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 可在多次函数调用中获得可复现的输出。

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)[source]#

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

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

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

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

set_tags 方法只应在对象的 __init__ 方法中（构造期间）或通过 __init__ 构造后直接调用。

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

参数：
**tag_dictdict

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

返回：
自身

自身的引用。