Docs /Templates/ sinapsis-huggingface-grounding-dino

GroundingDINOClassification

sinapsis-huggingface-grounding-dinoHuggingFaceannotationsgrounding_dinohuggingfaceimage

Python template · sinapsis_huggingface_grounding_dino.templates.grounding_dino_classification

Overview

GroundingDINO model for image classification tasks.

This module provides an implementation of a zero-shot classification system using the GroundingDINO model. The classification pipeline allows for image classification tasks based on a predefined set of classes or text input.

Capabilities

Capabilities: not set

Installation

Install the published package using pip or uv.

Terminalbash
pip install sinapsis-huggingface-grounding-dino==1.0.0
uv pip install sinapsis-huggingface-grounding-dino==1.0.0
uv add sinapsis-huggingface-grounding-dino==1.0.0

Configuration

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

top_k

The maximum number of top predictions to return. Defaults to 5. This specifies an upper limit, and fewer predictions may be returned if the number of valid predictions is less than `top_k`.

int
Optional
Default: 5
deviceRequired
typing.Literal['cuda', 'cpu']
Required
Default: null
metadata
sinapsis_core.template_base.base_models.TemplateMetadata | None
Optional
Default: null
threshold
float
Optional
Default: 0.25
model_path
typing.Literal['IDEA-Research/grounding-dino-base']
Optional
Default: "IDEA-Research/grounding-dino-base"
text_input

Input text for classification.

str | None
Optional
Default: null
classes_file

Path to file containing classification classes.

str | None
Optional
Default: null
inference_modeRequired
typing.Literal['object_detection', 'zero_shot']
Required
Default: null
text_threshold
float
Optional
Default: 0.25
model_cache_dir
str
Optional
Default: "/home/ariel/.cache/sinapsis"

Configuration example

Example from the Python docstring:

yaml
agent:
  name: my_test_agent
templates:
- template_name: InputTemplate
  class_name: InputTemplate
  attributes: {}
- template_name: GroundingDINOClassification
  class_name: GroundingDINOClassification
  template_input: InputTemplate
  attributes:
    model_path: '/path/to/model'
    model_cache_dir: /path/to/cache/dir
    inference_mode: 'object_detection'
    threshold: 0.25
    text_threshold: 0.25
    device: 'cuda'
    classes_file: /file/where/classes/are/stored
    text_input: object to detect
    top_k: 5
Show schema-based configuration skeleton
yaml
templates:
  - template_name: "GroundingDINOClassification"
    class_name: "GroundingDINOClassification"
    attributes:
      top_k: 5
      device: "<required>"
      threshold: 0.25
      model_path: "IDEA-Research/grounding-dino-base"
      text_input: null
      classes_file: null
      inference_mode: "<required>"
      text_threshold: 0.25
      model_cache_dir: "/home/ariel/.cache/sinapsis"

Inheritance

Immediate parent: sinapsis_huggingface_grounding_dino.templates.grounding_dino.GroundingDINO

Environment variables

Environment definitions belong to their canonical Python modules.

No directly related environment variables listed.