npx skills add nvidia/skills --skill tao-train-oneformer
promptingcompany/nv-skills
tao-train-oneformer
OneFormer for universal image segmentation. Unifies panoptic, instance, and semantic segmentation with a single architecture using task-conditioned queries. Use when training, evaluating, exporting, quantizing, or running inference for a TAO OneFormer model. Trigger phrases include "train OneFormer", "universal segmentation", "task-conditioned segmentation", "panoptic / instance / semantic in one model".
Installation
npx skills add promptingcompany/nv-skills --skill tao-train-oneformer
Similar popular skills
Related neighbors and high-traction skills in the same topics — useful to compare before installing.
Also in this package
Other skills from promptingcompany/nv-skills · top by installs.
npx skills add promptingcompany/nv-skills
More details
Agent compatibility
Declared targets from SKILL.md / docs. Unmarked agents are not listed — the skill may still install via the CLI.
Also listed on
Alternate registries and mirrors of this skill.
Repository health
main
Skill metadata
Parsed from SKILL.md frontmatter.
Read BashMore metadata
- version
- 0.1.0
- author
- NVIDIA Corporation
Package contents
Files included with this skill beyond the listing page.
-
skill md
SKILL.md19,633 B -
docs
SUMMARY.md434 B
History
- First seen on skills.sh
- First recorded snapshot · 39 installs
SKILL.md
OneFormer
OneFormer for universal image segmentation. Unifies panoptic, instance, and semantic segmentation with a single architecture using task-conditioned queries.
Set train.pretrainedbackbone and/or train.pretrainedmodel.
For TAO Deploy TensorRT actions (gentrtengine, TensorRT evaluate, and TensorRT inference), read references/tao-deploy-oneformer.md first. Deploy spec templates live in this skill's references/ folder with the spectemplatedeploy_*.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/spectemplate<action>.yaml from the schema top-level default field. AutoML enablement is declared at the model layer in references/skillinfo.yaml via automlenabled. Runnable AutoML still requires schemas/train.schema.json and references/spectemplatetrain.yaml to exist and parse. Use the packaged train schema for automldefaultparameters, automldisabledparameters, 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/skillinfo.yaml and resolve the run override from either an explicit automlpolicy value or the user's workflow request. Use automlpolicy: on by default and only expose on / off in new launch prompts. Treat phrases like "turn off AutoML", "disable AutoML", "no HPO", or "plain training" as automlpolicy: off for this run only. When automlpolicy: on, automlenabled: true, and both schemas/train.schema.json and references/spectemplatetrain.yaml are packaged, route the train action through tao-skill-bank:tao-run-automl by default with this model's skilldir. Preserve workflow/application overrides for datasets, specs, output directories, GPU/platform settings, parent checkpoints, and automlpolicy. 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
| Action | Spec Key | Source | Files | List? |
|---|---|---|---|---|
| evaluate | dataset.train.images | train_datasets | images.tar.gz | No |
| evaluate | dataset.label_map | train_datasets | label_map.json | No |
| evaluate | dataset.train.annotations | train_datasets | annotations.json | No |
| evaluate | dataset.train.panoptic | train_datasets | images_panoptic.tar.gz | No |
| evaluate | dataset.val.images | eval_dataset | images.tar.gz | No |
| evaluate | dataset.val.annotations | eval_dataset | annotations.json | No |
| evaluate | dataset.val.panoptic | eval_dataset | images_panoptic.tar.gz | No |
| evaluate | dataset.test.images | eval_dataset | images.tar.gz | No |
| evaluate | dataset.test.annotations | eval_dataset | annotations.json | No |
| evaluate | dataset.test.panoptic | eval_dataset | images_panoptic.tar.gz | No |
| inference | dataset.train.images | train_datasets | images.tar.gz | No |
| inference | dataset.label_map | train_datasets | label_map.json | No |
| inference | dataset.train.annotations | train_datasets | annotations.json | No |
| inference | dataset.train.panoptic | train_datasets | images_panoptic.tar.gz | No |
| inference | dataset.val.images | eval_dataset | images.tar.gz | No |
| inference | dataset.val.annotations | eval_dataset | annotations.json | No |
| inference | dataset.val.panoptic | eval_dataset | images_panoptic.tar.gz | No |
| inference | dataset.test.images | inference_dataset | images.tar.gz | No |
| quantize | dataset.train.images | train_datasets | images.tar.gz | No |
| quantize | dataset.train.annotations | train_datasets | annotations.json | No |
| quantize | dataset.label_map | train_datasets | label_map.json | No |
| quantize | dataset.train.panoptic | train_datasets | images_panoptic.tar.gz | No |
| quantize | dataset.val.images | eval_dataset | images.tar.gz | No |
| quantize | dataset.val.annotations | eval_dataset | annotations.json | No |
| quantize | dataset.val.panoptic | eval_dataset | images_panoptic.tar.gz | No |
| quantize | dataset.test.images | eval_dataset | images.tar.gz | No |
| quantize | dataset.quantcalibrationdataset.images_dir | calibration_dataset | images.tar.gz | No |
| train | dataset.train.images | train_datasets | images.tar.gz | No |
| train | dataset.train.annotations | train_datasets | annotations.json | No |
| train | dataset.label_map | train_datasets | label_map.json | No |
| train | dataset.train.panoptic | train_datasets | images_panoptic.tar.gz | No |
| train | dataset.val.images | eval_dataset | images.tar.gz | No |
| train | dataset.val.annotations | eval_dataset | annotations.json | No |
| train | dataset.val.panoptic | eval_dataset | images_panoptic.tar.gz | No |
| train | dataset.test.images | eval_dataset | images.tar.gz | No |
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"
S3_INFERENCE = "s3://bucket/data/inference"
S3_CALIBRATION = "s3://bucket/data/calibration"
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": 133,
"dataset.contiguous_id": True,
"train.precision": "32",
"dataset.train.images": f"{S3_TRAIN}/images.tar.gz",
"dataset.train.annotations": f"{S3_TRAIN}/annotations.json",
"dataset.label_map": f"{S3_TRAIN}/label_map.json",
"dataset.train.panoptic": f"{S3_TRAIN}/images_panoptic.tar.gz",
"dataset.val.images": f"{S3_EVAL}/images.tar.gz",
"dataset.val.annotations": f"{S3_EVAL}/annotations.json",
"dataset.val.panoptic": f"{S3_EVAL}/images_panoptic.tar.gz",
"dataset.test.images": f"{S3_EVAL}/images.tar.gz",
}
evaluate (mandatory data sources):
{
"evaluate.checkpoint": "<selected train/AutoML checkpoint>",
"model.sem_seg_head.num_classes": 133,
"dataset.contiguous_id": True,
"dataset.train.images": f"{S3_TRAIN}/images.tar.gz",
"dataset.label_map": f"{S3_TRAIN}/label_map.json",
"dataset.train.annotations": f"{S3_TRAIN}/annotations.json",
"dataset.train.panoptic": f"{S3_TRAIN}/images_panoptic.tar.gz",
"dataset.val.images": f"{S3_EVAL}/images.tar.gz",
"dataset.val.annotations": f"{S3_EVAL}/annotations.json",
"dataset.val.panoptic": f"{S3_EVAL}/images_panoptic.tar.gz",
"dataset.test.images": f"{S3_EVAL}/images.tar.gz",
"dataset.test.annotations": f"{S3_EVAL}/annotations.json",
"dataset.test.panoptic": f"{S3_EVAL}/images_panoptic.tar.gz",
}
export:
{
"export.checkpoint": "<selected train/AutoML checkpoint>",
"model.sem_seg_head.num_classes": 133,
"model.export": True,
"export.onnx_file": "/results/oneformer_export_640.onnx",
}
inference (mandatory data sources):
{
"inference.checkpoint": "<selected train/AutoML checkpoint>",
"dataset.train.images": f"{S3_TRAIN}/images.tar.gz",
"dataset.label_map": f"{S3_TRAIN}/label_map.json",
"dataset.train.annotations": f"{S3_TRAIN}/annotations.json",
"dataset.train.panoptic": f"{S3_TRAIN}/images_panoptic.tar.gz",
"dataset.val.images": f"{S3_EVAL}/images.tar.gz",
"dataset.val.annotations": f"{S3_EVAL}/annotations.json",
"dataset.val.panoptic": f"{S3_EVAL}/images_panoptic.tar.gz",
"dataset.test.images": f"{S3_INFERENCE}/images.tar.gz",
"inference.images_dir": f"{S3_INFERENCE}/images.tar.gz",
}
quantize (mandatory data sources):
{
"quantize.model_path": "<selected train/AutoML checkpoint>",
"dataset.train.images": f"{S3_TRAIN}/images.tar.gz",
"dataset.train.annotations": f"{S3_TRAIN}/annotations.json",
"dataset.label_map": f"{S3_TRAIN}/label_map.json",
"dataset.train.panoptic": f"{S3_TRAIN}/images_panoptic.tar.gz",
"dataset.val.images": f"{S3_EVAL}/images.tar.gz",
"dataset.val.annotations": f"{S3_EVAL}/annotations.json",
"dataset.val.panoptic": f"{S3_EVAL}/images_panoptic.tar.gz",
"dataset.test.images": f"{S3_EVAL}/images.tar.gz",
"dataset.quant_calibration_dataset.images_dir": f"{S3_CALIBRATION}/images.tar.gz",
}
Checkpoint Selection
OneFormer training writes epoch-step checkpoints such as modelepoch000step00017.pth and may also write a oneformermodellatest.pth symlink. For checkpoint-dependent actions, use the model-skill or SDK parent-model resolver and pass the exact selected checkpoint path into evaluate.checkpoint, inference.checkpoint, export.checkpoint, quantize.modelpath, or train.resumetrainingcheckpointpath. Do not pick the oneformermodellatest.pth symlink by name unless the user explicitly asks for latest checkpoint behavior. If the resolver reports a best checkpoint, use that best checkpoint for evaluation/export/inference; if the user asks for a specific epoch or step, use the matching epoch-step checkpoint.
Eval Dataset
Optional. Val data configured alongside train in the dataset config.
Important Parameters
- model.semseghead.numclasses: Number of segmentation class indices available to the head. Default 133 for COCO panoptic data when
dataset.contiguousid: Trueremaps raw category ids through the label map. Do not shrink this to a global workflow class count unless the label map and annotations have actually been reduced to that class set. - model.oneformer.hiddendim: Keep at 256 for local smoke runs unless
the text encoder width is changed in lock-step. Reducing hidden_dim alone causes a text feature/context dimension mismatch during training.
- model.backbone.name: Default D2SwinTransformer (Swin-based). embed_dim=192, depths=[2,2,18,2] by default.
- train.num_epochs: Default 50 — significantly higher than most TAO models. OneFormer needs more epochs for convergence.
- train.optim.lr: Learning rate. Default 1e-5. Lower than Mask2Former's 2e-4.
- model.tasktoggling: Enable/disable specific tasks: semanticon, instanceon, panopticon.
- export.task: Export task mode. Options: semantic, instance, panoptic. Default semantic. Export input defaults to 640x640.
- inference.mode: Inference mode. Options: semantic, instance, panoptic. Default semantic. image_size defaults to [1024, 1024].
- evaluate.iouperclass: Report per-class IoU in evaluation. Default True.
Multi-GPU / Multi-Node
Launch method: Lightning-managed (single python process, Lightning spawns workers).
| Spec Key | Description | Default |
|---|---|---|
train.num_gpus |
Number of GPUs | 1 |
train.gpu_ids |
GPU device indices | [0] |
train.num_nodes |
Number of nodes | 1 |
- Uses explicit
DDPStrategywithfindunusedparameters=True,gradientasbucketview=True,processgroup_backend="nccl" sync_batchnormis always enabled- No fsdp support — DDP only
Multi-node env vars (set by orchestrator): WORLDSIZE, NODERANK, MASTERADDR, MASTERPORT, NUMGPUPER_NODE.
Hardware
Minimum 2 GPU(s), recommended 4 GPU(s). 24GB+ (A100 recommended) VRAM per GPU. OneFormer is memory-intensive like Mask2Former. batch_size=1 is the default. Multi-GPU needed for reasonable training speed, especially with 50 epochs.
Error Patterns
CUDA out of memory: batch_size is already 1. Reduce image resolution or use a smaller Swin configuration.
Extracted S3 tarball points one level too high: For local Docker runs, images.tar.gz and imagespanoptic.tar.gz may extract wrapper directories such as images/ and imagespanoptic/. Set dataset..images, dataset..panoptic, inference.images_dir, and quantization calibration paths to the actual folder containing image or panoptic files, not the wrapper directory. A one-level-too-high path fails with FileNotFoundError for the first annotation image even though recursive file counts look correct.
defaultspecs missing resultsdir: The CLI defaultspecs subtask ignores -e experiment specs for resultsdir; pass a Hydra-style override instead: oneformer defaultspecs resultsdir=/path/to/default_specs.
Invalid Lightning precision fp32: Use train.precision: "32" in train/AutoML/evaluate/inference specs. The current Lightning stack rejects the legacy fp32 string.
PyTorch 2.6 checkpoint load failure on downstream actions: Current OneFormer checkpoints include OmegaConf objects. For checkpoints produced by the same trusted TAO train/AutoML workflow, set TORCHFORCENOWEIGHTSONLY_LOAD=1 in downstream evaluate, inference, export, quantize, or resume job env vars so Lightning can load the full checkpoint. Do not use this env var for untrusted checkpoints.
CUDA device-side assert in matcher/class cost: If training fails in oneformer/utils/matcher.py while indexing outprob[:, tgtids], compare the effective target ids with model.semseghead.numclasses. The packaged COCO panoptic sample has 133 compact classes after dataset.contiguousid: True remapping, so use model.semseghead.numclasses: 133 even when a broader validation workflow passes a smaller generic numclasses value. Only use a smaller class count when the label map and annotations are reduced to that exact contiguous class set.
Inference returns PASS with no predictions: OneFormer prediction reads inference.imagesdir, not dataset.test.images. Declare and populate inference.imagesdir with the image folder or tarball for every inference run. dataset.test.images may still be useful for shared dataset context, but it does not drive the PyTorch predict dataloader.
Export output path pre-created as a directory: Do not declare export.onnxfile as a file output. The OneFormer exporter asserts that the ONNX path does not already exist, while the local runner pre-creates declared output paths. Set export.onnxfile explicitly in the spec to a non-existing file path under the mounted results tree. Keep the default 640x640 export shape for smoke validation; very small export shapes can trigger PyTorch ONNX shape-inference failures.
Quantize cannot find the training label map from an AutoML checkpoint: OneFormer Lightning checkpoints retain train-time absolute dataset paths in their saved hparams. When running downstream actions from an AutoML child checkpoint, keep the parent AutoML job directory accessible at its original /results/<jobid> path inside the action container in addition to passing the resolved checkpoint path. Otherwise quantize can fail while loading checkpoint hparams even when the current spec includes a valid dataset.labelmap.
Slow training: 50 default epochs with batch_size=1 is slow on single GPU. Use multi-GPU distributed training.
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 createjob(). This mirrors the old microservices inferparams.py flow.
Inference mappings from TAO Core oneformer.config.json:
| Action | Spec Field | Inference Function | Meaning |
|---|---|---|---|
| evaluate | encryption_key |
key |
encryption key |
| evaluate | evaluate.checkpoint |
parent_model |
model file inferred from the parent job results folder |
| evaluate | evaluate.trt_engine |
parent_model |
model file inferred from the parent job results folder |
| evaluate | results_dir |
output_dir |
current job results directory |
| export | encryption_key |
key |
encryption key |
| export | export.checkpoint |
parent_model |
model file inferred from the parent job results folder |
| export | export.onnx_file |
createonnxfile |
output ONNX path |
| export | results_dir |
output_dir |
current job results directory |
| gentrtengine | encryption_key |
key |
encryption key |
| gentrtengine | gentrtengine.onnx_file |
parent_model |
model file inferred from the parent job results folder |
| gentrtengine | gentrtengine.trt_engine |
createenginefile |
output TensorRT engine path |
| gentrtengine | results_dir |
output_dir |
current job results directory |
| inference | encryption_key |
key |
encryption key |
| inference | inference.checkpoint |
parent_model |
model file inferred from the parent job results folder |
| inference | inference.trt_engine |
parent_model |
model file inferred from the parent job results folder |
| inference | results_dir |
output_dir |
current job results directory |
| quantize | encryption_key |
key |
encryption key |
| quantize | quantize.model_path |
parent_model |
model file inferred from the parent job results folder |
| quantize | results_dir |
output_dir |
current job results directory |
| train | encryption_key |
key |
encryption key |
| train | results_dir |
output_dir |
current job results directory |
| train | train.pretrained_backbone |
{'link': 'https://github.com/SwinTransformer/storage/releases/download/v1.0.8/swintinypatch4window722422k.pth', 'destinationpath': '/ptm/mask2former/swintinypatch4window722422k/swintinypatch4window722422k.pth'} |
{'link': 'https://github.com/SwinTransformer/storage/releases/download/v1.0.8/swintinypatch4window722422k.pth', 'destinationpath': '/ptm/mask2former/swintinypatch4window722422k/swintinypatch4window722422k.pth'} |
| train | train.pretrained_model |
ptmifnoresumemodel |
PTM when no resume checkpoint exists |
| train | train.resumetrainingcheckpoint_path |
resume_model |
model file inferred from the current job results folder |
For parentmodel or parentmodelfolder, pass the upstream train/export/AutoML child job id as parentjob_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.
Deployment
- [tao-deploy-oneformer](references/tao-deploy-oneformer.md)