M5Dataset#

class M5Dataset(extract_path: str = None)[source]#

从 https://zenodo.org/records/12636070 获取 M5 数据集。

如果数据集尚未下载，则下载并解压。获取的数据集采用标准 .csv 格式，并加载到 sktime 兼容的内存格式 (pd_multiindex_hier) 中。有关数据集的更多信息，包括其结构和内容，请参阅注意事项部分。

属性：
path_to_data_dir

存储数据的目录路径。

注意事项

数据集包含三个主要文件：- sales_train_validation.csv：每个产品和商店的每日销售数据 - sell_prices.csv：每个产品和商店的价格数据 - calendar.csv：包括事件的日历信息

数据框将具有多级索引，包括以下级别：- state_id - store_id - dept_id - cat_id - item_id - date

维度：单变量 时间序列长度：约 5800 万行（完整数据集）。频率：每日 特征数量：8 层级级别：5

示例

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

将实例级别标签覆盖设置为给定值。
cache_files_directory()[source]#

返回存储数据的目录路径。

property path_to_data_dir[source]#

存储数据的目录路径。

返回存储数据的目录路径。

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

cleanup_cache_files()[source]#

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

clone()[source]#

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

等效于构造一个 type(self) 的新实例，使用 self 的参数，即 type(self)(**self.get_params(deep=False))。

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

其值也等效于调用 self.reset，不同之处在于 clone 返回一个新对象，而不是像 reset 那样修改 self。
抛出：
如果由于有缺陷的 __init__ 导致克隆不符合要求，则抛出 RuntimeError。

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

clone_tags(estimator, tag_names=None)[source]#

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

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

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 的引用。

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

可以通过 get_tags 或 get_tag 检查当前的标签值。
classmethod create_test_instance(parameter_set='default')[source]#

parameter_set str，默认值=”default”

要克隆的标签名称。默认值（None）将克隆 estimator 中的所有标签。
要返回的测试参数集的名称，用于测试。如果某个值没有定义特殊参数，将返回 “default” 集。
instance 具有默认参数的类实例

创建所有测试实例的列表以及它们的名称列表。

可以通过 get_tags 或 get_tag 检查当前的标签值。
classmethod create_test_instance(parameter_set='default')[source]#

parameter_set str，默认值=”default”

要克隆的标签名称。默认值（None）将克隆 estimator 中的所有标签。
classmethod create_test_instances_and_names(parameter_set='default')[source]#

objs cls 实例列表

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

names str 列表，与 objs 长度相同

第 i 个元素是 objs 中第 i 个实例在测试中的名称。命名约定是 {cls.__name__}-{i}（如果实例不止一个）或 {cls.__name__}（如果只有一个实例）

从类中获取类标签值，并继承父类的标签级别。

clone_tags(estimator, tag_names=None)[source]#

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

classmethod get_class_tag(tag_name, tag_value_default=None)[source]#

get_class_tag 方法是一个类方法，它仅考虑类级别的标签值和覆盖设置来检索标签值。

  1. 它从对象中返回名称为 tag_name 的标签值，考虑以下优先顺序（优先级从高到低）：

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

在父类的 _tags 属性中设置的标签，按继承顺序排列。

不考虑通过 set_tags 或 clone_tags 在实例上设置的动态标签覆盖。

要检索包含潜在实例覆盖的标签值，请改用 get_tag 方法。

可以通过 get_tags 或 get_tag 检查当前的标签值。
tag_name str

标签值的名称。

tag_value_default 任意类型

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

要克隆的标签名称。默认值（None）将克隆 estimator 中的所有标签。
tag_value

self 中 tag_name 标签的值。如果未找到，则返回 tag_value_default。

classmethod get_class_tags()[source]#

从类中获取类标签，并继承父类的标签级别。

clone_tags(estimator, tag_names=None)[source]#

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

get_class_tags 方法是一个类方法，它仅考虑类级别的标签值和覆盖设置来检索标签值。

它返回一个字典，其中的键是类或其任何父类中设置的 _tags 属性的任何键。

值是相应的标签值，覆盖设置按以下优先顺序（优先级从高到低）排列

  1. 它从对象中返回名称为 tag_name 的标签值，考虑以下优先顺序（优先级从高到低）：

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

在父类的 _tags 属性中设置的标签，按继承顺序排列。

实例可以根据超参数覆盖这些标签。

要检索包含潜在实例覆盖的标签，请改用 get_tags 方法。

不考虑通过 set_tags 或 clone_tags 在实例上设置的动态标签覆盖。

要包含动态标签的覆盖，请使用 get_tags。

要克隆的标签名称。默认值（None）将克隆 estimator 中的所有标签。
collected_tags dict

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

get_config()[source]#

