Docs /Templates/ sinapsis-ultralytics

UltralyticsExport

sinapsis-ultralyticsUltralyticssegmentationtensorrtclassificationinference

Python template · sinapsis_ultralytics.templates.ultralytics_export

Overview

Template to export ultralytics models to different formats such as ONNX, TensorFlow, TensorRT, etc. The exported model is saved in the working directory.

More info can be found at https://docs.ultralytics.com/modes/export/#usage-examples

Capabilities

Capabilities: not set

Installation

Install the published package using pip or uv.

Terminalbash
pip install sinapsis-ultralytics==1.0.0
uv pip install sinapsis-ultralytics==1.0.0
uv add sinapsis-ultralytics==1.0.0

Configuration

Effective fields from the inspector schema, including nested Pydantic model fields.

task
typing.Optional[typing.Literal['classify', 'detect', 'segment', 'pose', 'obb']]
Optional
Default: null
modelRequired
str | pathlib._local.Path
Required
Default: null
verbose
bool
Optional
Default: false
metadata
sinapsis_core.template_base.base_models.TemplateMetadata | None
Optional
Default: null
runs_dir
str | pathlib._local.Path
Optional
Default: "/sinapsis-hub/private/platform/sinapsis-hub/playground/ultralytics/runs"
model_classRequired
typing.Literal['YOLO', 'YOLOWorld', 'SAM', 'FastSAM', 'NAS', 'RTDETR']
Required
Default: null
working_dir
str | pathlib._local.Path
Optional
Default: "/sinapsis-hub/private/platform/sinapsis-hub/playground/ultralytics"
datasets_dir
str | pathlib._local.Path
Optional
Default: "/sinapsis-hub/private/platform/sinapsis-hub/playground/ultralytics/datasets"
export_params

ExportParams containing the parameters required to export an Ultralytics model to a desired format. If not specified, model will be exported using default parameters. Detailed description of available export parameters can be found in: https://docs.ultralytics.com/modes/export/#arguments

ExportParams
Optional
Default: null
half
bool
Optional
Default: false
int8
bool
Optional
Default: false
batch
int
Optional
Default: 1
imgsz
int
Optional
Default: 640
opset
int | None
Optional
Default: null
device
str | None
Optional
Default: null
format
str
Optional
Default: "torchscript"
dynamic
bool
Optional
Default: false
simplify
bool
Optional
Default: false
checkpoint_path
str | pathlib._local.Path | None
Optional
Default: null

Configuration example

Example from the Python docstring:

yaml
agent:
  name: my_test_agent
templates:
- template_name: InputTemplate
  class_name: InputTemplate
  attributes: {}
- template_name: UltralyticsExport
  class_name: UltralyticsExport
  template_input: InputTemplate
  attributes:
    model_class: 'YOLO'
    model: yolo11n-cls.pt
    task: detect
    verbose: true
    working_dir: /path/to/cache/dir
    datasets_dir: /path/to/ultralytics/dataset/dir
    run_id: null
    checkpoint_name: last.pt
    checkpoint_path: null
    export_params:
        format : onnx
        optimize : True
Show schema-based configuration skeleton
yaml
templates:
  - template_name: "UltralyticsExport"
    class_name: "UltralyticsExport"
    attributes:
      task: null
      model: "<required>"
      verbose: false
      runs_dir: "/sinapsis-hub/private/platform/sinapsis-hub/playground/ultralytics/runs"
      model_class: "<required>"
      working_dir: "/sinapsis-hub/private/platform/sinapsis-hub/playground/ultralytics"
      datasets_dir: "/sinapsis-hub/private/platform/sinapsis-hub/playground/ultralytics/datasets"
      export_params:
        half: false
        int8: false
        batch: 1
        imgsz: 640
        opset: null
        device: null
        format: "torchscript"
        dynamic: false
        simplify: false
      checkpoint_path: null

Inheritance

Immediate parent: sinapsis_ultralytics.templates.ultralytics_base.UltralyticsBase

Environment variables

Environment definitions belong to their canonical Python modules.

WORKING_DIR · defined elsewhere