Tecator#

类 Tecator[源]#

加载 Tecator 时间序列回归问题。

返回值:

X: sktime 数据容器，遵循 mtype 规范 return_type: 该问题的时间序列数据，包含 n 个实例
y: 长度为 n 的一维 numpy 数组，仅在 return_X_y 为 True 时返回: X 中每个时间序列实例的目标值。如果 return_X_y 为 False，则 y 将被附加到 X 中。

备注

维度：单变量序列长度：100 训练案例：172 测试案例：43

此数据集的目的是根据肉类的近: 红外吸收光谱来测量脂肪含量。

吸收光谱测量范围为 850 纳米到 1050 纳米。脂肪含量通过标准化学分析方法测量。数据集包含 215 个肉类样本，每个样本有 100 个光谱测量值。更多信息请参阅：https://www.openml.org/search?type=data&sort=runs&id=505&status=active

参考文献

[1] C.Borggaard and H.H.Thodberg, “Optimal Minimal Neural Interpretation of Spectra” , Analytical Chemistry 64 (1992), p 545-551. [2] H.H.Thodberg, “Ace of Bayes: Application of Neural Networks with Pruning” Manuscript 1132, Danish Meat Research Institute (1993), p 1-12.

示例

>>> from sktime.datasets.regression import Tecator
>>> dataset = Tecator()
>>> X, y = dataset.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`()	获取 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`([return_X_y, return_type, y_dtype])	加载 Tecator 时间序列回归问题并返回 X 和 y。
`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(return_X_y=True, return_type=None, y_dtype='float')[源]#

加载 Tecator 时间序列回归问题并返回 X 和 y。

参数:

split: None 或以下之一 “TRAIN”，“TEST”，可选（默认值为 None）

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

return_X_y: 布尔值，可选（默认值为 True）

如果为 True，则分别返回（特征，目标），而不是一个包含特征列和目标列的单一 dataframe。

return_type: 有效的 Panel mtype 字符串或 None，可选（默认值为 None=”nested_univ”）

返回 X 的内存数据格式规范，None = “nested_univ” 类型。str 可以是任何受支持的 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”

如果数据无法存储在请求的类型中，则会引发异常。y_dtype: float，可选（默认值为’float’）。目标变量的 dtype。

返回值:

X: sktime 数据容器，遵循 mtype 规范 return_type: 该问题的时间序列数据，包含 n 个实例
y: 长度为 n 的一维 numpy 数组，仅在 return_X_y 为 True 时返回: X 中每个时间序列实例的目标值。如果 return_X_y 为 False，则 y 将被附加到 X 中。

备注

维度：单变量序列长度：100 训练案例：172 测试案例：43

此数据集的目的是根据肉类的近: 红外吸收光谱来测量脂肪含量。

吸收光谱测量范围为 850 纳米到 1050 纳米。脂肪含量通过标准化学分析方法测量。数据集包含 215 个肉类样本，每个样本有 100 个光谱测量值。更多信息请参阅：https://www.openml.org/search?type=data&sort=runs&id=505&status=active

参考文献

[1] C.Borggaard and H.H.Thodberg, “Optimal Minimal Neural Interpretation of Spectra” , Analytical Chemistry 64 (1992), p 545-551. [2] H.H.Thodberg, “Ace of Bayes: Application of Neural Networks with Pruning” Manuscript 1132, Danish Meat Research Institute (1993), p 1-12.

示例

>>> from sktime.datasets import load_tecator
>>> X, y = load_tecator()

cache_files_directory()[源]#

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

返回值:

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

clone()[源]#

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

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

引发:

如果克隆不符合规范，则引发 RuntimeError，由于错误的 __init__。

clone_tags(estimator, tag_names=None)[源]#

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

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

clone_tags 从另一个对象 estimator 设置动态标签覆盖。

clone_tags 方法只能在对象的 __init__ 方法中、构造期间或通过 __init__ 直接在构造后调用。

动态标签被设置为 estimator 中标签的值，其名称在 tag_names 中指定。

tag_names 的默认值将 estimator 中的所有标签写入 self。

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

estimator:class:BaseObject 的实例或派生类

参数:

tag_names字符串或字符串列表，默认值为 None
要克隆的标签名称。默认值 (None) 克隆 estimator 中的所有标签。: self

返回值:

self 的引用。: 类方法 create_test_instance(parameter_set='default')[源]#

parameter_set字符串，默认值为”default”

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

参数:

要返回的测试参数集的名称，用于测试。如果未为某个值定义特殊参数，将返回 “default” 集。: instance带有默认参数的类的实例

返回值:

类方法 create_test_instances_and_names(parameter_set='default')[源]#

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

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

参数:

要返回的测试参数集的名称，用于测试。如果未为某个值定义特殊参数，将返回 “default” 集。: instance带有默认参数的类的实例

返回值:

objscls 实例的列表: 第 i 个实例是 cls(**cls.get_test_params()[i])
names字符串列表，与 objs 长度相同: 第 i 个元素是测试中 obj 的第 i 个实例的名称。命名约定是如果实例多于一个则为 {cls.__name__}-{i}，否则为 {cls.__name__}

类方法 get_class_tag(tag_name, tag_value_default=None)[源]#

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

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

clone_tags 从另一个对象 estimator 设置动态标签覆盖。

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

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

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

按照继承顺序。

不考虑实例上的动态标签覆盖，即通过 set_tags 或 clone_tags 设置、在实例上定义的标签。

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

参数:

tag_name字符串: 标签值的名称。
tag_value_default任何类型: 如果未找到标签，则使用的默认值/回退值。

返回值:

tag_value: self 中名为 tag_name 的标签的值。如果未找到，则返回 tag_value_default。

类方法 get_class_tags()[源]#

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

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

clone_tags 从另一个对象 estimator 设置动态标签覆盖。

get_class_tags 方法是一个类方法，它检索标签的值，仅考虑类级别的标签值和覆盖。

它返回一个字典，其键是类或其任何父类中设置的任何 _tags 属性的键。

值是对应的标签值，覆盖优先级降序如下：

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

按照继承顺序。

实例可以根据超参数覆盖这些标签。

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

不考虑实例上的动态标签覆盖，即通过 set_tags 或 clone_tags 设置、在实例上定义的标签。

要包含来自动态标签的覆盖，请使用 get_tags。

返回值:

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

get_config()[源]#

获取 self 的配置标志。

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

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

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

在调用 clone 或 reset 时会保留配置。

返回值:

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

类方法 get_param_defaults()[源]#

获取对象的参数默认值。

返回值:

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

类方法 get_param_names(sort=True)[源]#

获取对象的参数名称。

参数:

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

返回值:

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

get_params(deep=True)[源]#

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

参数:

deep布尔值，默认值为 True

是否返回组件的参数。

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

返回值:

params带有字符串值键的字典

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

总是：此对象的所有参数，如通过 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)[源]#

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

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

clone_tags 从另一个对象 estimator 设置动态标签覆盖。

get_tag 方法从实例中检索名为 tag_name 的单个标签的值，考虑到标签覆盖，按以下优先级降序：

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

在实例构造时。

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

按照继承顺序。

参数:

tag_name字符串: 要检索的标签名称
tag_value_default任何类型，可选；默认值为 None: 如果未找到标签，则使用的默认值/回退值
raise_error布尔值: 当未找到标签时是否引发 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 兼容对象都有一个标签字典。标签可用于存储有关对象的元数据，或控制对象的行为。

clone_tags 从另一个对象 estimator 设置动态标签覆盖。

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

值是对应的标签值，覆盖优先级降序如下：

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

在实例构造时。

在类的 _tags 属性中设置的标签。
在父类的 _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，或一个 dict 的 list。

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

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

参数:

要返回的测试参数集的名称，用于测试。如果未为某个值定义特殊参数，将返回 “default” 集。: instance带有默认参数的类的实例

返回值:

paramsdict 或 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]#

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

参数:

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

返回值:

反序列化 self，结果为 serial，来自 cls.save(None)

reset()[source]#

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

结果是使 self 恢复到构造函数调用后的状态，具有相同的超参数。set_config 设置的配置值也会被保留。

reset 调用会删除所有对象属性，除了

超参数 = __init__ 的参数，写入到 self 中，例如 self.paramname，其中 paramname 是 __init__ 的参数。
包含双下划线的对象属性，即字符串“__”。例如，名为“__myattr”的属性会被保留。
config 属性，config 会被保留不变。也就是说，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”，则将在当前工作目录创建一个 zip 文件 estimator.zip。
path=”/home/stored/estimator”，则将在 /home/stored/

存储一个 zip 文件 estimator.zip。

serialization_format: str, default = “pickle”

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

返回值:

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

set_config(**config_dict)[source]#

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

参数:

config_dict字典

config 名称 : config 值对的字典。有效的 config、值及其含义列于下方

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

jupyter 内核如何显示 self 的实例

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

print_changed_onlybool, default=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，可选，默认={}（不传递参数）

作为 config 传递给并行化后端的附加参数。有效键取决于 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, default=True; False 会阻止 ray 在并行化后
  关闭。
- “logger_name”: str, default=”ray”; 要使用的日志记录器名称。
- “mute_warnings”: bool, default=False; 如果为 True，抑制警告

返回值:

self对 self 的引用。

备注

改变对象状态，将 config_dict 中的 configs 复制到 self._config_dynamic。

set_params(**params)[source]#

设置此对象的参数。

此方法适用于简单的 skbase 对象以及复合对象。对于复合对象，即包含其他对象的对象，可以使用参数键字符串 <component>__<parameter> 来访问组件 <component> 中的 <parameter>。如果引用是明确的，例如没有两个组件参数同名为 <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, default=None

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

deep布尔值，默认值为 True

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

如果为 False，则仅设置 self 的 random_state 参数（如果存在）。
如果为 True，则也会设置组件对象中的 random_state 参数。

self_policystr, {“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 兼容对象都有一个标签字典。标签可用于存储有关对象的元数据，或控制对象的行为。

clone_tags 从另一个对象 estimator 设置动态标签覆盖。

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

set_tags 方法只能在对象的 __init__ 方法中调用，即在构造期间，或通过 __init__ 构造后直接调用。

estimator:class:BaseObject 的实例或派生类

参数:

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

返回值:

Self: 对 self 的引用。