CRPS#

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

用于分布预测的连续排序概率得分。

也称为

  • 集成平方损失 (ISL)

  • 集成布莱尔损失 (IBL)

  • 能量损失

对于预测分布 \(d\) 和真实值 \(y\)，CRPS 定义为 \(L(y, d) := \mathbb{E}_{Y \sim d}|Y-y| - \frac{1}{2} \mathbb{E}_{X,Y \sim d}|X-Y|\)。

evaluate 计算平均测试样本损失。evaluate_by_index 根据测试数据点产生损失样本。multivariate 控制变量上的平均。

参数:
multioutput{‘raw_values’, ‘uniform_average’} 或 形状为 array-like 的

(n_outputs,)，默认值='uniform_average'

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

  • 如果是 'uniform_average' (默认值)，错误在变量上进行平均。

  • 如果是 array-like，错误根据变量进行加权平均，值作为权重。

  • 如果是 'raw_values'，则不平均变量上的错误，保留列。

multivariate布尔值，可选，默认值=False

  • 如果为 True，则作为多元 CRPS：为整行计算得分，每行一个得分

  • 如果为 False，则为单变量 CRPS：为每个变量边缘计算得分，每行产生多个得分

方法

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

检查对象是否由其他 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)

将实例级别标签覆盖设置为给定值。
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 或 包含计算出的指标值(es) 的 1 列 pd.DataFrame

如果 multioutput = “raw_values”，指标总是（算术）平均 over fh 值

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

如果 multioutput = multioutput = “uniform_average” 或 array-like

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

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

参数:
estimator是 :class:BaseObject 或派生类的一个实例
tag_namesstr 或 str 列表，默认值 = None

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

返回值:
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 个元素是测试中 objs 的第 i 个实例的名称。如果多于一个实例，命名约定是 {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,) 的 array-like，默认值='uniform_average'

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

  • 如果是 'uniform_average' (默认值)，错误在变量上进行平均。

  • 如果是 array-like，错误根据变量进行加权平均，

值作为权重。* 如果是 'raw_values'，则不平均变量上的错误，保留列。

返回值:
lossfloat 或 包含计算出的指标值(es) 的 1 列 pd.DataFrame

如果 multioutput = “uniform_average”，指标总是（算术）平均 over 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 伪值）。

pd.Series 如果 self.multioutput="uniform_average" 或 array-like

  • 索引等于 y_true 的索引

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

pd.DataFrame 如果 self.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 的标签值，考虑标签覆盖，优先级降序如下：

  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]#

获取自身的配置标志。

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

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]#

获取对象的参数名称。

参数:
sort布尔值，默认值=True

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

返回值:
param_names: list[str]

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

get_params(deep=True)[source]#

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

参数:
deep布尔值，默认值=True

是否返回组件的参数。

  • 如果为 True，将为此对象返回一个参数名 : 值 的 dict，包括组件的参数（= 值类型为 BaseObject 的参数）。

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

返回值:
params键为 str 类型的 dict

参数字典，参数名 : 参数值 键值对包括

  • 始终：此对象的所有参数，通过 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_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_tagsdict

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

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 调用会删除所有对象属性，除了：

  • 超参数 = __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，默认值 = “pickle”

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

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

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

参数:
config_dictdict

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

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

jupyter kernel 如何显示自身的实例

  • “diagram” = html 框图表示

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

print_changed_only布尔值，默认值=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”：布尔值，默认值=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>。

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

deep布尔值，默认值=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)

对自身的引用。