Solar#

类 Solar(start='2021-05-01', end='2021-09-01', normalise=True, return_full_df=False, api_version='v4')[源代码]#

加载用于时间序列预测的英国国家太阳能估算数据集。

此类封装了 Sheffield Solar PV_Live API，用于提取英国电网的国家太阳能数据。请注意，这些是对真实太阳能发电量的估算，因为真实值是“电表后”且未知的。

参数:

startstring, 默认值=”2021-05-01”: 时间序列的开始日期，格式为“YYYY-MM-DD”。
endstring, 默认值=”2021-09-01”: 时间序列的结束日期，格式为“YYYY-MM-DD”。
normaliseboolean, 默认值=True: 按装机容量对返回的时间序列进行归一化。
return_full_dfboolean, 默认值=False: 返回一个包含功率、容量和归一化估算的 pd.DataFrame。
api_versionstring 或 None, 默认值=”v4”: 要调用的 API 版本。如果为 None，则加载数据的存储样本。

注释

返回的时间序列是半小时的。更多信息，请参考

参考文献

[1]

https://www.solar.sheffield.ac.uk/pvlive/

[2]

https://www.solar.sheffield.ac.uk/pvlive/api/

示例

>>> from sktime.datasets.forecasting import Solar
>>> y = Solar().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])	返回测试参数。
`is_composite`()	检查对象是否由其他 BaseObject 组成。
`keys`()	返回可用集合列表。
`load`(*args)	加载数据集。
`load_from_path`(serial)	从文件位置加载对象。
`load_from_serial`(serial)	从序列化内存容器加载对象。
`loader_func`([end, normalise, ...])	从 Sheffield Solar PV_Live API 获取英国的国家太阳能估算数据。
`reset`()	将对象重置为初始干净状态。
`save`([path, serialization_format])	将序列化的自身保存为字节类对象或 (.zip) 文件。
`set_config`(**config_dict)	将配置标志设置为给定值。
`set_params`(**params)	设置此对象的参数。
`set_random_state`([random_state, deep, ...])	设置自身的伪随机种子参数。
`set_tags`(**tag_dict)	将实例级别标签覆盖设置为给定值。

get_loader_func

loader_func(end='2021-09-01', normalise=True, return_full_df=False, api_version='v4')[源代码]#

从 Sheffield Solar PV_Live API 获取英国的国家太阳能估算数据。

此函数调用 Sheffield Solar PV_Live API，以提取英国电网的国家太阳能数据。请注意，这些是对真实太阳能发电量的估算，因为真实值是“电表后”且基本上未知的。

返回的时间序列是半小时的。有关更多信息，请参阅 [1, 2]_。

参数:

startstring, 默认值=”2021-05-01”: 时间序列的开始日期，格式为“YYYY-MM-DD”
endstring, 默认值=”2021-09-01”: 时间序列的结束日期，格式为“YYYY-MM-DD”
normaliseboolean, 默认值=True: 是否按装机容量对返回的时间序列进行归一化？
return_full_dfboolean, 默认值=False: 是否返回包含功率、容量和归一化估算的 pd.DataFrame？
api_versionstring 或 None, 默认值=”v4”: 要调用的 API 版本。如果为 None，则加载数据的存储样本。

返回:

ypd.Series: 太阳能发电时间序列，根据参数要求，见上文

参考文献

[1]

https://www.solar.sheffield.ac.uk/pvlive/

[2]

https://www.solar.sheffield.ac.uk/pvlive/api/

示例

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

classmethod get_test_params(parameter_set='default')[源代码]#: 返回测试参数。

cache_files_directory()[源代码]#

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

返回:

cleanup_cache_files()[源代码]#: 从缓存目录清理缓存文件。

clone()[源代码]#

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

克隆是一个没有共享引用、处于初始状态的独立对象。此函数等同于返回自身的 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)[源代码]#

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

每个 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: 对自身的引用。

classmethod create_test_instance(parameter_set='default')[源代码]#

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

参数:

