MLflow Integration for Ultralytics YOLO
Experiment logging is a crucial aspect of machine learning workflows that enables tracking of various metrics, parameters, and artifacts. It helps to enhance model reproducibility, debug issues, and improve model performance. Ultralytics YOLO, known for its real-time object detection capabilities, now offers integration with MLflow, an open-source platform for complete machine learning lifecycle management.
This documentation page is a comprehensive guide to setting up and utilizing the MLflow logging capabilities for your Ultralytics YOLO project.
What is MLflow?
MLflow is an open-source platform developed by Databricks for managing the end-to-end machine learning lifecycle. It includes tools for tracking experiments, packaging code into reproducible runs, and sharing and deploying models. MLflow is designed to work with any machine learning library and programming language.
- Metrics Logging: Logs metrics at the end of each epoch and at the end of the training.
- Parameter Logging: Logs all the parameters used in the training.
- Artifacts Logging: Logs model artifacts, including weights and configuration files, at the end of the training.
Setup and Prerequisites
Ensure MLflow is installed. If not, install it using pip:
Make sure that MLflow logging is enabled in Ultralytics settings. Usually, this is controlled by the settings
mflow key. See the settings page for more info.
Update Ultralytics MLflow Settings
Within the Python environment, call the
update method on the
settings object to change your settings:
How to Use
Set a Project Name: You can set the project name via an environment variable:
project=<project>argument when training a YOLO model, i.e.
yolo train project=my_project.
Set a Run Name: Similar to setting a project name, you can set the run name via an environment variable:
name=<name>argument when training a YOLO model, i.e.
yolo train project=my_project name=my_name.
Start Local MLflow Server: To start tracking, use:
Kill MLflow Server Instances: To stop all running MLflow instances, run:
The logging is taken care of by the
on_train_end callback functions. These functions are automatically called during the respective stages of the training process, and they handle the logging of parameters, metrics, and artifacts.
Logging Custom Metrics: You can add custom metrics to be logged by modifying the
View Experiment: To view your logs, navigate to your MLflow server (usually http://127.0.0.1:5000) and select your experiment and run.
View Run: Runs are individual models inside an experiment. Click on a Run and see the Run details, including uploaded artifacts and model weights.
To turn off MLflow logging:
MLflow logging integration with Ultralytics YOLO offers a streamlined way to keep track of your machine learning experiments. It empowers you to monitor performance metrics and manage artifacts effectively, thus aiding in robust model development and deployment. For further details please visit the MLflow official documentation.
Created 2023-11-12, Updated 2023-11-18
Authors: glenn-jocher (2)