SquaredDistrLoss

类 SquaredDistrLoss(multioutput='uniform_average', multivariate=False)

分布预测的平方损失。

也称为

• 连续 Brier 损失

• Gneiting 损失

• （平均）平方误差/损失，即与通常称为均方误差的点预测损失名称相同，容易混淆

对于预测分布 \(d\) 和真实值 \(y\)，平方（分布）损失定义为 \(L(y, d) := -2 p_d(y) + \|p_d\|^2\)，其中 \(\|p_d\|^2\) 是 \(p_d\) 的 (函数) L2-范数。

• evaluate 计算平均测试样本损失。

• evaluate_by_index 按测试数据点生成损失样本。

• multivariate 控制变量的平均计算。

参数：

multioutput{:raw_values’, ‘uniform_average’} 或形状类似于数组

(n_outputs,), 默认='uniform_average'

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

• 如果为 'uniform_average'（默认），误差将跨变量平均计算。

• 如果类似于数组，误差将跨变量进行加权平均，值用作权重。

• 如果为 'raw_values'，则不对跨变量的误差进行平均，保留列。

multivariate{:bool, 可选，默认=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()	获取 self 的配置标志。
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])	将序列化的 self 保存到类字节对象或 (.zip) 文件。
`set_config`(**config_dict)	将配置标志设置为给定值。
`set_params`(**params)	设置此对象的参数。
`set_random_state`([random_state, deep, ...])	为 self 设置 random_state 伪随机种子参数。
`set_tags`(**tag_dict)	将实例级别标签覆盖设置为给定值。

classmethod get_test_params(parameter_set='default')

检索测试参数。

__call__(y_true, y_pred, **kwargs)

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

参数：

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

真实（正确）目标值。

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

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

返回：

loss{:float 或包含计算指标值的一列 pd.DataFrame

如果 multioutput = “raw_values”，指标始终对 fh 值进行平均（算术平均），

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

如果 multioutput = multioutput = “uniform_average” 或类似于数组

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

如果 score_average = False，

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

如果 score_average = True，

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

clone()

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

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

等同于使用 self 的参数构造一个新的 type(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_names{:str 或 str 列表，默认 = None

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

返回：

self

对 self 的引用。

classmethod create_test_instance(parameter_set='default')

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

参数：

parameter_set{:str, 默认=”default”

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

返回：

instance{:使用默认参数的类实例

classmethod create_test_instances_and_names(parameter_set='default')

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

参数：

parameter_set{:str, 默认=”default”

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

返回：

objs{:cls 实例列表

第 i 个实例是 cls(**cls.get_test_params()[i])

names{:str 列表，与 objs 长度相同

第 i 个元素是测试中 obj 的第 i 个实例的名称。如果实例多于一个，命名约定为 {cls.__name__}-{i}，否则为 {cls.__name__}

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

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

参数：

y_true{:pd.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'，则不对跨变量的误差进行平均，保留列。

返回：

loss{:float 或包含计算指标值的一列 pd.DataFrame

如果 multioutput = “uniform_average”，则为 float，指标始终对 fh 值进行平均（算术平均）

evaluate_by_index(y_true, y_pred, multioutput='uniform_average', **kwargs)

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

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

真实（正确）目标值。

y_pred{:与 y_true 具有相同形状的 sktime BaseDistribution

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

返回：

loss{:`pd.Series` 或 `pd.DataFrame`

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

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

• 索引等于 `y_true` 的索引

• 索引 i 处的条目是时间 i 的指标，跨变量平均计算

如果 `self.multioutput="raw_values"`，则为 `pd.DataFrame`

• 索引和列与 `y_true` 的索引和列相等

• i,j-th 条目是时间 i、变量 j 处的指标

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_name{:str

标签值的名称。

tag_value_default{:任意类型，可选；默认=None

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

返回：

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_tags{:dict

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

get_config()

获取 self 的配置标志。

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

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

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

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

返回：

config_dictdict

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

classmethod get_param_defaults()

获取对象的默认参数。

返回：

default_dict: dict[str, Any]

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

classmethod get_param_names(sort=True)

获取对象的参数名称。

参数：

sortbool, default=True

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

返回：

param_names: list[str]

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

get_params(deep=True)

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

参数：

deepbool, default=True

是否返回组件的参数。

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

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

返回：

paramsdict with str-valued keys

参数字典，参数名称：参数值键值对包括

• 总是：此对象的所有参数，如通过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_name{:str

要检索的标签名称。

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_tags{:dict

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

is_composite()

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

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

返回：

composite: bool

对象是否包含任何参数的值是BaseObject的后代实例。

classmethod load_from_path(serial)

从文件位置加载对象。

参数：

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

返回：

反序列化的 self，其结果位于 path，来自 cls.save(path)

classmethod load_from_serial(serial)

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

参数：

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

返回：

反序列化的 self，其结果为 serial，来自 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')

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

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

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

参数：

pathNone或文件位置（str或Path）

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

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

• 如果path=”/home/stored/estimator”，则将在/home/stored/中存储一个名为estimator.zip的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 内核如何显示实例本身。

• “diagram” = html 方框图表示。

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

print_changed_onlybool, default=True

打印 self 时是否仅列出自参数与默认值不同的参数（False），或者列出所有参数名称和值（False）。不嵌套，即仅影响 self，不影响组件估计器。

warningsstr, “on” (默认), 或 “off”

是否引发警告，仅影响来自 sktime 的警告。

• “on” = 将引发来自 sktime 的警告。

• “off” = 将不引发来自 sktime 的警告。

backend:parallelstr, optional, default=”None”

广播/向量化时用于并行化的后端，以下之一：

• “None”：顺序执行循环，简单的列表推导。

• “loky”、“multiprocessing”和“threading”：使用joblib.Parallel。

• “joblib”：自定义和第三方joblib后端，例如spark。

• “dask”：使用dask，需要在环境中安装dask包。

• “ray”：使用ray，需要在环境中安装ray包。

backend:parallel:paramsdict, optional, default={} (未传递参数)

作为配置传递给并行化后端的额外参数。有效键取决于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> 也可以使用，如果这样使引用明确（例如，没有两个组件参数的名称相同为 <parameter>）。

参数：

**paramsdict

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

返回：

self对自身的引用（参数设置后）。

set_random_state(random_state=None, deep=True, self_policy='copy')

为 self 设置 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, default=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

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

返回：

自身

对自身的引用。