Lynx#

class Lynx[source]#

加载 Lynx 数据集用于单变量时间序列预测。

注释

此数据集包含加拿大从 1821 年到 1934 年的年度猞猁捕获数量。它记录了哈德逊湾公司多年来收集的猞猁皮数量。数据来自 Brockwell & Davis (1991)，并由 Campbell & Walker (1977) 进行了分析。

维度：单变量 序列长度：114 频率：年度 案例数：1

这些数据显示出非周期性、循环性模式，而非周期性、季节性模式。

参考文献

[1]

Becker, R. A., Chambers, J. M. and Wilks, A. R. (1988). The New S

Language. Wadsworth & Brooks/Cole.

[2]

Campbell, M. J. and Walker, A. M. (1977). A Survey of statistical

work on the Mackenzie River series of annual Canadian lynx trappings for the years 1821-1934 and a new analysis. Journal of the Royal Statistical Society series A, 140, 411-431.

示例

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

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

keys()

返回可用数据集的列表。

load(*args)

加载数据集。

load_from_path(serial)

从文件位置加载对象。

load_from_serial(serial)

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

loader_func()

加载 Lynx 单变量时间序列数据集用于预测。

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

加载 Lynx 单变量时间序列数据集用于预测。

返回:
ypd.Series/DataFrame

Lynx 销售数据集

注释

加拿大 1821-1934 年的年度猞猁捕获数量。此时间序列记录了哈德逊湾公司多年来收集的捕食者（猞猁）皮的数量。该数据集取自 Brockwell & Davis (1991)，并且似乎是 Campbell & Walker (1977) 所考虑的系列。

维度：单变量 序列长度：114 频率：年度 案例数：1

这些数据显示出非周期性、循环性模式，而非周期性、季节性模式。

参考文献

[1]

Becker, R. A., Chambers, J. M. and Wilks, A. R. (1988). The New S

Language. Wadsworth & Brooks/Cole.

[2]

Campbell, M. J. and Walker, A. M. (1977). A Survey of statistical

work on the Mackenzie River series of annual Canadian lynx trappings for the years 1821-1934 and a new analysis. Journal of the Royal Statistical Society series A, 140, 411-431.

示例

>>> from sktime.datasets import load_lynx
>>> y = load_lynx()
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 或 list of 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 的键值对，通常用作控制行为的瞬时标志。

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，将返回此对象的参数名称 : 值 的 dict，包括组件的参数（= BaseObject 值的参数）。

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

返回:
params键为 str 值的 dict

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

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

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

返回:
composite: bool

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

keys()[source]#

返回可用数据集的列表。

返回:
list of str

可用数据集列表。

load(*args)[source]#

加载数据集。

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

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

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

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

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

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

classmethod load_from_path(serial)[source]#

从文件位置加载对象。

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

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

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

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

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

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

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

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

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

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

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

  • path=”/home/stored/estimator”，则 zip 文件 estimator.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 直接控制。如果未传递 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>，也可以使用字符串 <parameter>，而无需 <component>__。

参数:
**paramsdict

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

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

取决于 self_policy，应用于 self 中的 random_state 参数，并且当且仅当 deep=True 时应用于剩余的组件对象。

注意：即使 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 派生，并且通常与它不同

返回:
set_tags(**tag_dict)[source]#
set_tags(**tag_dict)[source]#

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

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

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

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

set_tags 方法应仅在对象的 __init__ 方法中，在构建期间调用，或在通过 __init__ 构建后直接调用。

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

参数:
**tag_dictdict

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

返回:
Lynx.loader_func

Lynx.cache_files_directory