tao-train-metric-learning-recognition

ML Recog

用于细粒度视觉识别的度量学习识别。学习用于基于检索的匹配（例如零售商品识别）的嵌入。使用三元组／对比损失。

设置 model.pretrained_model_path 以指定预训练主干网络。

对于 TAO Deploy TensorRT 操作（gen_trt_engine、TensorRT evaluate 和 TensorRT inference），请先阅读 references/tao-deploy-metric-learning-recognition.md。部署规范模板位于此技能的 references/ 文件夹中，前缀为 spec_template_deploy_*.yaml。

Dataclass 架构

生成的 TAO Core 架构打包在 schemas/<action>.schema.json 中，schemas/manifest.json 列出了可用操作。每个生成的架构还会根据架构顶层的 default 字段生成 references/spec_template_<action>.yaml。AutoML 的启用状态通过 references/skill_info.yaml 中模型层级的 automl_enabled 声明。要运行 AutoML，仍需存在并能解析 schemas/train.schema.json 和 references/spec_template_train.yaml。使用打包的训练架构获取 automl_default_parameters、automl_disabled_parameters、默认值、最小值／最大值限制、枚举、选项权重、数学条件、依赖项和常用参数。不要假定运行时存在 ~/tao-core；维护者会在打包技能库之前重新生成架构／模板。

训练操作策略

此模型在模型层级启用了 AutoML。在处理任何训练阶段请求之前，请先阅读 references/skill_info.yaml，并根据明确的 automl_policy 值或用户的工作流请求确定本次运行的覆盖设置。将“turn off AutoML”“disable AutoML”“no HPO”或“plain training”等说法视为仅对本次运行设置 automl_policy: off；否则默认为 auto。当 automl_policy: auto、automl_enabled: true，且已打包 schemas/train.schema.json 和 references/spec_template_train.yaml 时，默认通过 tao-skill-bank:tao-run-automl 路由训练操作，并使用此模型的 skill_dir。保留工作流／应用对数据集、规范、输出目录、GPU／平台设置、父检查点和 automl_policy 的覆盖。仅当 automl_policy: off 或缺少打包的训练架构／模板时，才直接训练模型；若缺少架构，请说明此模型已启用 AutoML，但在生成架构之前无法运行 AutoML。

evaluate、inference、export 和部署流程等非训练操作仍由此模型技能处理。每次运行的 automl_policy 覆盖不会更改模型元数据。

训练要求

• 数据集类型： ml_recog
• 格式： default
• 监控指标： val Precision at Rank 1

各操作的数据集要求

操作	规范键	来源	文件	列表？
evaluate	dataset.val_dataset	train_datasets	reference: metric_learning_recognition/retail-product-checkout-dataset_classification_demo/unknown_classes/reference.tar.gz, query: metric_learning_recognition/retail-product-checkout-dataset_classification_demo/unknown_classes/test.tar.gz	否
gen_trt_engine	gen_trt_engine.tensorrt.calibration.cal_image_dir	calibration_dataset	metric_learning_recognition/retail-product-checkout-dataset_classification_demo/known_classes/test.tar.gz	是
inference	dataset.val_dataset	train_datasets	reference: metric_learning_recognition/retail-product-checkout-dataset_classification_demo/unknown_classes/reference.tar.gz, query:	否
inference	inference.input_path	train_datasets	metric_learning_recognition/retail-product-checkout-dataset_classification_demo/unknown_classes/test.tar.gz	否
train	dataset.train_dataset	train_datasets	metric_learning_recognition/retail-product-checkout-dataset_classification_demo/known_classes/train.tar.gz	否
train	dataset.val_dataset	train_datasets	reference: metric_learning_recognition/retail-product-checkout-dataset_classification_demo/known_classes/reference.tar.gz, query: metric_learning_recognition/retail-product-checkout-dataset_classification_demo/known_classes/val.tar.gz	否

常见规范覆盖项

每个操作都必须覆盖数据源——Agent 必须根据上方“各操作的数据集要求”表构建数据源路径，并将其包含在 spec_overrides 中。

S3_TRAIN = "s3://bucket/data/train"

train（必需数据源）：

{
    "train.num_epochs": 30,
    "train.checkpoint_interval": 10,
    "train.validation_interval": 10,
    "train.num_gpus": 1,
    "dataset.train_dataset": f"{S3_TRAIN}/metric_learning_recognition/retail-product-checkout-dataset_classification_demo/known_classes/train.tar.gz",
    "dataset.val_dataset": {"reference": f"{S3_TRAIN}/metric_learning_recognition/retail-product-checkout-dataset_classification_demo/known_classes/reference.tar.gz", "query": f"{S3_TRAIN}/metric_learning_recognition/retail-product-checkout-dataset_classification_demo/known_classes/val.tar.gz"},
}

gen_trt_engine（必需数据源）：

{
    "gen_trt_engine.tensorrt.data_type": "INT8",
    "gen_trt_engine.tensorrt.calibration.cal_image_dir": [f"{S3_TRAIN}/metric_learning_recognition/retail-product-checkout-dataset_classification_demo/known_classes/test.tar.gz"],
}

evaluate（必需数据源）：

