Longley#

class Longley(y_name: str = 'TOTEMP')[源码]#

加载用于带外生变量预测的 Longley 数据集。

参数:
y_name: str, 可选 (默认值=”TOTEMP”)

目标变量 (y) 的名称

说明

该多元时间序列数据集包含 1947 年至 1962 年间的各种美国宏观经济变量，已知它们具有高度共线性。

维度: 多元, 6 序列长度: 16 频率: 年度 案例数: 1

变量描述

TOTEMP - 总就业人数 GNPDEFL - 国民生产总值平减指数 GNP - 国民生产总值 UNEMP - 失业人数 ARMED - 武装部队人数 POP - 人口

参考文献

[1]

Longley, J.W. (1967) “An Appraisal of Least Squares Programs for the Electronic Computer from the Point of View of the User.” Journal of the American Statistical Association. 62.319, 819-41. (https://www.itl.nist.gov/div898/strd/lls/data/LINKS/DATA/Longley.dat)

示例

>>> from sktime.datasets.forecasting import Longley
>>> y, X = Longley().load("y", "X")

方法

cache_files_directory()

获取缓存文件存储目录。

cleanup_cache_files()

清除缓存目录中的缓存文件。

clone()

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

clone_tags(estimator[, tag_names])

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

create_test_instance([parameter_set])

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

create_test_instances_and_names([parameter_set])

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

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 组成。

keys()

返回可用集合的列表。

load(*args)

加载数据集。

load_from_path(serial)

从文件位置加载对象。

load_from_serial(serial)

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

loader_func()

加载用于带外生变量预测的 Longley 数据集。

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)

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

get_loader_func
loader_func()[源码]#

加载用于带外生变量预测的 Longley 数据集。

参数:
y_name: str, 可选 (默认值=”TOTEMP”)

目标变量 (y) 的名称

返回值:
y: pd.Series

要预测的目标序列。

X: pd.DataFrame

问题的外生时间序列数据。

说明

该多元时间序列数据集包含 1947 年至 1962 年间的各种美国宏观经济变量，已知它们具有高度共线性。

维度: 多元, 6 序列长度: 16 频率: 年度 案例数: 1

变量描述

TOTEMP - 总就业人数 GNPDEFL - 国民生产总值平减指数 GNP - 国民生产总值 UNEMP - 失业人数 ARMED - 武装部队人数 POP - 人口

参考文献

[1]

Longley, J.W. (1967) “An Appraisal of Least Squares Programs for the Electronic Computer from the Point of View of the User.” Journal of the American Statistical Association. 62.319, 819-41. (https://www.itl.nist.gov/div898/strd/lls/data/LINKS/DATA/Longley.dat)

示例

>>> from sktime.datasets import load_longley
>>> y, X = load_longley()
classmethod get_test_params(parameter_set='default')[源码]#

数据集的测试参数设置。

cache_files_directory()[源码]#

获取缓存文件存储目录。

返回值:
路径

缓存文件存储目录

cleanup_cache_files()[源码]#

清除缓存目录中的缓存文件。

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。

抛出:
如果克隆不符合规范，则抛出 RuntimeError，原因可能是 __init__ 有错误。
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 个元素是测试中第 i 个 obj 实例的名称。如果实例多于一个，命名约定为 {cls.__name__}-{i}，否则为 {cls.__name__}

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任何类型，可选；默认值=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字典

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

get_config()[源码]#

获取 self 的配置标志。

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

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

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

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

返回值:
config_dict字典

配置名称 : 配置值 对的字典。通过嵌套继承从 _config 类属性收集，然后应用来自 _config_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 类型键的字典

参数字典，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 在实例上设置的标签，

在实例构造时。

  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()[源码]#

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

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

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

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

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

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

在实例构造时。

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

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

按继承顺序。

返回值:
collected_tags字典

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

is_composite()[源码]#

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

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

返回值:
composite: bool

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

keys()[源码]#

返回可用集合的列表。

返回值:
str 列表

可用集合列表。

load(*args)[源码]#

加载数据集。

参数:
*args: 指定要加载内容的字符串元组

具体类提供了可用/有效字符串，期望此文档字符串替换为详细信息

返回值:
数据集，如果 args 为空或长度为一

与 args 中的字符串对应的数据容器（见上文）

元组，与 args 长度相同，如果 args 长度为 2 或更长

与 args 中的字符串对应的数据容器，顺序相同

classmethod load_from_path(serial)[源码]#

从文件位置加载对象。

参数:
serialZipFile(path).open(“object) 的结果
返回值:
通过 cls.save(path) 在 path 输出的已反序列化的 self
classmethod load_from_serial(serial)[源码]#

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

参数:
serialcls.save(None) 输出的第一个元素
返回值:
通过 cls.save(None) 输出 serial 的已反序列化的 self
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” 则会在当前工作目录 (cwd) 创建一个 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)[源码]#

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

参数:
config_dict字典

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

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

jupyter 内核如何显示 self 的实例

  • “diagram” = html 框图表示

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

print_changed_onlybool, 默认值=True

打印 self 时是仅列出自参数与默认值不同的参数（True），还是列出所有参数名称和值（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:params字典, 可选, 默认值={} (未传递参数)

作为配置传递给并行化后端的附加参数。有效键取决于 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对 self 的引用。

说明

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

set_params(**params)[源码]#

设置此对象的参数。

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

参数:
**params字典

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

返回值:
self对 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 从链式哈希中采样，并保证种子随机生成器的伪随机独立性。

仅当 deep=True 时，根据 self_policy，应用于 self 中的 random_state 参数以及其余组件对象。

注意：即使 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指向 self 的引用
set_tags(**tag_dict)[source]#

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

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

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

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

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

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

参数:
**tag_dictdict

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

返回值:
Self

指向 self 的引用。