获取对象的配置标志。

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

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

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

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

要克隆的标签名称。默认值（None）将克隆 estimator 中的所有标签。
config_dict dict

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

classmethod get_param_defaults()[source]#

获取对象的默认参数。

要克隆的标签名称。默认值（None）将克隆 estimator 中的所有标签。
default_dict: dict[str, Any]

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

classmethod get_param_names(sort=True)[source]#

获取对象的参数名称。

可以通过 get_tags 或 get_tag 检查当前的标签值。
sort bool，默认值=True

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

要克隆的标签名称。默认值（None）将克隆 estimator 中的所有标签。
param_names: list[str]

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

get_params(deep=True)[source]#

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

可以通过 get_tags 或 get_tag 检查当前的标签值。
deep bool，默认值=True

是否返回组件的参数。

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

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

要克隆的标签名称。默认值（None）将克隆 estimator 中的所有标签。
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]#

从实例中获取标签值，并继承标签级别和覆盖设置。

clone_tags(estimator, tag_names=None)[source]#

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

get_tag 方法从实例中检索单个标签的值，名称为 tag_name，考虑以下优先顺序（优先级从高到低）：

  1. 在实例构造时通过 set_tags 或 clone_tags 在实例上设置的标签。

要检索的标签名称

  1. 它从对象中返回名称为 tag_name 的标签值，考虑以下优先顺序（优先级从高到低）：

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

在父类的 _tags 属性中设置的标签，按继承顺序排列。

可以通过 get_tags 或 get_tag 检查当前的标签值。
tag_name str

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

如果未找到标签，则使用的默认/回退值

raise_error bool

如果未找到标签是否抛出 ValueError

tag_value Any

要克隆的标签名称。默认值（None）将克隆 estimator 中的所有标签。
self 中 tag_name 标签的值。如果未找到，当 raise_error 为 True 时抛出错误，否则返回 tag_value_default。

ValueError，如果 raise_error 为 True。

其值也等效于调用 self.reset，不同之处在于 clone 返回一个新对象，而不是像 reset 那样修改 self。
当 tag_name 不在 self.get_tags().keys() 中时，将抛出 ValueError。

get_tags()[source]#

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

从实例中获取标签，并继承标签级别和覆盖设置。

clone_tags(estimator, tag_names=None)[source]#

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

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

值是相应的标签值，覆盖设置按以下优先顺序（优先级从高到低）排列

  1. 在实例构造时通过 set_tags 或 clone_tags 在实例上设置的标签。

要检索的标签名称

  1. 它从对象中返回名称为 tag_name 的标签值，考虑以下优先顺序（优先级从高到低）：

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

在父类的 _tags 属性中设置的标签，按继承顺序排列。

要克隆的标签名称。默认值（None）将克隆 estimator 中的所有标签。
collected_tags dict

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

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

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

get_test_params 应该返回一个单独的 dict 或一个 dict 列表。

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

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

params dict 或 dict 列表，默认值 = {}

可以通过 get_tags 或 get_tag 检查当前的标签值。
classmethod create_test_instance(parameter_set='default')[source]#

parameter_set str，默认值=”default”

要克隆的标签名称。默认值（None）将克隆 estimator 中的所有标签。
用于创建类测试实例的参数

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

is_composite()[source]#

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

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

要克隆的标签名称。默认值（None）将克隆 estimator 中的所有标签。
composite: bool

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

keys()[source]#

返回可用集合的列表。

要克隆的标签名称。默认值（None）将克隆 estimator 中的所有标签。
str 列表

可用集合的列表。

load(*args)[source]#

加载数据集。

可以通过 get_tags 或 get_tag 检查当前的标签值。
*args: 指定要加载内容的字符串元组

可用/有效字符串由具体类提供

要克隆的标签名称。默认值（None）将克隆 estimator 中的所有标签。
预期此文档字符串将被详细信息替换

数据集，如果 args 为空或长度为一

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

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

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

从文件位置加载对象。

可以通过 get_tags 或 get_tag 检查当前的标签值。
classmethod load_from_path(serial)[source]#
要克隆的标签名称。默认值（None）将克隆 estimator 中的所有标签。
serial ZipFile(path).open("object") 的结果
cls.save(path) 在 path 输出位置生成的反序列化对象

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

可以通过 get_tags 或 get_tag 检查当前的标签值。
classmethod load_from_serial(serial)[source]#
要克隆的标签名称。默认值（None）将克隆 estimator 中的所有标签。
serial cls.save(None) 输出的第一个元素
cls.save(None) 生成的输出 serial 的反序列化对象

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

reset()[source]#

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

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

  • 超参数 = 写入对象的 __init__ 参数，例如 self.paramname，其中 paramname 是 __init__ 的参数

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

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

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

