USChange#

class USChange[source]#

加载 USChange 数据集，用于预测消费和收入的增长率。

参数：
y_namestr, 可选 (默认="Consumption")

目标变量 (y) 的名称。

注意

该数据集包含美国从 1960 年到 2016 年个人消费支出、个人可支配收入、生产、储蓄和失业率的季度百分比变化。

维度：多元 列：['Consumption', 'Income', 'Production',

‘Savings’, ‘Unemployment’]

序列长度：188 频率：季度 案例数：1

这些数据显示出增长趋势、非恒定（增长）方差以及周期性和季节性模式。

参考

[1]

“Forecasting: Principles and Practice”（第2版）的数据。

示例

>>> from sktime.datasets.forecasting import USChange
>>> y, X = USChange().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()

获取自身的配置标志。

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

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

keys()

返回可用集合的列表。

load(*args)

加载数据集。

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)

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

get_loader_func

loader_func
loader_func()[source]#

加载 MTS 数据集，用于预测个人消费和收入的增长率。

返回：
ypd.Series

选定的列，默认为 consumption

Xpd.DataFrame

包含解释变量的列

注意

美国从 1960 年到 2016 年个人消费支出、个人可支配收入、生产、储蓄和失业率的季度百分比变化。

维度：多元 列：['Quarter', 'Consumption', 'Income', 'Production',

‘Savings’, ‘Unemployment’]

序列长度：188 频率：季度 案例数：1

这些数据显示出增长趋势、非恒定（增长）方差以及周期性和季节性模式。

参考

[1]

“Forecasting: Principles and Practice”（第2版）的数据

示例

>>> from sktime.datasets import load_uschange
>>> y, X = load_uschange()
cache_files_directory()[source]#

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

返回：
路径

缓存文件存储的目录

cleanup_cache_files()[source]#

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

clone()[source]#

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

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

等同于构造 type(self) 的新实例，参数与自身相同，即 type(self)(**self.get_params(deep=False))。

如果在自身上设置了配置，则克隆也将具有与原始对象相同的配置，等同于调用 cloned_self.set_config(**self.get_config())。

在值上也等同于调用 self.reset，不同之处在于 clone 返回一个新对象，而不是像 reset 那样改变自身。

引发：
如果克隆不符合要求，则引发 RuntimeError，这通常是由于 __init__ 有误。
clone_tags(estimator, tag_names=None)[source]#

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

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

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

clone_tags 从另一个对象 estimator 设置动态标签覆盖。

clone_tags 方法应仅在对象的 __init__ 方法中、构造期间或通过 __init__ 直接构造后调用。

动态标签被设置为 estimator 中标签的值，其名称在 tag_names 中指定。

tag_names 的默认设置将 estimator 中的所有标签写入自身。

当前标签值可以通过 get_tags 或 get_tag 进行检查。

参数：
estimatorBaseObject 或派生类的实例
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__}

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

自身中 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]#

获取对象的参数名称。

参数：
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 类型的字典

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

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

自身中 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 对象属性收集任何覆盖和新标签。

classmethod get_test_params(parameter_set='default')[source]#

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

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

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

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

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

参数：
parameter_setstr，默认="default"

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

返回：
paramsdict 或 dict 列表，默认 = {}

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

is_composite()[source]#

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

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

返回：
composite: bool

对象是否具有其值是 BaseObject 后代实例的任何参数。

keys()[source]#

返回可用集合的列表。

返回：
str 列表

可用集合的列表。

load(*args)[source]#

加载数据集。

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

具体类提供可用/有效字符串，此处文档字符串预计将被详细信息替换

返回：
dataset，如果 args 为空或长度为 1

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

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

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

classmethod load_from_path(serial)[source]#

从文件位置加载对象。

参数：
serialZipFile(path).open(“object) 的结果
返回：
通过 cls.save(path) 得到的序列化自身，输出在 path
classmethod load_from_serial(serial)[source]#

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

参数：
serialcls.save(None) 输出的第一个元素
返回：
通过 cls.save(None) 得到的序列化自身，输出 serial
reset()[source]#

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

结果是将自身设置为构造函数调用后直接所处的状态，具有相同的超参数。通过 set_config 设置的配置值也得到保留。

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

  • 超参数 = 写入自身的 __init__ 参数，例如 self.paramname，其中 paramname 是 __init__ 的参数。

  • 包含双下划线的对象属性，即字符串“__”。例如，名为“__myattr”的属性将被保留。

  • 配置属性，配置保持不变。也就是说，在 reset 之前和之后调用 get_config 的结果是相同的。

类和对象方法以及类属性也不受影响。

等同于 clone，不同之处在于 reset 会改变自身而不是返回一个新对象。

在调用 self.reset() 后，自身在值和状态上等于调用构造函数``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”，则在当前工作目录创建一个 estimator.zip zip 文件。

  • path=”/home/stored/estimator”，则在 /home/stored/ 中存储一个 estimator.zip zip 文件。

存储在 /home/stored/ 中。

serialization_format: str，默认 = “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 直接由 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>，也可以使用不带 <component>__ 的字符串 <parameter>。

参数：
**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 从链式哈希采样而来，并保证种子随机生成器之间具有伪随机独立性。

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

注意：即使 self 没有 random_state 参数，或者组件中没有 random_state 参数，也会调用 set_params。因此，set_random_state 将重置任何 scikit-base 对象，即使是那些没有 random_state 参数的对象。

参数：
random_stateint, RandomState instance 或 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)[源码]#

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

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

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

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

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

当前标签值可以通过 get_tags 或 get_tag 进行检查。

参数：
**tag_dictdict

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

返回：
Self

对 self 的引用。