Skip to content

Reference for ultralytics/models/nas/model.py

Note

This file is available at https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/nas/model.py. If you spot a problem please help fix it by contributing a Pull Request 🛠️. Thank you 🙏!


ultralytics.models.nas.model.NAS

NAS(model='yolo_nas_s.pt')

Bases: Model

YOLO NAS model for object detection.

This class provides an interface for the YOLO-NAS models and extends the Model class from Ultralytics engine. It is designed to facilitate the task of object detection using pre-trained or custom-trained YOLO-NAS models.

Example
from ultralytics import NAS

model = NAS('yolo_nas_s')
results = model.predict('ultralytics/assets/bus.jpg')

Attributes:

Name Type Description
model str

Path to the pre-trained model or model name. Defaults to 'yolo_nas_s.pt'.

Note

YOLO-NAS models only support pre-trained models. Do not provide YAML configuration files.

Source code in ultralytics/models/nas/model.py
def __init__(self, model="yolo_nas_s.pt") -> None:
    """Initializes the NAS model with the provided or default 'yolo_nas_s.pt' model."""
    assert Path(model).suffix not in {".yaml", ".yml"}, "YOLO-NAS models only support pre-trained models."
    super().__init__(model, task="detect")

task_map property

task_map

Returns a dictionary mapping tasks to respective predictor and validator classes.

info

info(detailed=False, verbose=True)

Logs model info.

Parameters:

Name Type Description Default
detailed bool

Show detailed information about model.

False
verbose bool

Controls verbosity.

True
Source code in ultralytics/models/nas/model.py
def info(self, detailed=False, verbose=True):
    """
    Logs model info.

    Args:
        detailed (bool): Show detailed information about model.
        verbose (bool): Controls verbosity.
    """
    return model_info(self.model, detailed=detailed, verbose=verbose, imgsz=640)





Created 2023-11-12, Updated 2024-07-21
Authors: glenn-jocher (6), Burhan-Q (1)