洗发水销量#

class ShampooSales[source]#

加载洗发水销量数据集用于单变量时间序列预测。

说明

该数据集描述了三年期间每月的洗发水销量。单位为销量计数。

维度: 单变量 序列长度: 36 频率: 月度 案例数: 1

参考文献

[1]

Makridakis, Wheelwright and Hyndman (1998) Forecasting: methods and applications, John Wiley & Sons: New York. Chapter 3.

示例

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

获取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])

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

is_composite()

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

keys()

返回可用集合列表。

load(*args)

加载数据集。

load_from_path(serial)

从文件位置加载对象。

load_from_serial(serial)

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

loader_func()

加载洗发水销量单变量时间序列数据集用于预测。

reset()

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

save([path, serialization_format])

将序列化的self保存到类似bytes的对象或(.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()[source]#

加载洗发水销量单变量时间序列数据集用于预测。

返回:
ypd.Series/DataFrame

洗发水销量数据集

说明

该数据集描述了三年期间每月的洗发水销量。单位为销量计数。

维度: 单变量 序列长度: 36 频率: 月度 案例数: 1

参考文献

[1]

Makridakis, Wheelwright and Hyndman (1998) Forecasting: methods

and applications,

John Wiley & Sons: New York. Chapter 3.

示例

>>> from sktime.datasets import load_shampoo_sales
>>> y = load_shampoo_sales()
cache_files_directory()[source]#

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

返回:
路径

缓存文件存储目录

cleanup_cache_files()[source]#

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

clone()[source]#

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

克隆是另一个对象，没有共享引用，处于初始化后状态。此函数等同于返回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。

抛出:
如果克隆不符合要求，由于错误的__init__，则抛出RuntimeError。
clone_tags(estimator, tag_names=None)[source]#

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

每个与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')[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个元素是测试中obj的第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

self中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]#

获取self的配置标志。

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

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, default=True

是否按字母顺序 (True) 或按其在类的 `__init__` 中出现的顺序 (False) 返回参数名称。

返回:
param_names: list[str]

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

get_params(deep=True)[source]#

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

参数:
deepbool, default=True

是否返回组件的参数。

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

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

返回:
paramsdict with str-valued keys

参数字典， 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)[source]#

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

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

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

`get_tag` 方法从实例中检索名称为 `tag_name` 的单个标签的值，同时考虑标签覆盖，优先级从高到低依次为：

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

在实例构建时设置的标签。

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

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

按继承顺序。

参数:
tag_namestr

要检索的标签名称

tag_value_defaultany type, optional; 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()[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`，或一个 `dict` 列表。

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

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

参数:
parameter_setstr，默认值="default"

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

返回:
paramsdict or list of dict, default = {}

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

is_composite()[source]#

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

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

返回:
composite: bool

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

keys()[source]#

返回可用集合列表。

返回:
list of str

可用数据集列表。

load(*args)[source]#

加载数据集。

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

具体的类提供可用/有效的字符串，此文档字符串预计将被详细说明所替换

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

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

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

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

classmethod load_from_path(serial)[source]#

从文件位置加载对象。

参数:
serialZipFile(path).open(“object) 的结果
返回:
反序列化的 self，产生位于 `path` 的输出，由 `cls.save(path)` 生成
classmethod load_from_serial(serial)[source]#

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

参数:
serial`cls.save(None)` 输出的第一个元素
返回:
反序列化的 self，产生输出 `serial`，由 `cls.save(None)` 生成
reset()[source]#

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

结果是将 `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')[source]#

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

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

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

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

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

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

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

`/home/stored/` 中存储一个 `estimator.zip` 文件。

serialization_format: str, default = “pickle”

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

返回:
如果 `path` 为 None - 内存中的序列化 self
如果 `path` 是文件位置 - 引用该文件的 ZipFile
set_config(**config_dict)[source]#

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

参数:
config_dictdict

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

displaystr, “diagram” (default), or “text”

jupyter 内核如何显示 self 的实例

  • “diagram” = html 框图表示

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

print_changed_onlybool, default=True

打印 self 时是否只列出与默认值不同的 self 参数 (True)，或所有参数名称和值 (False)。不进行嵌套，即只影响 self 而不影响组件估计器。

warningsstr, “on” (default), or “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={} (no parameters passed)

作为配置传递给并行化后端的附加参数。有效的键取决于 `backend:parallel` 的值

  • “None”：无附加参数，`backend_params` 被忽略

  • “loky”、“multiprocessing” 和 “threading”：默认的 `joblib` 后端。除了由 `backend` 直接控制的 `backend` 之外，`joblib.Parallel` 的任何有效键都可以在此处传递，例如 `n_jobs`。如果未传递 `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)[source]#

设置此对象的参数。

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

参数:
**paramsdict

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

返回:
self对 self 的引用（参数设置后）
set_random_state(random_state=None, deep=True, self_policy='copy')[source]#

为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 instance or None, default=None

伪随机数生成器，用于控制随机整数的生成。传入 int 可在多次函数调用中获得可重现的输出。

deepbool, default=True

是否在 skbase 对象类型参数（即组件估计器）中设置随机状态。

  • 如果为 False，则仅设置 `self` 的 `random_state` 参数（如果存在）。

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

self_policystr, one of {“copy”, “keep”, “new”}, default=”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 的引用。