Tao Train Mask2former

Mask2Former for universal image segmentation (panoptic, instance, and semantic). Transformer-based with masked attention for high-quality segmentation results. Use when training, evaluating, exporting, quantizing, or running inference for a TAO Mask2Former model. Trigger phrases include "train Mask2Former", "universal segmentation", "panoptic / instance / semantic segmentation", "masked-attention transformer segmenter".

Published by @NVIDIA·0 agent reads / 30d·0 saves·

Mask2Former

Mask2Former for universal image segmentation (panoptic, instance, and semantic). Transformer-based with masked attention for high-quality segmentation results.

Set model.backbone.pretrained_weights for Swin backbone weights.

For TAO Deploy TensorRT actions (gen_trt_engine, TensorRT evaluate, and TensorRT inference), read references/tao-deploy-mask2former.md first. Deploy spec templates live in this skill's references/ folder with the spec_template_deploy_*.yaml prefix.

Dataclass Schemas

Generated TAO Core schemas are packaged in schemas/<action>.schema.json, with schemas/manifest.json listing available actions. Each generated schema also emits references/spec_template_<action>.yaml from the schema top-level default field. AutoML enablement is declared at the model layer in references/skill_info.yaml via automl_enabled. Runnable AutoML still requires schemas/train.schema.json and references/spec_template_train.yaml to exist and parse. Use the packaged train schema for automl_default_parameters, automl_disabled_parameters, defaults, min/max bounds, enums, option weights, math conditions, dependencies, and popular parameters. Do not expect ~/tao-core at runtime; maintainers regenerate schemas/templates before packaging the skill bank.

Train Action Policy

This model is AutoML-enabled at the model layer. Before handling any train-stage request, read references/skill_info.yaml and resolve the run override from either an explicit automl_policy value or the user's workflow request. Treat phrases like "turn off AutoML", "disable AutoML", "no HPO", or "plain training" as automl_policy: off for this run only; otherwise default to auto. When automl_policy: auto, automl_enabled: true, and both schemas/train.schema.json and references/spec_template_train.yaml are packaged, route the train action through tao-skill-bank:tao-run-automl by default with this model's skill_dir. Preserve workflow/application overrides for datasets, specs, output directories, GPU/platform settings, parent checkpoints, and automl_policy. Use direct model training only when automl_policy: off or the packaged train schema/template is missing; in the missing-schema case, report that AutoML is enabled but not runnable for this model until schemas are generated.

Non-train actions such as evaluate, inference, export, and deploy flows stay in this model skill. The per-run automl_policy override does not change model metadata.

Training Requirements

  • Dataset type: segmentation
  • Formats: coco_panoptic, coco
  • Monitoring metric: mIoU

Per-Action Dataset Requirements

