Airline#

class Airline[source]#

加载 airline 单变量时间序列数据集 [1]。

注意

经典的 Box & Jenkins airline 数据。国际航空公司乘客月度总量，1949 年至 1960 年。

维度：单变量序列长度：144 频率：月度案例数量：1

该数据显示出上升趋势、非恒定（增加）方差和周期性、季节性模式。

参考文献

[1]

Box, G. E. P., Jenkins, G. M. and Reinsel, G. C. (1976) Time Series Analysis, Forecasting and Control. Third Edition. Holden-Day. Series G.

示例

>>> from sktime.datasets.forecasting import Airline
>>> dataset = Airline()
>>> y = dataset.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`()	加载 airline 单变量时间序列数据集 [1]。
`reset`()	将对象重置到干净的初始化后状态。
`save`([path, serialization_format])	将序列化的 self 保存到字节类对象或 (.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]#

加载 airline 单变量时间序列数据集 [1]。

返回值:

ypd.Series: 时间序列

注意

经典的 Box & Jenkins airline 数据。国际航空公司乘客月度总量，1949 年至 1960 年。

维度：单变量序列长度：144 频率：月度案例数量：1

该数据显示出上升趋势、非恒定（增加）方差和周期性、季节性模式。

参考文献

[1]

Box, G. E. P., Jenkins, G. M. and Reinsel, G. C. (1976) Time Series Analysis, Forecasting and Control. Third Edition. Holden-Day. Series G.

示例

>>> from sktime.datasets import load_airline
>>> y = load_airline()

cache_files_directory()[source]#

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

返回值:

cleanup_cache_files()[source]#: 清理缓存目录中的缓存文件。

clone()[source]#

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

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

等同于构造一个新的 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 个元素是测试中第 i 个 obj 实例的名称。如果实例多于一个，命名约定为 {cls.__name__}-{i}，否则为 {cls.__name__}

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

从类中获取类标签值，带有来自父类的标签级别继承。

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

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

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

它从对象中返回名称为 tag_name 的标签值，按以下优先级降序考虑标签覆盖

类 _tags 属性中设置的标签。
父类 _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 的任何属性的键。

值是相应的标签值，按以下优先级降序覆盖

类 _tags 属性中设置的标签。
父类 _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，默认为 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 的单个标签值，按以下优先级降序考虑标签覆盖

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

在实例构造时。

类 _tags 属性中设置的标签。
父类 _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 设置的标签。

值是相应的标签值，按以下优先级降序覆盖

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

在实例构造时。

类 _tags 属性中设置的标签。
父类 _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 或 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: 指定加载内容的字符串元组: 可用/有效字符串由具体类提供，预期此 docstring 将被详细信息替换

返回值:

数据集，如果 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)` 输出的第 1 个元素

返回值:

反序列化的 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 保存到字节类对象或 (.zip) 文件。

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

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

参数:

pathNone 或文件位置 (str 或 Path)

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

path=”estimator”，则将在当前工作目录 (cwd) 创建一个 estimator.zip 文件。
path=”/home/stored/estimator”，则将创建一个 estimator.zip 文件并

存储在 /home/stored/ 中。

serialization_format: str，默认为 “pickle”

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

返回值:

如果 path 为 None - 内存中的序列化 self
如果 path 是文件位置 - 引用该文件的 ZipFile

set_config(**config_dict)[source]#

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

参数:

config_dictdict

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

displaystr，“diagram”（默认）或“text”

jupyter 内核如何显示 self 的实例

“diagram” = html 框图表示
“text” = 字符串打印输出

print_changed_onlybool，默认为 True

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

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

注意

更改对象状态，将 config_dict 中的配置复制到 self._config_dynamic。

set_params(**params)[source]#

设置此对象的参数。

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

参数:

**paramsdict: BaseObject 参数，键必须是 <component>__<parameter> 字符串。如果 __ 后缀在 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 实例或 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: 对自身的引用。