Struct ModelMetadata 

pub struct ModelMetadata {

    pub description: String,
    pub author: String,
    pub date: String,
    pub version: String,
    pub license: String,
    pub docs: String,
    pub task: Task,
    pub stride: u32,
    pub batch: usize,
    pub imgsz: Option<(usize, usize)>,
    pub channels: usize,
    pub half: bool,
    pub names: HashMap<usize, String>,
    pub end2end: bool,
    pub kpt_shape: Option<(usize, usize)>,
}

Metadata extracted from an Ultralytics YOLO ONNX model.

This struct contains all the configuration information embedded in the model, including class names, input dimensions, and task type.

Fields

description: String

Model description (e.g., “Ultralytics YOLO11n model trained on coco.yaml”).

author: String

Model author.

date: String

Export date.

version: String

Ultralytics version used for export.

license: String

License information.

docs: String

Documentation URL.

task: Task

The task this model performs.

stride: u32

Model stride (typically 32 for YOLO).

batch: usize

Batch size the model was exported with.

imgsz: Option<(usize, usize)>

Input image size as (height, width).

channels: usize

Number of input channels (typically 3 for RGB).

half: bool

Whether the model uses FP16 (half precision).

names: HashMap<usize, String>

Class ID to class name mapping.

end2end: bool

Whether the model was exported with end-to-end NMS-free output (YOLO26-style post-NMS output: [B, max_det, 6+extra]).

kpt_shape: Option<(usize, usize)>

Pose keypoint shape as (num_keypoints, dims), e.g. (17, 3).

Implementations

impl ModelMetadata

pub fn from_onnx_metadata( metadata_map: &HashMap<String, String>, ) -> Result<Self>

Parse metadata from ONNX model custom metadata properties.

Arguments

• metadata_map - The custom metadata from the ONNX model session.

Returns

• A new ModelMetadata instance.

Errors

Returns an error if the metadata is missing or malformed.

pub fn from_yaml_str(yaml_str: &str) -> Result<Self>

Parse metadata from a YAML string.

Arguments

• yaml_str - The YAML-formatted metadata string.

Returns

• A new ModelMetadata instance.

Errors

Returns an error if the YAML is malformed or missing required fields.

pub fn num_classes(&self) -> usize

Get the number of classes in this model.

Returns

• The count of classes.

pub fn class_name(&self, class_id: usize) -> Option<&str>

Get a class name by ID.

Arguments

• class_id - The numeric identifier for the class.

Returns

• Some class name if found, otherwise None.

pub fn model_name(&self) -> String

Extract the model name from the description.

E.g. “Ultralytics YOLO11n model…” -> “YOLO11n” Returns YOLO if extraction fails.

Trait Implementations

impl Clone for ModelMetadata

fn clone(&self) -> ModelMetadata

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ModelMetadata

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ModelMetadata

fn default() -> Self

Returns the “default value” for a type.