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

本页目录

  • 类
  • ResolvedPredefinedConfig
  • 函数
  • class_family
  • configs_dir
  • default_config_path
  • list_predefined_models
  • list_variants
  • parse_model_spec
  • resolve_predefined_config
  • 属性
  • CONFIGS_PACKAGE
  • VARIANT_ORDER
Claude CodeCodexCursor
Luxonis 智能体工具包为你常用的编程智能体加载 Luxonis 上下文与技能,更快地基于 OAK 开发应用。
安装工具包
最后更新
Python API: luxonis_train.config.predefined查找包中预定义模型的配置文件。luxonis_train 命令的 --model 和 --variant 选项,以及 LuxonisModel 的 model 和 variant 参数,都通过 resolve_predefined_config 进行处理。luxonis_train.configs 中的打包文件 <model>_<variant>_model.yaml 或 <model>_model.yaml 定义了模型名称及其变体。

类

ResolvedPredefinedConfig

打包的配置文件及其附带的覆盖。

属性

opts
配置覆盖,以交替的键和值表示,例如 model.predefined_model.variant 后跟 medium。当文件不需要覆盖时,此列表为空。
path
打包的 YAML 文件的路径。

函数

class_family

Python
1def class_family(model: str) -> str | None:
返回模型默认配置文件中的类名。该函数从 default_config_path 的文件中读取 model.predefined_model.name。参数
  • model (str): 模型名称,不带版本后缀。
返回
  • str | None: model.predefined_model.name 的值。当 model 不是打包模型时为 None。当函数无法读取文件、文件不是有效的 YAML 或文件没有此类键时也为 None。

configs_dir

Python
1def configs_dir() -> Path:
返回打包配置文件所在的目录。返回

default_config_path

Python
1def default_config_path(model: str) -> Path:
返回模型默认变体的配置文件。默认变体是 list_predefined_models 为 model 提供的第一个变体。参数
  • model (str): 模型名称,不带版本后缀。
返回
  • Path: 打包的 YAML 文件的路径。
引发
  • KeyError: 当 model 不是打包模型时。

list_predefined_models

Python
1def list_predefined_models() -> dict[str, list[str | None]]:
列出打包的模型和具有文件的变体。该函数读取 configs_dir 中以 _model.yaml 结尾的文件名。它跳过 complex_model.yaml 和其他示例文件。以 _<variant>_model.yaml 结尾的名称(其中 variant 在 VARIANT_ORDER 中)给出模型和该变体。任何其他名称 <model>_model.yaml 给出模型和变体 None。该列表不包含仅由模型类声明的变体。list_variants 会添加它们。返回
  • dict[str, list[str | None]]: 每个模型名称映射到其变体,按 VARIANT_ORDER 的顺序。第一个变体是默认变体。模型按字母顺序排列。

list_variants

Python
1def list_variants(model: str) -> list[str | None]:
列出打包模型接受的每个变体。该列表包含 list_predefined_models 的变体,以及模型类的 get_variants 声明的变体。模型类来自 class_family,采用其最新注册版本。该函数导入预定义模型以查找它。当函数无法解析该类,或者该类没有变体时,该列表仅包含具有文件的变体。参数
  • model (str): 模型名称,不带版本后缀。
返回
  • list[str | None]: 变体按 VARIANT_ORDER 的顺序排列。None 表示没有变体名称的文件。当 model 不是打包模型时,列表为空。

parse_model_spec

Python
1def parse_model_spec(model: str) -> tuple[str, str | None]:
将模型名称与其可选版本后缀分开。后缀跟在 : 后面。它是带有 ASCII 数字的 v,或者是 latest。参数
  • model (str): 模型名称,格式为 "<name>", "<name>:v<N>" 或 "<name>:latest"。
返回
  • tuple[str, str | None]: 名称和版本。版本是 v 后面的数字、"latest",或者当 model 没有 : 时为 None。
引发
  • ValueError: 当 : 后面的文本既不是带有数字的 v 也不是 latest 时。

resolve_predefined_config

Python
1def resolve_predefined_config(model: str, variant: str | None) -> ResolvedPredefinedConfig:
查找模型和变体的配置文件和覆盖。该函数按以下方式选择文件和覆盖:
  • 除了 latest 之外的版本成为覆盖 model.predefined_model.version。
  • 没有 variant 时,文件是模型的默认配置文件,如 default_config_path 中所示。
  • 具有自己文件的变体选择该文件。
  • 仅由模型类声明的变体选择默认配置文件。
在后两种情况下,variant 也成为覆盖 model.predefined_model.variant,因此它替换了文件设置的变体。参数
  • model (str): 模型名称,带有可选版本后缀,如 parse_model_spec 中所示。
  • variant (str | None): 变体。None 选择默认配置文件,不添加变体覆盖。
返回
  • ResolvedPredefinedConfig: 文件的路径和覆盖。
引发
  • ValueError: 当版本后缀格式错误,当 model 不是打包模型,或者当 variant 不在 list_variants 中时。

属性

CONFIGS_PACKAGE

VARIANT_ORDER