ActionSpec KeySourceFilesList?
evaluatedataset.train.img_dirtrain_datasetsimages.tar.gzNo
evaluatedataset.label_maptrain_datasetscoco_panoptic: label_map_panoptic.json; *: label_map.jsonNo
evaluatedataset.train.instance_jsontrain_datasetsannotations.jsonNo
evaluatedataset.train.panoptic_jsontrain_datasetsannotations_panoptic.jsonNo
evaluatedataset.train.panoptic_dirtrain_datasetsimages_panoptic.tar.gzNo
evaluatedataset.val.img_direval_datasetimages.tar.gzNo
evaluatedataset.val.instance_jsoneval_datasetannotations.jsonNo
evaluatedataset.val.panoptic_jsoneval_datasetannotations_panoptic.jsonNo
evaluatedataset.val.panoptic_direval_datasetimages_panoptic.tar.gzNo
evaluatedataset.test.img_direval_datasetimages.tar.gzNo
inferencedataset.train.img_dirtrain_datasetsimages.tar.gzNo
inferencedataset.label_maptrain_datasetscoco_panoptic: label_map_panoptic.json; *: label_map.jsonNo
inferencedataset.train.instance_jsontrain_datasetsannotations.jsonNo
inferencedataset.train.panoptic_jsontrain_datasetsannotations_panoptic.jsonNo
inferencedataset.train.panoptic_dirtrain_datasetsimages_panoptic.tar.gzNo
inferencedataset.val.img_direval_datasetimages.tar.gzNo
inferencedataset.val.instance_jsoneval_datasetannotations.jsonNo
inferencedataset.val.panoptic_jsoneval_datasetannotations_panoptic.jsonNo
inferencedataset.val.panoptic_direval_datasetimages_panoptic.tar.gzNo
inferencedataset.test.img_direval_datasetimages.tar.gzNo
quantizedataset.train.img_dirtrain_datasetsimages.tar.gzNo
quantizedataset.label_maptrain_datasetscoco_panoptic: label_map_panoptic.json; *: label_map.jsonNo
quantizedataset.train.instance_jsontrain_datasetsannotations.jsonNo
quantizedataset.train.panoptic_jsontrain_datasetsannotations_panoptic.jsonNo
quantizedataset.train.panoptic_dirtrain_datasetsimages_panoptic.tar.gzNo
quantizedataset.val.img_direval_datasetimages.tar.gzNo
quantizedataset.val.instance_jsoneval_datasetannotations.jsonNo
quantizedataset.val.panoptic_jsoneval_datasetannotations_panoptic.jsonNo
quantizedataset.val.panoptic_direval_datasetimages_panoptic.tar.gzNo
quantizedataset.test.img_direval_datasetimages.tar.gzNo
quantizedataset.quant_calibration_dataset.images_dirtrain_datasetsimages.tar.gzNo
traindataset.train.img_dirtrain_datasetsimages.tar.gzNo
traindataset.label_maptrain_datasetscoco_panoptic: label_map_panoptic.json; *: label_map.jsonNo
traindataset.train.instance_jsontrain_datasetsannotations.jsonNo
traindataset.train.panoptic_jsontrain_datasetsannotations_panoptic.jsonNo
traindataset.train.panoptic_dirtrain_datasetsimages_panoptic.tar.gzNo
traindataset.val.img_direval_datasetimages.tar.gzNo
traindataset.val.instance_jsoneval_datasetannotations.jsonNo
traindataset.val.panoptic_jsoneval_datasetannotations_panoptic.jsonNo
traindataset.val.panoptic_direval_datasetimages_panoptic.tar.gzNo
traindataset.test.img_direval_datasetimages.tar.gzNo

Typical Spec Overrides

Data source overrides are mandatory for every action — the agent MUST construct data source paths from the Per-Action Dataset Requirements table above and include them in spec_overrides.

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

train (mandatory data sources):

{
    "train.num_gpus": 1,
    "train.num_epochs": 10,
    "train.checkpoint_interval": 10,
    "train.validation_interval": 10,
    "model.sem_seg_head.num_classes": 90,
    "dataset.contiguous_id": True,
    "dataset.train.img_dir": f"{S3_TRAIN}/images.tar.gz",
    "dataset.label_map": {"coco_panoptic": f"{S3_TRAIN}/label_map_panoptic.json; *: label_map.json"},
    "dataset.train.instance_json": f"{S3_TRAIN}/annotations.json",
    "dataset.train.panoptic_json": f"{S3_TRAIN}/annotations_panoptic.json",
    "dataset.train.panoptic_dir": f"{S3_TRAIN}/images_panoptic.tar.gz",
    "dataset.val.img_dir": f"{S3_EVAL}/images.tar.gz",
    "dataset.val.instance_json": f"{S3_EVAL}/annotations.json",
    "dataset.val.panoptic_json": f"{S3_EVAL}/annotations_panoptic.json",
    "dataset.val.panoptic_dir": f"{S3_EVAL}/images_panoptic.tar.gz",
    "dataset.test.img_dir": f"{S3_EVAL}/images.tar.gz",
}

evaluate (mandatory data sources):