parameter_setstr, 默认值=”default”: 要返回的测试参数集的名称，用于测试。如果未为某个值定义特殊参数，则返回 “default” 集。

返回:

instance带有默认参数的类的实例

classmethod create_test_instances_and_names(parameter_set='default')[源代码]#

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

参数:

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)[源代码]#

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

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

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

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

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

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

按继承顺序。

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

要检索具有潜在实例覆盖的标签值，请使用 get_tag 方法。

参数:

tag_namestr: 标签值的名称。
tag_value_defaultany type: 如果找不到标签，则使用默认/回退值。

返回:

tag_value: self 中 tag_name 标签的值。如果找不到，返回 tag_value_default。

classmethod get_class_tags()[源代码]#

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

每个 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()[源代码]#

获取自身的配置标志。

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

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

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

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

返回:

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

classmethod get_param_defaults()[源代码]#

获取对象的参数默认值。

返回:

default_dict: dict[str, Any]: 键是 cls 的所有在 __init__ 中定义了默认值的参数。值是在 __init__ 中定义的默认值。

classmethod get_param_names(sort=True)[源代码]#

获取对象的参数名称。

参数:

sortbool, 默认值=True: 是否按字母顺序返回参数名称 (True)，或按它们在类 __init__ 中出现的顺序返回 (False)。

返回:

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

get_params(deep=True)[源代码]#

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

参数:

deepbool, 默认值=True

是否返回组件的参数。

如果为 True，将返回此对象的参数名：参数值字典，包括组件的参数（= BaseObject 值的参数）。
如果为 False，将返回此对象的参数名：参数值字典，但不包括组件的参数。

返回:

params键为 str 值的字典

参数字典，参数名：参数值键值对包括

总是：此对象的所有参数，如 get_param_names 所示，值是该键的参数值，为此对象的值，始终与构造时传递的值相同
如果 deep=True，也包含组件参数的键/值对，组件参数按 [组件名]__[参数名] 索引，组件名 的所有参数显示为 参数名 及其值
如果 deep=True，也包含任意级别的组件递归，例如 [组件名]__[子组件名]__[参数名] 等。

get_tag(tag_name, tag_value_default=None, raise_error=True)[源代码]#

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

每个 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()[源代码]#

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

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

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

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

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

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

在实例构造时。

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

按继承顺序。

返回:

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

is_composite()[源代码]#

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

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

返回:

composite: bool: 对象是否包含任何其值是 BaseObject 后代实例的参数。

keys()[源代码]#

返回可用集合列表。

返回:

str 列表: 可用集合列表。

load(*args)[源代码]#

加载数据集。

参数:

*args: 指定要加载内容的字符串元组: 可用/有效的字符串由具体类提供，期望此文档字符串被详细内容替换

返回:

数据集，如果 args 为空或长度为一: 对应于 args 中字符串的数据容器（见上文）
元组，长度与 args 相同，如果 args 长度为 2 或更长: 对应于 args 中字符串的数据容器，顺序相同

classmethod load_from_path(serial)[源代码]#

从文件位置加载对象。

参数:

serialZipFile(path).open(“object) 的结果

返回:

在 path 位置反序列化的自身，是 cls.save(path) 的输出

classmethod load_from_serial(serial)[源代码]#

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

参数:

serialcls.save(None) 输出的第一个元素

返回:

反序列化的自身，结果为 serial，是 cls.save(None) 的输出

reset()[源代码]#

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

导致将 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')[源代码]#

将序列化的自身保存为字节类对象或 (.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/ 中存储一个 zip 文件 estimator.zip。

存储在 /home/stored/ 中。

serialization_format: str, 默认值 = “pickle”

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

返回:

如果 path 为 None - 内存中的序列化自身
如果 path 是文件位置 - 包含文件引用的 ZipFile

set_config(**config_dict)[源代码]#

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

参数:

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)[源代码]#

设置此对象的参数。

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

参数:

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

返回:

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

set_random_state(random_state=None, deep=True, self_policy='copy')[源代码]#

设置自身的伪随机种子参数。

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