宏观经济学#

类 Macroeconomic[源代码]#

加载美国宏观经济数据集用于多元时间序列预测。

注释

该数据集包含 1959 年第一季度至 2009 年第三季度的美国宏观经济数据。

维度：多元，14个序列 长度：203 频率：季度 案例数：1

此数据通过 statsmodels.datasets.macrodata 友好地封装。

参考资料

[2]

数据来源：FRED，美国联邦储备经济数据，圣路易斯联邦储备银行；http://research.stlouisfed.org/fred2/；访问日期：2009年12月15日。

[3]

数据来源：美国劳工部劳动统计局；http://www.bls.gov/data/；访问日期：2009年12月15日。

示例

>>> from sktime.datasets.forecasting import Macroeconomic
>>> y = Macroeconomic().load("y")

方法

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

获取自身的配置标志。

get_param_defaults()

获取对象的参数默认值。

get_param_names([sort])

获取对象的参数名称。

get_params([deep])

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

get_tag(tag_name[, tag_value_default, ...])

从实例获取标签值，具有标签级别继承和覆盖。

get_tags()

从实例获取标签，具有标签级别继承和覆盖。

get_test_params([parameter_set])

返回 skbase 对象的测试参数设置。

is_composite()

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

keys()

返回可用集的列表。

load(*args)

加载数据集。

load_from_path(serial)

从文件位置加载对象。

load_from_serial(serial)

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

loader_func()

加载美国宏观经济数据 [1]。

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)

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

get_loader_func
loader_func()[源代码]#

加载美国宏观经济数据 [1]。

返回值:
ypd.DataFrame

时间序列

注释

1959 年第一季度至 2009 年第三季度的美国宏观经济数据。

维度：多元，14个序列 长度：203 频率：季度 案例数：1

此数据通过 statsmodels.datasets.macrodata 友好地封装。

参考资料

[2]

数据来源：FRED，美国联邦储备经济数据，圣路易斯联邦储备银行；http://research.stlouisfed.org/fred2/；访问日期：2009年12月15日。

[3]

数据来源：美国劳工部劳动统计局；http://www.bls.gov/data/；访问日期：2009年12月15日。

示例

>>> from sktime.datasets import load_macroeconomic
>>> y = load_macroeconomic()
cache_files_directory()[源代码]#

获取缓存文件存储的目录。

返回值:
路径

缓存文件存储的目录

cleanup_cache_files()[源代码]#

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

clone()[源代码]#

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

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

等同于构造 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 或 list of 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__}。

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，将返回此对象的参数名称：值字典，包括组件的参数（= 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)[源代码]#

从实例获取标签值，具有标签级别继承和覆盖。

每个 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_tagsdict

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

classmethod get_test_params(parameter_set='default')[源代码]#

返回 skbase 对象的测试参数设置。

get_test_params 是一个统一的接口点，用于存储测试目的的参数设置。此函数也用于 create_test_instance 和 create_test_instances_and_names 构造测试实例。

get_test_params 应返回一个单个 dict，或一个 dict 的 list。

每个 dict 都是一个测试参数配置，可用于构造一个“有趣”的测试实例。对于 get_test_params 返回中的所有字典 params，调用 cls(**params) 应该是有效的。

get_test_params 不一定返回固定的字典列表，它也可以返回动态或随机参数设置。

参数:
parameter_setstr, 默认=”default”

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

返回值:
paramsdict 或 list of dict, 默认 = {}

创建类的测试实例的参数。每个 dict 都是构造一个“有趣”测试实例的参数，即 MyClass(**params) 或 MyClass(**params[i]) 创建一个有效的测试实例。create_test_instance 使用 params 中的第一个（或唯一的）字典。

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) 的结果
返回值:
反序列化的自身，结果输出在 path 处，即 cls.save(path) 的输出。
classmethod load_from_serial(serial)[源代码]#

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

参数:
serialcls.save(None) 输出的第一个元素
返回值:
反序列化的自身，结果输出 serial，即 cls.save(None) 的输出。
reset()[源代码]#

将对象重置到干净的初始化后状态。

结果是将 self 设置到构造函数调用后立即拥有的状态，具有相同的超参数。通过 set_config 设置的配置值也会保留。

调用 reset 会删除任何对象属性，除了：

  • 超参数 = 写入到 self 的 __init__ 参数，例如 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')[源代码]#

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

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

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

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

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

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

  • path=”/home/stored/estimator”，则会在

存储在 /home/stored/ 中。

serialization_format: str, 默认 = “pickle”

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

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

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

参数:
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)[源代码]#

设置此对象的参数。

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

参数:
**paramsdict

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

返回值:
self
对自身的引用（参数已设置后）

为自身设置 random_state 伪随机种子参数。

set_random_state(random_state=None, deep=True, self_policy='copy')[源代码]#

通过 self.get_params 查找名为 random_state 的参数，并通过 set_params 将它们设置为从 random_state 派生的整数。这些整数通过 sample_dependent_seed 从链式哈希中采样，并保证种子随机生成器的伪随机独立性。

适用于 self 中的 random_state 参数（取决于 self_policy），以及仅当 deep=True 时才适用于剩余的组件对象。

参数:
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

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

返回值:
Self

对自身的引用。