{
    "model.sem_seg_head.num_classes": 90,
    "dataset.contiguous_id": True,
    "dataset.train.img_dir": f"{S3_TRAIN}/images.tar.gz",
    "dataset.label_map": {"coco_panoptic": f"{S3_TRAIN}/label_map_panoptic.json; *: label_map.json"},
    "dataset.train.instance_json": f"{S3_TRAIN}/annotations.json",
    "dataset.train.panoptic_json": f"{S3_TRAIN}/annotations_panoptic.json",
    "dataset.train.panoptic_dir": f"{S3_TRAIN}/images_panoptic.tar.gz",
    "dataset.val.img_dir": f"{S3_EVAL}/images.tar.gz",
    "dataset.val.instance_json": f"{S3_EVAL}/annotations.json",
    "dataset.val.panoptic_json": f"{S3_EVAL}/annotations_panoptic.json",
    "dataset.val.panoptic_dir": f"{S3_EVAL}/images_panoptic.tar.gz",
    "dataset.test.img_dir": f"{S3_EVAL}/images.tar.gz",
}

export:

{
    "model.sem_seg_head.num_classes": 90,
}

inference (mandatory data sources):

{
    "model.sem_seg_head.num_classes": 90,
    "dataset.contiguous_id": True,
    "dataset.train.img_dir": f"{S3_TRAIN}/images.tar.gz",
    "dataset.label_map": {"coco_panoptic": f"{S3_TRAIN}/label_map_panoptic.json; *: label_map.json"},
    "dataset.train.instance_json": f"{S3_TRAIN}/annotations.json",
    "dataset.train.panoptic_json": f"{S3_TRAIN}/annotations_panoptic.json",
    "dataset.train.panoptic_dir": f"{S3_TRAIN}/images_panoptic.tar.gz",
    "dataset.val.img_dir": f"{S3_EVAL}/images.tar.gz",
    "dataset.val.instance_json": f"{S3_EVAL}/annotations.json",
    "dataset.val.panoptic_json": f"{S3_EVAL}/annotations_panoptic.json",
    "dataset.val.panoptic_dir": f"{S3_EVAL}/images_panoptic.tar.gz",
    "dataset.test.img_dir": f"{S3_EVAL}/images.tar.gz",
}

quantize (mandatory data sources):

{
    "dataset.train.img_dir": f"{S3_TRAIN}/images.tar.gz",
    "dataset.label_map": {"coco_panoptic": f"{S3_TRAIN}/label_map_panoptic.json; *: label_map.json"},
    "dataset.train.instance_json": f"{S3_TRAIN}/annotations.json",
    "dataset.train.panoptic_json": f"{S3_TRAIN}/annotations_panoptic.json",
    "dataset.train.panoptic_dir": f"{S3_TRAIN}/images_panoptic.tar.gz",
    "dataset.val.img_dir": f"{S3_EVAL}/images.tar.gz",
    "dataset.val.instance_json": f"{S3_EVAL}/annotations.json",
    "dataset.val.panoptic_json": f"{S3_EVAL}/annotations_panoptic.json",
    "dataset.val.panoptic_dir": f"{S3_EVAL}/images_panoptic.tar.gz",
    "dataset.test.img_dir": f"{S3_EVAL}/images.tar.gz",
    "dataset.quant_calibration_dataset.images_dir": f"{S3_TRAIN}/images.tar.gz",
}

Eval Dataset

Optional. Val data sources are part of the dataset config alongside train.

Important Parameters

  • model.sem_seg_head.num_classes: Number of segmentation classes. Default 200. Must match your annotation categories.
  • model.backbone.swin.type: Swin Transformer variant. Default tiny. Options include tiny, small, base, large.
  • model.mode: Segmentation mode. Default panoptic. Options: panoptic, instance, semantic.
  • train.optim.lr: Learning rate. Default 2e-4 (AdamW).
  • dataset.train.batch_size: Per-GPU batch size. Default 1. Mask2Former is memory-intensive due to per-pixel predictions.

Multi-GPU / Multi-Node

Launch method: Lightning-managed (single python process, Lightning spawns workers).

Spec KeyDescriptionDefault
train.num_gpusNumber of GPUs1
train.gpu_idsGPU device indices[0]
train.num_nodesNumber of nodes1
train.distributed_strategyddp or fsdpddp
  • Same DDP/FSDP behavior as DINO (activation checkpoint aware)
  • FAN backbones auto-enable sync_batchnorm
  • fsdp forces FP16

Multi-node env vars (set by orchestrator): WORLD_SIZE, NODE_RANK, MASTER_ADDR, MASTER_PORT, NUM_GPU_PER_NODE.