等效于 clone，不同之处在于 reset 修改对象本身而不是返回一个新对象。

要克隆的标签名称。默认值（None）将克隆 estimator 中的所有标签。
返回：

在调用 self.reset() 后，对象在值和状态上与通过构造函数调用``type(self)(**self.get_params(deep=False))`` 获取的对象相同。

类实例重置到干净的初始化后状态，但保留当前的超参数值。

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

save(path=None, serialization_format='pickle')[source]#

行为：如果 path 为 None，则返回内存中的序列化对象。如果 path 是文件位置，则将对象保存到该位置，以 zip 文件形式存储。

可以通过 get_tags 或 get_tag 检查当前的标签值。
保存的文件是 zip 文件，包含以下内容：_metadata - 包含对象的类，即 type(self) _obj - 序列化的对象。此类使用默认序列化（pickle）。

path None 或文件位置 (str 或 Path)

  • 如果为 None，则将对象保存到内存对象中。如果 `path` 是文件位置，则将对象保存到该文件位置。

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

如果 path=”/home/stored/estimator”，则会在 /home/stored/ 中存储 estimator.zip 文件。

serialization_format: str，默认值 = “pickle”

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

要克隆的标签名称。默认值（None）将克隆 estimator 中的所有标签。
如果 path 为 None - 内存中的序列化对象
如果 path 是文件位置 - ZipFile 对象，引用该文件
set_config(**config_dict)[source]#

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

可以通过 get_tags 或 get_tag 检查当前的标签值。
config_dict dict

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

display str，“diagram”（默认）或“text”

jupyter 内核如何显示对象的实例

  • “diagram” = html 框图表示

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

print_changed_only bool，默认值=True

打印对象时是仅列出与默认值不同的自身参数（True），还是列出所有参数名称和值（False）。不进行嵌套，即仅影响对象本身，不影响组件估计器。

warnings str，“on”（默认）或“off”

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

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

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

backend:parallel str，可选，默认值=”None”

在广播/向量化时用于并行化的后端，可选项包括

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

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

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

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

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

backend:parallel:params dict，可选，默认值={}（不传递参数）

作为配置传递给并行化后端的附加参数。有效键取决于 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，则抑制警告

要克隆的标签名称。默认值（None）将克隆 estimator 中的所有标签。
self 对对象的引用。更改对象状态，将 config_dict 中的配置复制到 self._config_dynamic。

注意事项

set_params(**params)[source]#

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

设置此对象的参数。

**params dict

可以通过 get_tags 或 get_tag 检查当前的标签值。
BaseObject 参数，键必须是 <component>__<parameter> 字符串。如果 __ 后缀在 get_params 键中是唯一的，则可以作为完整字符串的别名。

self 对对象的引用（设置参数后）

要克隆的标签名称。默认值（None）将克隆 estimator 中的所有标签。
set_random_state(random_state=None, deep=True, self_policy='copy')[source]#
通过 self.get_params 查找名为 random_state 的参数，并通过 set_params 将它们设置为从 random_state 通过链式哈希（使用 sample_dependent_seed）导出的整数。这些整数保证了种子随机生成器的伪随机独立性。

为对象设置 random_state 伪随机种子参数。

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

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

random_state int，RandomState 实例或 None，默认值=None

可以通过 get_tags 或 get_tag 检查当前的标签值。
伪随机数生成器，用于控制随机整数的生成。传递 int 可在多次函数调用中获得可重现的输出。

是否在 skbase 对象值的参数中设置随机状态，即组件估计器。

deep bool，默认值=True

如果为 False，则仅设置对象自身的 random_state 参数（如果存在）。

  • 如果为 True，也将设置组件对象中的 random_state 参数。

  • self_policy str，可选项之一 {“copy”, “keep”, “new”}，默认值=”copy”

“copy”：对象的 random_state 设置为输入的 random_state

  • “keep”：对象的 random_state 保持不变

  • “new”：对象的 random_state 设置为一个新的随机状态，由输入的 random_state 导出，通常与它不同

  • self 对对象的引用

set_tags(**tag_dict)[source]#

要克隆的标签名称。默认值（None）将克隆 estimator 中的所有标签。
set_tags 将动态标签覆盖设置为 tag_dict 中指定的值，其中键是标签名称，字典值是要设置的标签值。
set_tags 方法应仅在对象的 __init__ 方法中，即构造期间，或通过 __init__ 直接在构造后调用。

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

clone_tags(estimator, tag_names=None)[source]#

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

**tag_dict dict

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

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

可以通过 get_tags 或 get_tag 检查当前的标签值。
Self

对对象的引用。

要克隆的标签名称。默认值（None）将克隆 estimator 中的所有标签。
本页内容

M5Dataset.cache_files_directory