{
    "dataset.val_dataset": {"reference": f"{S3_TRAIN}/metric_learning_recognition/retail-product-checkout-dataset_classification_demo/unknown_classes/reference.tar.gz", "query": f"{S3_TRAIN}/metric_learning_recognition/retail-product-checkout-dataset_classification_demo/unknown_classes/test.tar.gz"},
}

inference（必需数据源）：

{
    "dataset.val_dataset": {"reference": f"{S3_TRAIN}/metric_learning_recognition/retail-product-checkout-dataset_classification_demo/unknown_classes/reference.tar.gz"},
    "inference.input_path": f"{S3_TRAIN}/metric_learning_recognition/retail-product-checkout-dataset_classification_demo/unknown_classes/test.tar.gz",
}

评估数据集

必需。评估需要 reference 和 query 数据集来计算检索指标。

重要参数

• model.backbone：默认值为 resnet_50。可选项：resnet_50、resnet_101、fan_small、fan_base、fan_large、fan_tiny、nvdinov2_vit_large_legacy。
• model.feat_dim：嵌入维度。默认值为 256。相似度匹配的输出特征向量大小。
• train.batch_size：每个 GPU 的批次大小。默认值为 4。val_batch_size 也为 4。
• dataset.num_instance：一个批次中每个身份的实例数（P/K 采样）。默认值为 4。控制同一类别的图像同时出现的数量。
• train.optim.trunk.base_lr：主干网络（骨干网络）的学习率。默认值为 3.5e-4（Adam）。
• train.optim.embedder.base_lr：嵌入头的学习率。默认值为 3.5e-4。
• train.optim.triplet_loss_margin：三元组损失的边界值。默认值为 0.3。smooth_loss=True 为默认值。
• train.optim.miner_function_margin：困难样本挖掘的边界值。默认值为 0.1。控制样本对挖掘的难度。
• train.optim.steps：学习率衰减步数。默认值为 [40, 70]，gamma=0.1。
• dataset.train_dataset：按类别文件夹组织的训练图像路径。
• dataset.val_dataset：包含 'reference' 和 'query' 键的字典，指向用于检索评估的 ImageNet 格式目录。

多 GPU / 多节点

**启动方式：**由 Lightning 管理（单个 python 进程，由 Lightning 启动工作进程）。

规范键	描述	默认值
train.num_gpus	GPU 数量	1
train.gpu_ids	GPU 设备索引	[0]

• 策略：auto（Lightning 自动选择最佳策略）
• 无显式 num_nodes 或 distributed_strategy 配置——面向单节点

硬件

最低需要 1 个 GPU，建议使用 2 个 GPU。每个 GPU 需要 16GB 以上显存。度量学习受益于更大的批次大小，这有助于进行更好的三元组采样；除此之外，其显存需求适中。

错误模式

Reference/query 不匹配：确保 reference 和 query 数据集在评估时使用兼容的类别命名空间。

规格参数 / 父模型推断

特定于模型的推断映射应放在此 MD 文件中，而非 config.json 中。生成的运行器应读取此部分，并在调用 create_job() 前使用 SDK 辅助函数应用这些映射。这与旧版微服务的 infer_params.py 流程一致。

来自 TAO Core ml_recog.config.json 的推断映射：

操作	规格字段	推断函数	含义
evaluate	evaluate.checkpoint	parent_model	从父作业结果文件夹推断出的模型文件
evaluate	evaluate.trt_engine	parent_model	从父作业结果文件夹推断出的模型文件
evaluate	results_dir	output_dir	当前作业结果目录
export	export.checkpoint	parent_model	从父作业结果文件夹推断出的模型文件
export	export.onnx_file	create_onnx_file	输出 ONNX 路径
export	results_dir	output_dir	当前作业结果目录
gen_trt_engine	gen_trt_engine.onnx_file	parent_model	从父作业结果文件夹推断出的模型文件
gen_trt_engine	gen_trt_engine.tensorrt.calibration.cal_cache_file	create_cal_cache	校准缓存路径
gen_trt_engine	gen_trt_engine.trt_engine	create_engine_file	输出 TensorRT 引擎路径
gen_trt_engine	results_dir	output_dir	当前作业结果目录
inference	inference.checkpoint	parent_model	从父作业结果文件夹推断出的模型文件
inference	inference.trt_engine	parent_model	从父作业结果文件夹推断出的模型文件
inference	results_dir	output_dir	当前作业结果目录
train	model.pretrained_model_path	ptm_if_no_resume_model	不存在恢复检查点时使用的 PTM
train	results_dir	output_dir	当前作业结果目录
train	train.resume_training_checkpoint_path	resume_model	从当前作业结果文件夹推断出的模型文件

对于 parent_model 或 parent_model_folder，请将上游 train/export/AutoML 子作业 ID 作为 parent_job_id 传入。SDK 会列出父结果文件夹，筛选检查点制品，并返回选定的模型文件或文件夹。不要将这些映射加回 config.json，也不要修改生成的运行器脚本来猜测检查点路径。

部署

• tao-deploy-metric-learning-recognition — 使用 TAO Deploy 生成 TensorRT 引擎、进行 TensorRT 评估和 TensorRT 推理的 MLRecog 部署工作流。