Add DVC Docs integrations page (#6667)
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>pull/6628/head^2
parent
7c0e853237
commit
e504520448
3 changed files with 173 additions and 1 deletions
@ -0,0 +1,171 @@ |
||||
--- |
||||
comments: true |
||||
description: This guide provides a step-by-step approach to integrating DVCLive with Ultralytics YOLOv8 for advanced experiment tracking. Learn how to set up your environment, run experiments with varied configurations, and analyze results using DVCLive's powerful tracking and visualization tools. |
||||
keywords: DVCLive, Ultralytics, YOLOv8, Machine Learning, Experiment Tracking, Data Version Control, ML Workflows, Model Training, Hyperparameter Tuning |
||||
--- |
||||
|
||||
# Advanced YOLOv8 Experiment Tracking with DVCLive |
||||
|
||||
Experiment tracking in machine learning is critical to model development and evaluation. It involves recording and analyzing various parameters, metrics, and outcomes from numerous training runs. This process is essential for understanding model performance and making data-driven decisions to refine and optimize models. |
||||
|
||||
Integrating DVCLive with [Ultralytics YOLOv8](https://ultralytics.com) transforms the way experiments are tracked and managed. This integration offers a seamless solution for automatically logging key experiment details, comparing results across different runs, and visualizing data for in-depth analysis. In this guide, we'll understand how DVCLive can be used to streamline the process. |
||||
|
||||
## DVCLive |
||||
|
||||
<p align="center"> |
||||
<img width="640" src="https://dvc.org/static/6daeb07124bab895bea3f4930e3116e9/aa619/dvclive-studio.webp" alt="DVCLive Overview"> |
||||
</p> |
||||
|
||||
[DVCLive](https://dvc.org/doc/dvclive), developed by DVC, is an innovative open-source tool for experiment tracking in machine learning. Integrating seamlessly with Git and DVC, it automates the logging of crucial experiment data like model parameters and training metrics. Designed for simplicity, DVCLive enables effortless comparison and analysis of multiple runs, enhancing the efficiency of machine learning projects with intuitive data visualization and analysis tools. |
||||
|
||||
## YOLOv8 Training with DVCLive |
||||
|
||||
YOLOv8 training sessions can be effectively monitored with DVCLive. Additionally, DVC provides integral features for visualizing these experiments, including the generation of a report that enables the comparison of metric plots across all tracked experiments, offering a comprehensive view of the training process. |
||||
|
||||
## Installation |
||||
|
||||
To install the required packages, run: |
||||
|
||||
!!! Tip "Installation" |
||||
|
||||
=== "CLI" |
||||
|
||||
```bash |
||||
# Install the required packages for YOLOv8 and DVCLive |
||||
pip install ultralytics dvclive |
||||
``` |
||||
|
||||
For detailed instructions and best practices related to the installation process, be sure to check our [YOLOv8 Installation guide](../quickstart.md). While installing the required packages for YOLOv8, if you encounter any difficulties, consult our [Common Issues guide](../guides/yolo-common-issues.md) for solutions and tips. |
||||
|
||||
## Configuring DVCLive |
||||
|
||||
Once you have installed the necessary packages, the next step is to set up and configure your environment with the necessary credentials. This setup ensures a smooth integration of DVCLive into your existing workflow. |
||||
|
||||
Begin by initializing a Git repository, as Git plays a crucial role in version control for both your code and DVCLive configurations. |
||||
|
||||
!!! Tip "Initial Environment Setup" |
||||
|
||||
=== "CLI" |
||||
|
||||
```bash |
||||
# Initialize a Git repository |
||||
git init -q |
||||
|
||||
# Configure Git with your details |
||||
git config --local user.email "you@example.com" |
||||
git config --local user.name "Your Name" |
||||
|
||||
# Initialize DVCLive in your project |
||||
dvc init -q |
||||
|
||||
# Commit the DVCLive setup to your Git repository |
||||
git commit -m "DVC init" |
||||
``` |
||||
|
||||
In these commands, ensure to replace "you@example.com" with the email address associated with your Git account, and "Your Name" with your Git account username. |
||||
|
||||
## Usage |
||||
|
||||
Before diving into the usage instructions, be sure to check out the range of [YOLOv8 models offered by Ultralytics](../models/index.md). This will help you choose the most appropriate model for your project requirements. |
||||
|
||||
### Training YOLOv8 Models with DVCLive |
||||
|
||||
Start by running your YOLOv8 training sessions. You can use different model configurations and training parameters to suit your project needs. For instance: |
||||
|
||||
```bash |
||||
# Example training commands for YOLOv8 with varying configurations |
||||
yolo train model=yolov8n.pt data=coco8.yaml epochs=5 imgsz=512 |
||||
yolo train model=yolov8n.pt data=coco8.yaml epochs=5 imgsz=640 |
||||
``` |
||||
|
||||
Adjust the model, data, epochs, and imgsz parameters according to your specific requirements. For a detailed understanding of the model training process and best practices, refer to our [YOLOv8 Model Training guide](../modes/train.md). |
||||
|
||||
### Monitoring Experiments with DVCLive |
||||
|
||||
DVCLive enhances the training process by enabling the tracking and visualization of key metrics. When installed, Ultralytics YOLOv8 automatically integrates with DVCLive for experiment tracking, which you can later analyze for performance insights. For a comprehensive understanding of the specific performance metrics used during training, be sure to explore [our detailed guide on performance metrics](../guides/yolo-performance-metrics.md). |
||||
|
||||
### Analyzing Results |
||||
|
||||
After your YOLOv8 training sessions are complete, you can leverage DVCLive's powerful visualization tools for in-depth analysis of the results. DVCLive's integration ensures that all training metrics are systematically logged, facilitating a comprehensive evaluation of your model's performance. |
||||
|
||||
To start the analysis, you can extract the experiment data using DVC's API and process it with Pandas for easier handling and visualization: |
||||
|
||||
```python |
||||
import dvc.api |
||||
import pandas as pd |
||||
|
||||
# Define the columns of interest |
||||
columns = ["Experiment", "epochs", "imgsz", "model", "metrics.mAP50-95(B)"] |
||||
|
||||
# Retrieve experiment data |
||||
df = pd.DataFrame(dvc.api.exp_show(), columns=columns) |
||||
|
||||
# Clean the data |
||||
df.dropna(inplace=True) |
||||
df.reset_index(drop=True, inplace=True) |
||||
|
||||
# Display the DataFrame |
||||
print(df) |
||||
``` |
||||
|
||||
The output of the code snippet above provides a clear tabular view of the different experiments conducted with YOLOv8 models. Each row represents a different training run, detailing the experiment's name, the number of epochs, image size (imgsz), the specific model used, and the mAP50-95(B) metric. This metric is crucial for evaluating the model's accuracy, with higher values indicating better performance. |
||||
|
||||
#### Visualizing Results with Plotly |
||||
|
||||
For a more interactive and visual analysis of your experiment results, you can use Plotly's parallel coordinates plot. This type of plot is particularly useful for understanding the relationships and trade-offs between different parameters and metrics. |
||||
|
||||
```python |
||||
from plotly.express import parallel_coordinates |
||||
|
||||
# Create a parallel coordinates plot |
||||
fig = parallel_coordinates(df, columns, color="metrics.mAP50-95(B)") |
||||
|
||||
# Display the plot |
||||
fig.show() |
||||
``` |
||||
|
||||
The output of the code snippet above generates a plot that will visually represent the relationships between epochs, image size, model type, and their corresponding mAP50-95(B) scores, enabling you to spot trends and patterns in your experiment data. |
||||
|
||||
#### Generating Comparative Visualizations with DVC |
||||
|
||||
DVC provides a useful command to generate comparative plots for your experiments. This can be especially helpful to compare the performance of different models over various training runs. |
||||
|
||||
```bash |
||||
# Generate DVC comparative plots |
||||
dvc plots diff $(dvc exp list --names-only) |
||||
``` |
||||
|
||||
After executing this command, DVC generates plots comparing the metrics across different experiments, which are saved as HTML files. Below is an example image illustrating typical plots generated by this process. The image showcases various graphs, including those representing mAP, recall, precision, loss values, and more, providing a visual overview of key performance metrics: |
||||
|
||||
<p align="center"> |
||||
<img width="640" src="https://dvc.org/0f1243f5a0c5ea940a080478de267cba/yolo-studio-plots.gif" alt="DVCLive Plots"> |
||||
</p> |
||||
|
||||
### Displaying DVC Plots |
||||
|
||||
If you are using a Jupyter Notebook and you want to display the generated DVC plots, you can use the IPython display functionality. |
||||
|
||||
```python |
||||
from IPython.display import HTML |
||||
|
||||
# Display the DVC plots as HTML |
||||
HTML(filename='./dvc_plots/index.html') |
||||
``` |
||||
|
||||
This code will render the HTML file containing the DVC plots directly in your Jupyter Notebook, providing an easy and convenient way to analyze the visualized experiment data. |
||||
|
||||
### Making Data-Driven Decisions |
||||
|
||||
Use the insights gained from these visualizations to make informed decisions about model optimizations, hyperparameter tuning, and other modifications to enhance your model's performance. |
||||
|
||||
### Iterating on Experiments |
||||
|
||||
Based on your analysis, iterate on your experiments. Adjust model configurations, training parameters, or even the data inputs, and repeat the training and analysis process. This iterative approach is key to refining your model for the best possible performance. |
||||
|
||||
## Summary |
||||
|
||||
This guide has led you through the process of integrating DVCLive with Ultralytics' YOLOv8. You have learned how to harness the power of DVCLive for detailed experiment monitoring, effective visualization, and insightful analysis in your machine learning endeavors. |
||||
|
||||
For further details on usage, visit [DVCLive’s official documentation](https://dvc.org/doc/dvclive/ml-frameworks/yolo). |
||||
|
||||
Additionally, explore more integrations and capabilities of Ultralytics by visiting the [Ultralytics integration guide page](../integrations/index.md), which is a collection of great resources and insights. |
Loading…
Reference in new issue