You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
243 lines
14 KiB
243 lines
14 KiB
---
|
|
comments: true
|
|
description: Step-by-step guide to train YOLOv8 models with Ultralytics YOLO with examples of single-GPU and multi-GPU training. Efficient way for object detection training.
|
|
keywords: Ultralytics, YOLOv8, YOLO, object detection, train mode, custom dataset, GPU training, multi-GPU, hyperparameters, CLI examples, Python examples
|
|
---
|
|
|
|
<img width="1024" src="https://github.com/ultralytics/assets/raw/main/yolov8/banner-integrations.png">
|
|
|
|
**Train mode** is used for training a YOLOv8 model on a custom dataset. In this mode, the model is trained using the specified dataset and hyperparameters. The training process involves optimizing the model's parameters so that it can accurately predict the classes and locations of objects in an image.
|
|
|
|
!!! tip "Tip"
|
|
|
|
* YOLOv8 datasets like COCO, VOC, ImageNet and many others automatically download on first use, i.e. `yolo train data=coco.yaml`
|
|
|
|
## Usage Examples
|
|
|
|
Train YOLOv8n on the COCO128 dataset for 100 epochs at image size 640. See Arguments section below for a full list of training arguments.
|
|
|
|
!!! example "Single-GPU and CPU Training Example"
|
|
|
|
Device is determined automatically. If a GPU is available then it will be used, otherwise training will start on CPU.
|
|
|
|
=== "Python"
|
|
|
|
```python
|
|
from ultralytics import YOLO
|
|
|
|
# Load a model
|
|
model = YOLO('yolov8n.yaml') # build a new model from YAML
|
|
model = YOLO('yolov8n.pt') # load a pretrained model (recommended for training)
|
|
model = YOLO('yolov8n.yaml').load('yolov8n.pt') # build from YAML and transfer weights
|
|
|
|
# Train the model
|
|
results = model.train(data='coco128.yaml', epochs=100, imgsz=640)
|
|
```
|
|
=== "CLI"
|
|
|
|
```bash
|
|
# Build a new model from YAML and start training from scratch
|
|
yolo detect train data=coco128.yaml model=yolov8n.yaml epochs=100 imgsz=640
|
|
|
|
# Start training from a pretrained *.pt model
|
|
yolo detect train data=coco128.yaml model=yolov8n.pt epochs=100 imgsz=640
|
|
|
|
# Build a new model from YAML, transfer pretrained weights to it and start training
|
|
yolo detect train data=coco128.yaml model=yolov8n.yaml pretrained=yolov8n.pt epochs=100 imgsz=640
|
|
```
|
|
|
|
### Multi-GPU Training
|
|
|
|
The training device can be specified using the `device` argument. If no argument is passed GPU `device=0` will be used if available, otherwise `device=cpu` will be used.
|
|
|
|
!!! example "Multi-GPU Training Example"
|
|
|
|
=== "Python"
|
|
|
|
```python
|
|
from ultralytics import YOLO
|
|
|
|
# Load a model
|
|
model = YOLO('yolov8n.pt') # load a pretrained model (recommended for training)
|
|
|
|
# Train the model with 2 GPUs
|
|
results = model.train(data='coco128.yaml', epochs=100, imgsz=640, device=[0, 1])
|
|
```
|
|
=== "CLI"
|
|
|
|
```bash
|
|
# Start training from a pretrained *.pt model using GPUs 0 and 1
|
|
yolo detect train data=coco128.yaml model=yolov8n.pt epochs=100 imgsz=640 device=0,1
|
|
```
|
|
|
|
### Apple M1 and M2 MPS Training
|
|
|
|
With the support for Apple M1 and M2 chips integrated in the Ultralytics YOLO models, it's now possible to train your models on devices utilizing the powerful Metal Performance Shaders (MPS) framework. The MPS offers a high-performance way of executing computation and image processing tasks on Apple's custom silicon.
|
|
|
|
To enable training on Apple M1 and M2 chips, you should specify 'mps' as your device when initiating the training process. Below is an example of how you could do this in Python and via the command line:
|
|
|
|
!!! example "MPS Training Example"
|
|
|
|
=== "Python"
|
|
|
|
```python
|
|
from ultralytics import YOLO
|
|
|
|
# Load a model
|
|
model = YOLO('yolov8n.pt') # load a pretrained model (recommended for training)
|
|
|
|
# Train the model with 2 GPUs
|
|
results = model.train(data='coco128.yaml', epochs=100, imgsz=640, device='mps')
|
|
```
|
|
=== "CLI"
|
|
|
|
```bash
|
|
# Start training from a pretrained *.pt model using GPUs 0 and 1
|
|
yolo detect train data=coco128.yaml model=yolov8n.pt epochs=100 imgsz=640 device=mps
|
|
```
|
|
|
|
While leveraging the computational power of the M1/M2 chips, this enables more efficient processing of the training tasks. For more detailed guidance and advanced configuration options, please refer to the [PyTorch MPS documentation](https://pytorch.org/docs/stable/notes/mps.html).
|
|
|
|
### Resuming Interrupted Trainings
|
|
|
|
Resuming training from a previously saved state is a crucial feature when working with deep learning models. This can come in handy in various scenarios, like when the training process has been unexpectedly interrupted, or when you wish to continue training a model with new data or for more epochs.
|
|
|
|
When training is resumed, Ultralytics YOLO loads the weights from the last saved model and also restores the optimizer state, learning rate scheduler, and the epoch number. This allows you to continue the training process seamlessly from where it was left off.
|
|
|
|
You can easily resume training in Ultralytics YOLO by setting the `resume` argument to `True` when calling the `train` method, and specifying the path to the `.pt` file containing the partially trained model weights.
|
|
|
|
Below is an example of how to resume an interrupted training using Python and via the command line:
|
|
|
|
!!! example "Resume Training Example"
|
|
|
|
=== "Python"
|
|
|
|
```python
|
|
from ultralytics import YOLO
|
|
|
|
# Load a model
|
|
model = YOLO('path/to/last.pt') # load a partially trained model
|
|
|
|
# Resume training
|
|
results = model.train(resume=True)
|
|
```
|
|
=== "CLI"
|
|
|
|
```bash
|
|
# Resume an interrupted training
|
|
yolo train resume model=path/to/last.pt
|
|
```
|
|
|
|
By setting `resume=True`, the `train` function will continue training from where it left off, using the state stored in the 'path/to/last.pt' file. If the `resume` argument is omitted or set to `False`, the `train` function will start a new training session.
|
|
|
|
Remember that checkpoints are saved at the end of every epoch by default, or at fixed interval using the `save_period` argument, so you must complete at least 1 epoch to resume a training run.
|
|
|
|
## Arguments
|
|
|
|
Training settings for YOLO models refer to the various hyperparameters and configurations used to train the model on a dataset. These settings can affect the model's performance, speed, and accuracy. Some common YOLO training settings include the batch size, learning rate, momentum, and weight decay. Other factors that may affect the training process include the choice of optimizer, the choice of loss function, and the size and composition of the training dataset. It is important to carefully tune and experiment with these settings to achieve the best possible performance for a given task.
|
|
|
|
| Key | Value | Description |
|
|
|-------------------|----------|-----------------------------------------------------------------------------------|
|
|
| `model` | `None` | path to model file, i.e. yolov8n.pt, yolov8n.yaml |
|
|
| `data` | `None` | path to data file, i.e. coco128.yaml |
|
|
| `epochs` | `100` | number of epochs to train for |
|
|
| `patience` | `50` | epochs to wait for no observable improvement for early stopping of training |
|
|
| `batch` | `16` | number of images per batch (-1 for AutoBatch) |
|
|
| `imgsz` | `640` | size of input images as integer |
|
|
| `save` | `True` | save train checkpoints and predict results |
|
|
| `save_period` | `-1` | Save checkpoint every x epochs (disabled if < 1) |
|
|
| `cache` | `False` | True/ram, disk or False. Use cache for data loading |
|
|
| `device` | `None` | device to run on, i.e. cuda device=0 or device=0,1,2,3 or device=cpu |
|
|
| `workers` | `8` | number of worker threads for data loading (per RANK if DDP) |
|
|
| `project` | `None` | project name |
|
|
| `name` | `None` | experiment name |
|
|
| `exist_ok` | `False` | whether to overwrite existing experiment |
|
|
| `pretrained` | `False` | whether to use a pretrained model |
|
|
| `optimizer` | `'auto'` | optimizer to use, choices=[SGD, Adam, Adamax, AdamW, NAdam, RAdam, RMSProp, auto] |
|
|
| `verbose` | `False` | whether to print verbose output |
|
|
| `seed` | `0` | random seed for reproducibility |
|
|
| `deterministic` | `True` | whether to enable deterministic mode |
|
|
| `single_cls` | `False` | train multi-class data as single-class |
|
|
| `rect` | `False` | rectangular training with each batch collated for minimum padding |
|
|
| `cos_lr` | `False` | use cosine learning rate scheduler |
|
|
| `close_mosaic` | `10` | (int) disable mosaic augmentation for final epochs (0 to disable) |
|
|
| `resume` | `False` | resume training from last checkpoint |
|
|
| `amp` | `True` | Automatic Mixed Precision (AMP) training, choices=[True, False] |
|
|
| `fraction` | `1.0` | dataset fraction to train on (default is 1.0, all images in train set) |
|
|
| `profile` | `False` | profile ONNX and TensorRT speeds during training for loggers |
|
|
| `lr0` | `0.01` | initial learning rate (i.e. SGD=1E-2, Adam=1E-3) |
|
|
| `lrf` | `0.01` | final learning rate (lr0 * lrf) |
|
|
| `momentum` | `0.937` | SGD momentum/Adam beta1 |
|
|
| `weight_decay` | `0.0005` | optimizer weight decay 5e-4 |
|
|
| `warmup_epochs` | `3.0` | warmup epochs (fractions ok) |
|
|
| `warmup_momentum` | `0.8` | warmup initial momentum |
|
|
| `warmup_bias_lr` | `0.1` | warmup initial bias lr |
|
|
| `box` | `7.5` | box loss gain |
|
|
| `cls` | `0.5` | cls loss gain (scale with pixels) |
|
|
| `dfl` | `1.5` | dfl loss gain |
|
|
| `pose` | `12.0` | pose loss gain (pose-only) |
|
|
| `kobj` | `2.0` | keypoint obj loss gain (pose-only) |
|
|
| `label_smoothing` | `0.0` | label smoothing (fraction) |
|
|
| `nbs` | `64` | nominal batch size |
|
|
| `overlap_mask` | `True` | masks should overlap during training (segment train only) |
|
|
| `mask_ratio` | `4` | mask downsample ratio (segment train only) |
|
|
| `dropout` | `0.0` | use dropout regularization (classify train only) |
|
|
| `val` | `True` | validate/test during training |
|
|
|
|
## Logging
|
|
|
|
In training a YOLOv8 model, you might find it valuable to keep track of the model's performance over time. This is where logging comes into play. Ultralytics' YOLO provides support for three types of loggers - Comet, ClearML, and TensorBoard.
|
|
|
|
To use a logger, select it from the dropdown menu in the code snippet above and run it. The chosen logger will be installed and initialized.
|
|
|
|
### Comet
|
|
|
|
[Comet](https://www.comet.ml/site/) is a platform that allows data scientists and developers to track, compare, explain and optimize experiments and models. It provides functionalities such as real-time metrics, code diffs, and hyperparameters tracking.
|
|
|
|
To use Comet:
|
|
|
|
```python
|
|
# pip install comet_ml
|
|
import comet_ml
|
|
|
|
comet_ml.init()
|
|
```
|
|
|
|
Remember to sign in to your Comet account on their website and get your API key. You will need to add this to your environment variables or your script to log your experiments.
|
|
|
|
### ClearML
|
|
|
|
[ClearML](https://www.clear.ml/) is an open-source platform that automates tracking of experiments and helps with efficient sharing of resources. It is designed to help teams manage, execute, and reproduce their ML work more efficiently.
|
|
|
|
To use ClearML:
|
|
|
|
```python
|
|
# pip install clearml
|
|
import clearml
|
|
|
|
clearml.browser_login()
|
|
```
|
|
|
|
After running this script, you will need to sign in to your ClearML account on the browser and authenticate your session.
|
|
|
|
### TensorBoard
|
|
|
|
[TensorBoard](https://www.tensorflow.org/tensorboard) is a visualization toolkit for TensorFlow. It allows you to visualize your TensorFlow graph, plot quantitative metrics about the execution of your graph, and show additional data like images that pass through it.
|
|
|
|
To use TensorBoard in [Google Colab](https://colab.research.google.com/github/ultralytics/ultralytics/blob/main/examples/tutorial.ipynb):
|
|
|
|
```bash
|
|
load_ext tensorboard
|
|
tensorboard --logdir ultralytics/runs # replace with 'runs' directory
|
|
```
|
|
|
|
To use TensorBoard locally run the below command and view results at http://localhost:6006/.
|
|
|
|
```bash
|
|
tensorboard --logdir ultralytics/runs # replace with 'runs' directory
|
|
```
|
|
|
|
This will load TensorBoard and direct it to the directory where your training logs are saved.
|
|
|
|
After setting up your logger, you can then proceed with your model training. All training metrics will be automatically logged in your chosen platform, and you can access these logs to monitor your model's performance over time, compare different models, and identify areas for improvement.
|