Export / TRT Defaults

  • TRT data types: FP32, FP16 only — INT8 is NOT supported

Full TAO Deploy reference: tao-deploy-mask2former.

Hardware

Minimum 1 GPU(s), recommended 4 GPU(s). 24GB+ (A100 recommended) VRAM per GPU. Mask2Former is memory-heavy. batch_size=1 is the default for good reason. Multi-GPU recommended for reasonable training speed.

Error Patterns

CUDA out of memory: batch_size is already 1 by default. Reduce image resolution in augmentation config or use a smaller Swin variant.

Panoptic vs instance format mismatch: Ensure you provide the correct annotation format matching model.mode setting.

Spec Param / Parent Model Inference

Model-specific inference mappings belong in this MD file, not in config.json. Generated runners should read this section and apply the mappings with SDK helpers before create_job(). This mirrors the old microservices infer_params.py flow.

Inference mappings from TAO Core mask2former.config.json:

ActionSpec FieldInference FunctionMeaning
evaluateencryption_keykeyencryption key
evaluateevaluate.checkpointparent_modelmodel file inferred from the parent job results folder
evaluateevaluate.trt_engineparent_modelmodel file inferred from the parent job results folder
evaluateresults_diroutput_dircurrent job results directory
exportencryption_keykeyencryption key
exportexport.checkpointparent_modelmodel file inferred from the parent job results folder
exportexport.onnx_filecreate_onnx_fileoutput ONNX path
exportresults_diroutput_dircurrent job results directory
gen_trt_engineencryption_keykeyencryption key
gen_trt_enginegen_trt_engine.onnx_fileparent_modelmodel file inferred from the parent job results folder
gen_trt_enginegen_trt_engine.trt_enginecreate_engine_fileoutput TensorRT engine path
gen_trt_engineresults_diroutput_dircurrent job results directory
inferenceencryption_keykeyencryption key
inferenceinference.checkpointparent_modelmodel file inferred from the parent job results folder
inferenceinference.trt_engineparent_modelmodel file inferred from the parent job results folder
inferenceresults_diroutput_dircurrent job results directory
quantizeencryption_keykeyencryption key
quantizequantize.model_pathparent_modelmodel file inferred from the parent job results folder
quantizeresults_diroutput_dircurrent job results directory
trainencryption_keykeyencryption key
trainmodel.backbone.pretrained_weights{'link': 'https://github.com/SwinTransformer/storage/releases/download/v1.0.8/swin_tiny_patch4_window7_224_22k.pth', 'destination_path': '/ptm/mask2former/swin_tiny_patch4_window7_224_22k/swin_tiny_patch4_window7_224_22k.pth'}{'link': 'https://github.com/SwinTransformer/storage/releases/download/v1.0.8/swin_tiny_patch4_window7_224_22k.pth', 'destination_path': '/ptm/mask2former/swin_tiny_patch4_window7_224_22k/swin_tiny_patch4_window7_224_22k.pth'}
trainresults_diroutput_dircurrent job results directory
traintrain.resume_training_checkpoint_pathresume_modelmodel file inferred from the current job results folder

For parent_model or parent_model_folder, pass the upstream train/export/AutoML child job id as parent_job_id. The SDK lists the parent result folder, filters checkpoint artifacts, and returns the selected model file or folder. Do not add these mappings back to config.json and do not patch generated runner scripts to guess checkpoint paths.

Bundled with this artifact

23 files

Reference files that ship alongside this artifact. Agents pull these in only when the task needs them.

More on the bench

SKILL0

Tensorflow And Deep Learning Rules

TensorFlow and deep learning rules for building, training, evaluating, and deploying neural network models

data-science-ml+1
0
SKILL0

Fortran Programming Guidelines

Modern Fortran rules for scientific computing, modules, explicit interfaces, kind parameters, memory safety, and testing

software-engineering+1
0
SKILL0

Automl And Hyperparameter Optimization Rules

AutoML and hyperparameter optimization rules for Python ML projects using Ray Tune, Optuna, PyCaret, and time-series AutoML libraries

data-science-ml+1
0