Docs /Templates/ sinapsis-ultralytics

UltralyticsVal

sinapsis-ultralyticsUltralyticssegmentationtensorrtclassificationinference

Python template · sinapsis_ultralytics.templates.ultralytics_val

Overview

Template to perform ultralytics model validation. The template exports the metrics for the loaded model and stores them in the DataContainer.

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"
checkpoint_path
str | pathlib._local.Path | None
Optional
Default: null
validation_params

ValidationParams containing the validation parameters for the Ultralytics model. If not specified, default parameters will be used. The full documentation for available validation parameters can be found in the Ultralytics docs: https://docs.ultralytics.com/modes/val/#arguments-for-yolo-model-validation

ValidationParams
Optional
Default: null
iou
float
Optional
Default: 0.7
conf
float
Optional
Default: 0.001
data
str | None
Optional
Default: null
batch
int
Optional
Default: 16
imgsz
int
Optional
Default: 640
plots
bool
Optional
Default: false
split
str
Optional
Default: "val"
device
str | None
Optional
Default: null
save_json
bool
Optional
Default: false

Configuration example

Example from the Python docstring:

yaml
agent:
  name: ultralytics_val
templates:
- template_name: UltralyticsVal
  class_name: UltralyticsVal
  template_input: null
  attributes:
    model_class: YOLO
    model: yolo11n-cls.pt
    task: detect
    verbose: 0
    validation_params:
      data: "caltech101"
      imgsz: 128
      batch: 16
Show schema-based configuration skeleton
yaml
templates:
  - template_name: "UltralyticsVal"
    class_name: "UltralyticsVal"
    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"
      checkpoint_path: null
      validation_params:
        iou: 0.7
        conf: 0.001
        data: null
        batch: 16
        imgsz: 640
        plots: false
        split: "val"
        device: null
        save_json: 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.