此页面由 AI 自动翻译。查看英文原版
最后更新

本页目录

  • 类
  • DatasetMetadata
Claude CodeCodexCursor
Luxonis 智能体工具包为你常用的编程智能体加载 Luxonis 上下文与技能,更快地基于 OAK 开发应用。
安装工具包

dataset_metadata

最后更新
Python API: luxonis_train.utils.dataset_metadata节点读取的数据集元数据。元数据包含类名、关键点计数以及来自加载器的元数据标签类型。

类

DatasetMetadata

数据集的类名、关键点计数和元数据类型。节点从该对象读取其类计数、类名和关键点计数,因此配置不必设置它们。 from_loader 从加载器创建对象。 dump 返回一个检查点存储的字典,构造函数接受该字典作为关键字参数。

方法

init
Python
1def __init__(*, classes: dict[str, dict[str, int]] | None = None, n_keypoints: dict[str, int] | None = None, metadata_types: dict[str, type[int] | type[Category] | type[float] | type[str]] | None = None, loader: BaseLoaderTorch | None = None):
从普通字典初始化元数据。metadata_types 中的值也可以是类型名称:"int"、"float"、"str" 或 "Category" 之一。构造函数将名称转换为类型。这是 dump 写入并由检查点存储的形式。参数
  • classes (dict[str, dict[str, int]] | None): 任务名称映射到任务的类名及其索引。None 表示没有任务。
  • n_keypoints (dict[str, int] | None): 任务名称映射到任务的关键点数量。None 表示没有关键点。
  • metadata_types (dict[str, type[int] | type[Category] | type[float] | type[str]] | None): 元数据标签名称(例如 "<task>/metadata/<name>")映射到其值的类型。None 表示没有元数据标签。
  • loader (BaseLoaderTorch | None): 提供元数据的加载器。对象保留对其的引用,但不使用它。
引发
  • ValueError: 当 metadata_types 中的类型名称不是四个支持的名称之一时。
classes
Python
1def classes(task_name: str | None = None) -> bidict[str, int]:
获取任务的类名和索引。参数
  • task_name (str | None): 要读取的任务。None 表示所有任务,此时所有任务必须具有相同的类。
返回
  • bidict[str, int]: 一个新的双向字典,将类名映射到类索引。其 inverse 将索引映射回名称。
引发
  • ValueError: 当 task_name 不是数据集的任务时。
  • RuntimeError: 当 task_name 为 None 且任务具有不同的类时。
  • StopIteration: 当 task_name 为 None 且元数据没有任务时。
dump
Python
1def dump(self) -> dict[str, Any]:
将元数据转储到普通值字典中。构造函数接受结果作为关键字参数。这是检查点存储和恢复元数据的方式。返回
  • dict[str, Any]: 包含键 "classes"、"n_keypoints" 和 "metadata_types" 的字典。元数据类型显示为类型名称,例如 "str"。
from_loader
Python
1def from_loader(loader: BaseLoaderTorch) -> DatasetMetadata:
从加载器创建元数据。该方法读取 loader.get_classes()、loader.get_n_keypoints() 和 loader.get_metadata_types()。新对象保留对 loader 的引用。参数
  • loader (BaseLoaderTorch): 要读取的加载器。
返回
  • DatasetMetadata: 加载器数据集的元数据。
n_classes
Python
1def n_classes(task_name: str | None = None) -> int:
获取任务的类数量。参数
  • task_name (str | None): 要读取的任务。None 表示所有任务,此时所有任务必须具有相同的类数量。
返回
  • int: 任务的类数量。
引发
  • ValueError: 当 task_name 不是数据集的任务时。
  • RuntimeError: 当 task_name 为 None 且任务具有不同的类数量时。
  • StopIteration: 当 task_name 为 None 且元数据没有任务时。
n_keypoints
Python
1def n_keypoints(task_name: str | None = None) -> int:
获取任务的关键点数量。参数
  • task_name (str | None): 要读取的任务。None 表示所有任务,此时所有任务必须具有相同的关键点数量。
返回
  • int: 任务的关键点数量。当 task_name 没有关键点计数时(例如不在数据集中的任务),返回 0。
引发
  • RuntimeError: 当 task_name 为 None 且任务具有不同的关键点数量时。
  • StopIteration: 当 task_name 为 None 且元数据没有关键点计数时。

属性

metadata_types
元数据标签名称映射到其值的类型。当数据集没有元数据标签时,字典为空。
task_names
类映射中所有任务的名称。具有空类映射的任务也包含在集合中。