ItalyPowerDemand#

class ItalyPowerDemand(return_mtype='pd-multiindex')[source]#

ItalyPowerDemand 时间序列分类问题。

单变量等长序列问题的示例。

注意

维度：单变量 序列长度：24 训练样本：67 测试样本：1029 类别数量：2

数据来源于意大利的十二个每月电力需求时间序列，首次用于论文“Intelligent Icons: Integrating Lite-Weight Data Mining and Visualization into GUI Operating Systems”。分类任务是区分十月至三月（含）和四月至九月的日子。

数据集详情：http://timeseriesclassification.com/description.php?Dataset=ItalyPowerDemand

示例

>>> from sktime.datasets.classification import ItalyPowerDemand
>>> X, y = ItalyPowerDemand().load("X", "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()

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

keys()

返回可用集合的列表。

load(*args)

加载数据集。

load_from_path(serial)

从文件位置加载对象。

load_from_serial(serial)

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

loader_func([return_X_y, return_type])

加载 ItalyPowerDemand 时间序列分类问题。

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(return_X_y=True, return_type=None)[source]#

加载 ItalyPowerDemand 时间序列分类问题。

参数：
split: None 或 “TRAIN”, “TEST”之一，可选 (默认=None)

是否加载问题的训练集或测试集实例。默认情况下，加载训练集和测试集实例（在一个容器中）。

return_X_y: 布尔值，可选 (默认=True)

如果为 True，则单独返回 (特征, 目标)，而不是具有特征和目标列的单个数据框。

return_type: 有效的 Panel mtype 字符串或 None，可选 (默认=None=”nested_univ”)

返回 X 的内存数据格式规范，None = “nested_univ” 类型。字符串可以是任何支持的 sktime Panel mtype，

有关 mtype 列表，请参阅 datatypes.MTYPE_REGISTER；有关规范，请参阅 examples/AA_datatypes_and_datasets.ipynb

常用规范

“nested_univ”：单元格中的嵌套 pd.DataFrame, pd.Series “numpy3D”/”numpy3d”/”np3D”：3D np.ndarray (实例, 变量, 时间索引) “numpy2d”/”np2d”/”numpyflat”：2D np.ndarray (实例, 时间索引) “pd-multiindex”：具有 2 级 (实例, 时间) MultiIndex 的 pd.DataFrame

如果数据无法以请求的类型存储，则会引发异常。

返回：
X: sktime 数据容器，遵循 mtype 规范 return_type

问题的时序数据，包含 n 个实例

y: 长度为 n 的一维 numpy 数组，仅在 return_X_y 为 True 时返回

X 中每个时间序列实例的类别标签。如果 return_X_y 为 False，则 y 将附加到 X 中。

注意

维度：单变量 序列长度：24 训练样本：67 测试样本：1029 类别数量：2

数据来源于意大利的十二个每月电力需求时间序列，首次用于论文“Intelligent Icons: Integrating Lite-Weight Data Mining and Visualization into GUI Operating Systems”。分类任务是区分十月至三月（含）和四月至九月的日子。数据集详情：http://timeseriesclassification.com/description.php?Dataset=ItalyPowerDemand

示例

>>> from sktime.datasets import load_italy_power_demand
>>> X, y = load_italy_power_demand()
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 的默认值 (None) 克隆 estimator 的所有标签到 self。

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

参数：
estimator:class:BaseObject 或派生类的一个实例
tag_names字符串或字符串列表，默认 = None

要克隆的标签名称。默认值 (None) 克隆 estimator 的所有标签。

返回：
self

对自身的引用。

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

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

参数：
parameter_set字符串，默认=”default”

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

返回：
instance具有默认参数的类的实例
classmethod create_test_instances_and_names(parameter_set='default')[source]#

创建所有测试实例的列表及其名称列表。

参数：
parameter_set字符串，默认=”default”

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

返回：
objscls 的实例列表

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

names字符串列表，长度与 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_name字符串

标签值的名称。

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_tags字典

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

get_config()[source]#

获取自身的配置标志。

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

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

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

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

返回：
config_dict字典

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

classmethod get_param_defaults()[source]#

获取对象的参数默认值。

返回：
default_dict: dict[str, Any]

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

classmethod get_param_names(sort=True)[source]#

获取对象的参数名称。

参数：
sort布尔值，默认=True

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

返回：
param_names: list[str]

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

get_params(deep=True)[source]#

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

参数：
deep布尔值，默认=True

是否返回组件的参数。

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

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

返回：
params键为字符串的字典

参数字典，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_name字符串

要检索的标签名称

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

如果未找到标签，则为默认/回退值

raise_error布尔值

当未找到标签时是否引发 ValueError

返回：
tag_value任意类型

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_tags字典

标签名称 : 标签值对的字典。通过嵌套继承从 _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 of dict。

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

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

参数：
parameter_set字符串，默认=”default”

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

返回：
paramsdict 或 list of dict，默认 = {}

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

is_composite()[source]#

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

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

返回：
composite: 布尔值

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

keys()[source]#

返回可用集合的列表。

返回：
字符串列表

可用集合列表。

load(*args)[source]#

加载数据集。

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

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

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

对应 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) 输出的第 1 个元素
返回：
反序列化的自身，结果是 cls.save(None) 的输出 serial。
reset()[source]#

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

结果是将自身设置为构造函数调用后的状态，具有相同的超参数。set_config 设置的配置值也会保留。

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

  • 超参数 = 写入自身的 __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]#

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

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

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

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

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

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

  • path="/home/stored/estimator" 则将在

存储在 /home/stored/ 中。

serialization_format: 字符串，默认 = “pickle”

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

返回：
如果 path 为 None - 内存中的序列化自身
如果 path 是文件位置 - 指向文件的 ZipFile
set_config(**config_dict)[source]#

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

参数：
config_dict字典

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

display字符串，“diagram”（默认），或“text”

jupyter 内核如何显示自身的实例

  • “diagram” = html 框图表示

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

print_changed_only布尔值，默认=True

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

warnings字符串，“on”（默认），或“off”

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

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

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

backend:parallel字符串，可选，默认=”None”

广播/向量化时用于并行化的后端，以下之一：

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

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

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

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

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

backend:parallel:params字典，可选，默认={} (未传递参数)

作为配置传递给并行化后端的附加参数。有效键取决于 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”：布尔值，默认=True；False 阻止 ray

      在并行化后关闭。

    • “logger_name”：字符串，默认=”ray”；要使用的日志记录器名称。

    • “mute_warnings”：布尔值，默认=False；如果为 True，则抑制警告

返回：
self对自身的引用。

注意

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

set_params(**params)[source]#

设置此对象的参数。

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

参数：
**params字典

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

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

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

参数：
random_state整数，RandomState 实例或 None，默认=None

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

deep布尔值，默认=True

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

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

  • 如果为 True，则也会在组件对象中设置 random_state 参数。

self_policy字符串，以下之一：{“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_dict字典

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

返回：
Self

对自身的引用。