Docs /Templates/ sinapsis-ultralytics

UltralyticsPredict

sinapsis-ultralyticsUltralyticssegmentationtensorrtclassificationinference

Python template · sinapsis_ultralytics.templates.ultralytics_predict

Overview

Template used to produce inference predictions using pre-trained or saved Ultralytics models. The template takes an input image coming from the DataContainer and stores the annotations and inference results in the ImagePacket.

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"
predict_params

PredictParams containing the parameters required to run inference using an Ultralytics model. If not specified, model predictions will be obtained using default parameters. Detailed description of available predict parameters can be found in: https://docs.ultralytics.com/modes/predict/#inference-arguments

PredictParams
Optional
Default: null
iou
float
Optional
Default: 0.7
conf
float
Optional
Default: 0.25
save
bool
Optional
Default: false
imgsz
int
Optional
Default: 640
bboxes
list[list[float]] | None
Optional
Default: null
device
str | None
Optional
Default: null
source
str | numpy.ndarray | pathlib._local.Path
Optional
Default: "ultralytics/assets"
classes
list[int] | None
Optional
Default: null
save_txt
bool
Optional
Default: false
agnostic_nms
bool
Optional
Default: false
checkpoint_path
str | pathlib._local.Path | None
Optional
Default: null
use_detections_as_sam_prompt
bool
Optional
Default: false

Configuration example

Example from the Python docstring:

yaml
agent:
  name: test_agent
templates:
- template_name: UltralyticsPredict
  class_name: UltralyticsPredict
  attributes:
    model_class: YOLO
    model: yolo11n-cls.pt
    task: classify
    verbose: 0
Show schema-based configuration skeleton
yaml
templates:
  - template_name: "UltralyticsPredict"
    class_name: "UltralyticsPredict"
    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"
      predict_params:
        iou: 0.7
        conf: 0.25
        save: false
        imgsz: 640
        bboxes: null
        device: null
        source: "ultralytics/assets"
        classes: null
        save_txt: false
        agnostic_nms: false
      checkpoint_path: null
      use_detections_as_sam_prompt: false

Inheritance

Immediate parent: sinapsis_ultralytics.templates.ultralytics_base.UltralyticsBase

Environment variables

Environment definitions belong to their canonical Python modules.

No directly related environment variables listed.