predefined
最后更新
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
函数
class_family
Python
1def class_family(model: str) -> str | None:model.predefined_model.name。示例
Pycon
1>>> class_family("keypoint_bbox")
2'KeypointDetectionModel'
3>>> print(class_family("unknown"))
4Nonemodel(str): 模型名称,不带版本后缀。
str | None:model.predefined_model.name的值。当model不是打包模型时为None。当函数无法读取文件、文件不是有效的 YAML 或文件没有此类键时也为None。
configs_dir
Python
1def configs_dir() -> Path:示例
Pycon
1>>> configs_dir().name
2'configs'Path: luxonis_train.configs 包的目录。
default_config_path
Python
1def default_config_path(model: str) -> Path:model 提供的第一个变体。示例
Pycon
1>>> default_config_path("detection").name
2'detection_light_model.yaml'model(str): 模型名称,不带版本后缀。
Path: 打包的 YAML 文件的路径。
KeyError: 当model不是打包模型时。
list_predefined_models
Python
1def list_predefined_models() -> dict[str, list[str | None]]:_model.yaml 结尾的文件名。它跳过 complex_model.yaml 和其他示例文件。以 _<variant>_model.yaml 结尾的名称(其中 variant 在 VARIANT_ORDER 中)给出模型和该变体。任何其他名称 <model>_model.yaml 给出模型和变体 None。该列表不包含仅由模型类声明的变体。list_variants 会添加它们。示例
Pycon
1>>> models = list_predefined_models()
2>>> models["detection"], models["embeddings"]
3(['light', 'heavy'], [None])dict[str, list[str | None]]: 每个模型名称映射到其变体,按 VARIANT_ORDER 的顺序。第一个变体是默认变体。模型按字母顺序排列。
list_variants
Python
1def list_variants(model: str) -> list[str | None]:get_variants 声明的变体。模型类来自 class_family,采用其最新注册版本。该函数导入预定义模型以查找它。当函数无法解析该类,或者该类没有变体时,该列表仅包含具有文件的变体。示例
Pycon
1>>> list_variants("detection")
2['light', 'medium', 'heavy']
3>>> list_variants("anomaly_detection")
4['light', 'heavy', None]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。示例
Pycon
1>>> parse_model_spec("detection:v2")
2('detection', '2')
3>>> parse_model_spec("detection")
4('detection', None)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,因此它替换了文件设置的变体。示例
Pycon
1>>> path, opts = resolve_predefined_config("detection:v1", "medium")
2>>> path.name
3'detection_light_model.yaml'
4>>> opts
5['model.predefined_model.version', '1',
6 'model.predefined_model.variant', 'medium']model(str): 模型名称,带有可选版本后缀,如 parse_model_spec 中所示。variant(str | None): 变体。None选择默认配置文件,不添加变体覆盖。
ResolvedPredefinedConfig: 文件的路径和覆盖。
ValueError: 当版本后缀格式错误,当model不是打包模型,或者当variant不在 list_variants 中时。