Logs model info. Args: detailed (bool): Show detailed information about model. verbose (bool): Controls verb

Return the value of the specified key if it exists; otherwise, return the default value.

Appends a new transform to the existing list of transforms.

Colors a string https://en.wikipedia.org/wiki/ANSI_escape_code, i.e. colorstr('blue', 'hello world').

Sends the model to the given device. Args: device (str): device

Prints model information Args: verbose (bool): if True, prints out the model information. Defaults to False

Return a copy of the Results object with all tensors on CPU memory.

Concatenate a list of Bboxes objects into a single Bboxes object. Args: boxes_list (List[Bboxes]): A list of Bboxes obje

Get current time.

Return a copy of the Results object with all tensors as numpy arrays.

Converts list of transforms to a standard Python list.

Check if installed dependencies meet YOLOv8 requirements and attempt to auto-update if needed. Args: requirements (Union[Path, str,

Save detection results with optional labels to specified directory.

Clips bounding boxes, segments, and keypoints values to stay within image boundaries.

Returns a list of keys for accessing specific metrics.

Convert a numpy array to a tensor. Args: x (np.ndarray): The array to be converted. Returns: (

Check current version against the required minimum version. Args: current (str): Current version. minimum (str): Required mi

Transfers parameters with matching names and shapes from 'weights' to model.

Return platform-dependent emoji-safe version of string.

Args: results (tuple): A tuple of (p, r, ap, f1, ap_class)

Run all existing callbacks associated with a particular event.

Load YAML data from a file. Args: file (str, optional): File name. Default is 'data.yaml'. append_filename (bool): Add the Y

Add rectangle to image (PIL-only).

Returns a loss dict with labelled training loss items tensor

Save YAML data to a file. Args: file (str, optional): File name. Default is 'data.yaml'. data (dict): Data to save in YAML f

Raises TypeError is model is not a PyTorch model

Convert bounding box format.

Check if the current script is running inside a Google Colab notebook. Returns: (bool): True if running inside a Colab notebook, Fal

Update the boxes, masks, and probs attributes of the Results object.

Strip auth from URL, i.e. https://url.com/file.txt?auth -> https://url.com/file.txt.

De-parallelize a model: returns single-GPU model if model is of type DP or DDP.

Update self.im from a numpy array.

Load and merge configuration data from a file or dictionary. Args: cfg (str | Path | Dict | SimpleNamespace): Configuration data.

Plot the confusion matrix using seaborn and save it to a file. Args: normalize (bool): Whether to normalize the confusio

Selects PyTorch Device. Options are device = None or 'cpu' or 0 or '0' or '0,1,2,3'.

Increments a file or directory path, i.e. runs/exp --> runs/exp{sep}2, runs/exp{sep}3, ... etc. If the path exists and exist_ok is not set t

Mean of results, return mp, mr, map50, map.

Downloads files from a URL, with options for retrying, unzipping, and deleting the downloaded file. Args: url (str): The URL of the

Convert bounding box coordinates from (x, y, width, height) format to (x1, y1, x2, y2) format where (x1, y1) is the top-left corner and (x2,

Args: offset (tuple | list | int): the offset for four coords.

Search/download YAML file (if necessary) and return path, checking suffix.

class-aware result, return p[i], r[i], ap50[i], ap[i].

Returns device if PyTorch model.

Define label paths as a function of image paths.

Determines whether the current file is part of a git repository. If the current file is not part of a git repository, returns None. Retu

Resize and pad image while meeting stride-multiple constraints.

Return model info dict with useful model information. Example for YOLOv8n: {'model/parameters': 3151904, 'model/GFLOPs': 8.

Plot image grid with labels.

Makes an HTTP request using the 'requests' library, with exponential backoff retries up to a specified timeout. Args: method (str):

Return performance metrics and optionally cropped/save images or results.

Computes the average precision per class for object detection evaluation. Args: tp (np.ndarray): Binary array indicating whether the

Search/download file (if necessary) and return path.

Verify image size is a multiple of the given stride in each dimension. If the image size is not a multiple of the stride, update it to the ne

Denormalizes boxes, segments, and keypoints from normalized coordinates.

Export model. Args: **kwargs : Any other args accepted by the predictors. To see all args check 'configuration' section

YOLOv8 export formats.

Model fitness as a weighted combination of metrics.

Determines if the file at the given filepath is part of a pip package. Args: filepath (str): The filepath to check. Returns:

Returns nearest x divisible by divisor.

Args: scale (tuple | list | int): the scale for four coords.

Runs all registered callbacks for a specific event.

PyTorch-accurate time.

Convert bounding box coordinates from (x1, y1, x2, y2) format to (x, y, width, height) format. Args: x (np.ndarray | torch.Tensor):

Logs images to the experiment with optional annotations.

Loads a single model weights.

This function checks for any mismatched keys between a custom configuration list and a base configuration list. If any mismatched keys are fo

Converts bounding box format from one type to another.

Returns a list of HUB-supported export formats.

Return file/dir size (MB).

Reverses the order of the bounding boxes and segments horizontally.

Guess the task of a PyTorch model from its architecture or configuration. Args: model (nn.Module | dict): PyTorch model or model con

Check if a directory is writeable. Args: dir_path (str | Path): The path to the directory. Returns: (bool): True if the

Check if the current script is running inside a Kaggle kernel. Returns: (bool): True if running inside a Kaggle kernel, False otherw

Load the weights into the model. Args: weights (dict | torch.nn.Module): The pre-trained weights to be loaded. verbos

Return a new Results object with the same image, path, and names.

Runs all callbacks associated with a specified event.

Adds text to an image using PIL or cv2.

Decorator to make all processes in distributed training wait for each local_master to do something.

Trains the model on a given dataset. Args: **kwargs (Any): Any number of arguments representing the training configurati

Returns transform of the loaded model.

Read stream `i` frames in daemon thread.

Convert URL to filename, i.e. https://url.com/file.txt?auth -> file.txt.

Convert normalized bounding box coordinates to pixel coordinates. Args: x (np.ndarray | torch.Tensor): The bounding box coordinates.

Initialize the BboxLoss module with regularization maximum and DFL settings.

Initialize the Boxes class.

Return a human-readable string representation of the object.

Returns metadata for YOLO training including epoch and asset saving status.

Log scalars to the NeptuneAI experiment logger.

Attempt file download from GitHub release assets if not found locally. release = 'latest', 'v6.2', etc.

Attempt to authenticate with the server using either id_token or API key. Returns: bool: True if authentication is succe