Organizing Models

Learn how AI Hub models and model zoos are organized. This page covers JSON model file naming conventions and model zoo directory structure. Local model zoos may follow these conventions.

JSON Model File Naming Conventions

Each JSON model file in a model zoo follows a structured naming convention to maintain consistency and clarity:

<model family name>--[<resolution>_][<density>_][<precision>_][<agent>_][<hardware>_]<version>.json

-- and _ are used as field separators.

<> denotes a field with variable contents.

[] denotes optional fields.

Field Descriptions

Field	Description	Possible Values
model family	The name of the model family	See Model Family Names for model family naming conventions
resolution	Input tensor size (optional)	<integer>x<integer>
density	Model density (optional)	pruned, dense
precision	Model calculation precision (optional)	quant, float
agent	DeGirum runtime agent type for inference (optional)	Agent type or multi
hardware	Hardware for model inference (optional)	Device type or multi
version	Version of the compiled model	<integer>

Model Family Names

When naming model families, follow these conventions:

• Do not use dashes (-). Use underscores (_) instead.

• Do not use capital letters. All names should be in lowercase.

• Include the backbone network as a suffix when applicable. For example:

  • posenet_mobilenet_v1

• Include the network version as a suffix when applicable. For example:

  • mobilenet_v1

• Different model sizes (such as small or large) should be defined as a suffix when applicable. For example:

  • yolo_v5s (for a small version)

These conventions ensure models are easily identifiable and consistent across AI Hub and local model zoos.

Model Zoo Directory Structure

When you create a model zoo directory, AI models should be placed in their own subdirectory containing all necessary files. AI Hub model zoos on the AI Hub follow this structure by default. Local model zoos can be organized in the same way.

Example: Model Directory Structure

<model_zoo_directory>/
    ├── mobilenet_v2_imagenet--224x224_quant_n2x_orca1_1/
    │   ├── mobilenet_v2_imagenet--224x224_quant_n2x_orca1_1.json
    │   ├── mobilenet_v2_imagenet--224x224_quant_n2x_orca1_1.n2x
    │   └── labels.json  (if required)
    ├── yolov8n_coco--640x640_quant_openvino_1/
    │   ├── yolov8n_coco--640x640_quant_openvino_1.json
    │   ├── yolov8n_coco--640x640_quant_openvino_1.xml
    │   ├── yolov8n_coco--640x640_quant_openvino_1.bin
    │   └── postprocess.py  (if required)
    └── yolov8n_relu6_coco_pose--640x640_quant_tflite_edgetpu_1/
        ├── yolov8n_relu6_coco_pose--640x640_quant_tflite_edgetpu_1.json
        ├── yolov8n_relu6_coco_pose--640x640_quant_tflite_edgetpu_1.tflite
        └── labels.json  (if required)

Each subdirectory corresponds to a single model and contains all the necessary files to define, load, and execute that model.