Docs /Templates/ sinapsis-ultralytics

UltralyticsTrain

sinapsis-ultralyticsUltralyticssegmentationtensorrtclassificationinference

Python template · sinapsis_ultralytics.templates.ultralytics_train

Overview

Template to train an ultralytics model

The template includes functionality to train: "YOLO", "YOLOWorld", "SAM", "FastSAM", "NAS", "RTDETR", configurable through the attributes of the template. This includes the number of epochs, the task, the dataset to use for the training, etc.

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
training_params

TrainParams containing the training parameters for the Ultralytics model. If not specified, default parameters will be used. The full documentation for available training parameters can be found in the Ultralytics docs: https://docs.ultralytics.com/modes/train/#train-settings

TrainParams
Optional
Default: null
lr0
float
Optional
Default: 0.01
data
str | None
Optional
Default: null
name
str | None
Optional
Default: null
save
bool
Optional
Default: true
seed
int
Optional
Default: 0
batch
int
Optional
Default: 16
imgsz
int
Optional
Default: 640
device
int | str | list[int] | None
Optional
Default: null
epochs
int
Optional
Default: 100
project
str | None
Optional
Default: null
workers
int
Optional
Default: 8
exist_ok
bool
Optional
Default: false
optimizer
str
Optional
Default: "auto"
pretrained
bool | str
Optional
Default: true

Configuration example

Example from the Python docstring:

yaml
agent:
  name: my_test_agent
templates:
- template_name: InputTemplate
  class_name: InputTemplate
  attributes: {}
- template_name: UltralyticsTrain
  class_name: UltralyticsTrain
  template_input: InputTemplate
  attributes:
    model_class: YOLO
    model: yolo11n.pt
    task: detect
    verbose: 0
    training_params:
      data: "signature.yaml"
      epochs: 2
      imgsz: 128
      batch: 32
      device: 0
Show schema-based configuration skeleton
yaml
templates:
  - template_name: "UltralyticsTrain"
    class_name: "UltralyticsTrain"
    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
      training_params:
        lr0: 0.01
        data: null
        name: null
        save: true
        seed: 0
        batch: 16
        imgsz: 640
        device: null
        epochs: 100
        project: null
        workers: 8
        exist_ok: false
        optimizer: "auto"
        pretrained: true

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.