2019-02-13 21:15:30 +00:00
< table style = "width:100%" >
< tr >
2019-03-18 10:33:31 +00:00
< th > v2.2< img src = "https://user-images.githubusercontent.com/26833433/52743528-e6096300-2fe2-11e9-970c-5fee45769fab.jpg" width = "400" > < / th >
< th > v3.0< img src = "https://user-images.githubusercontent.com/26833433/54523854-227d0580-4979-11e9-9801-26a3be239875.jpg" width = "400" > < / th >
2019-02-13 21:15:30 +00:00
< th > < img src = "https://storage.googleapis.com/ultralytics/logo/logoname1000.png" width = "200" >
< br > < br / >
< p > < a href = "https://itunes.apple.com/app/id1452689527" >
< img href = "https://itunes.apple.com/app/id1452689527" src = "https://user-images.githubusercontent.com/26833433/50044365-9b22ac00-0082-11e9-862f-e77aee7aa7b0.png" width = "180" >
< / a > < / p > < / th >
< / tr >
< / table >
2019-02-13 21:01:58 +00:00
2019-03-18 10:33:31 +00:00
2018-08-26 08:51:39 +00:00
# Introduction
2019-03-08 12:14:55 +00:00
This directory contains python software and an iOS App developed by Ultralytics LLC, and **is freely available for redistribution under the GPL-3.0 license** . For more information please visit https://www.ultralytics.com.
2018-08-26 08:51:39 +00:00
# Description
2019-02-09 14:12:32 +00:00
The https://github.com/ultralytics/yolov3 repo contains inference and training code for YOLOv3 in PyTorch. The code works on Linux, MacOS and Windows. Training is done on the COCO dataset by default: https://cocodataset.org/#home. **Credit to Joseph Redmon for YOLO** (https://pjreddie.com/darknet/yolo/) and to **Erik Lindernoren for the PyTorch implementation** this work is based on (https://github.com/eriklindernoren/PyTorch-YOLOv3).
2018-08-26 08:51:39 +00:00
# Requirements
2018-11-27 17:14:48 +00:00
Python 3.7 or later with the following `pip3 install -U -r requirements.txt` packages:
2018-08-26 08:51:39 +00:00
- `numpy`
2019-01-05 15:23:17 +00:00
- `torch >= 1.0.0`
2018-08-26 08:51:39 +00:00
- `opencv-python`
2019-03-05 15:23:33 +00:00
# Tutorials
* [Transfer Learning ](https://github.com/ultralytics/yolov3/wiki/Example:-Transfer-Learning )
* [Train Single Image ](https://github.com/ultralytics/yolov3/wiki/Example:-Train-Single-Image )
* [Train Single Class ](https://github.com/ultralytics/yolov3/wiki/Example:-Train-Single-Class )
* [Train Custom Data ](https://github.com/ultralytics/yolov3/wiki/Train-Custom-Data )
2018-08-26 09:05:13 +00:00
# Training
2018-08-26 08:51:39 +00:00
2019-03-18 10:45:49 +00:00
**Start Training:** Run `train.py` to begin training after downloading COCO data with `data/get_coco_dataset.sh` .
2018-09-01 16:35:28 +00:00
2019-03-18 10:46:44 +00:00
**Resume Training:** Run `train.py --resume` resumes training from the latest checkpoint `weights/latest.pt` .
2018-09-01 16:35:28 +00:00
2019-02-27 13:40:41 +00:00
Each epoch trains on 120,000 images from the train and validate COCO sets, and tests on 5000 images from the COCO validate set. Default training settings produce loss plots below, with **training speed of 0.6 s/batch on a 1080 Ti (18 epochs/day)** or 0.45 s/batch on a 2080 Ti.
2018-12-28 18:23:35 +00:00
2019-02-27 13:07:04 +00:00
`from utils import utils; utils.plot_results()`
2019-02-27 13:38:57 +00:00
![Alt ](https://user-images.githubusercontent.com/26833433/53494085-3251aa00-3a9d-11e9-8af7-8c08cf40d70b.png "train.py results" )
2018-09-01 11:34:05 +00:00
2019-03-20 11:35:03 +00:00
# Speed
https://cloud.google.com/deep-learning-vm/
**Machine type:** n1-highmem-4 (4 vCPUs, 26 GB memory)
**CPU platform:** Intel Skylake
**GPUs:** 1-4 x NVIDIA Tesla P100
**HDD:** 100 GB SSD
GPUs | `batch_size` | speed | COCO epoch
--- |---| --- | ---
(P100) | (images) | (s/batch) | (min/epoch)
1 | 24 | 0.84s | 70min
2 | 48 | 1.27s | 53min
4 | 96 | 2.11s | 44min
2018-09-01 11:43:07 +00:00
## Image Augmentation
2018-09-01 11:34:05 +00:00
2018-09-01 16:57:18 +00:00
`datasets.py` applies random OpenCV-powered (https://opencv.org/) augmentation to the input images in accordance with the following specifications. Augmentation is applied **only** during training, not during inference. Bounding boxes are automatically tracked and updated with the images. 416 x 416 examples pictured below.
2018-09-01 11:41:34 +00:00
Augmentation | Description
--- | ---
2018-12-28 18:23:35 +00:00
Translation | +/- 10% (vertical and horizontal)
2018-09-01 12:04:42 +00:00
Rotation | +/- 5 degrees
2018-12-28 18:23:35 +00:00
Shear | +/- 2 degrees (vertical and horizontal)
Scale | +/- 10%
2018-09-01 12:10:06 +00:00
Reflection | 50% probability (horizontal-only)
2018-09-01 12:04:42 +00:00
H**S**V Saturation | +/- 50%
HS**V** Intensity | +/- 50%
2018-09-01 11:34:05 +00:00
2018-12-28 18:52:25 +00:00
< img src = "https://user-images.githubusercontent.com/26833433/50525037-6cbcbc00-0ad9-11e9-8c38-9fd51af530e0.jpg" >
2018-08-26 08:51:39 +00:00
2018-08-26 09:05:13 +00:00
# Inference
2019-02-11 13:13:27 +00:00
Run `detect.py` to apply trained weights to an image, such as `zidane.jpg` from the `data/samples` folder:
2018-12-22 12:05:52 +00:00
2018-12-22 12:20:40 +00:00
**YOLOv3:** `detect.py --cfg cfg/yolov3.cfg --weights weights/yolov3.pt`
2019-03-18 10:33:31 +00:00
< img src = "https://user-images.githubusercontent.com/26833433/50524393-b0adc200-0ad5-11e9-9335-4774a1e52374.jpg" width = "700" >
2018-12-22 12:05:52 +00:00
2018-12-22 12:20:40 +00:00
**YOLOv3-tiny:** `detect.py --cfg cfg/yolov3-tiny.cfg --weights weights/yolov3-tiny.pt`
2019-03-18 10:33:31 +00:00
< img src = "https://user-images.githubusercontent.com/26833433/50374155-21427380-05ea-11e9-8d24-f1a4b2bac1ad.jpg" width = "700" >
2018-09-04 12:36:51 +00:00
2019-02-11 13:11:24 +00:00
## Webcam
2019-02-11 13:13:27 +00:00
Run `detect.py` with `webcam=True` to show a live webcam feed.
2019-02-11 13:11:24 +00:00
2018-12-22 11:49:55 +00:00
# Pretrained Weights
2018-12-22 11:58:59 +00:00
2018-12-22 11:49:55 +00:00
**Darknet** format:
- https://pjreddie.com/media/files/yolov3.weights
- https://pjreddie.com/media/files/yolov3-tiny.weights
**PyTorch** format:
2019-02-09 14:14:31 +00:00
- https://drive.google.com/drive/folders/1uxgUBemJVw9wZsdpboYbzUN4bcRhsuAI
2018-09-01 16:48:53 +00:00
2019-03-20 11:26:46 +00:00
# mAP
Run `test.py --save-json --conf-thres 0.005` to test the official YOLOv3 weights `weights/yolov3.weights` against the 5000 validation images. Compare to .579 at 608 x 608 reported in darknet (https://arxiv.org/abs/1804.02767).
Run `test.py --weights weights/latest.pt` to validate against the latest training results. Hyperparameter settings and loss equation changes affect these results significantly, and additional trade studies may be needed to further improve this.
``` bash
sudo rm -rf yolov3 & & git clone https://github.com/ultralytics/yolov3
# bash yolov3/data/get_coco_dataset.sh
sudo rm -rf cocoapi & & git clone https://github.com/cocodataset/cocoapi & & cd cocoapi/PythonAPI & & make & & cd ../.. & & cp -r cocoapi/PythonAPI/pycocotools yolov3
cd yolov3 & & python3 test.py --save-json --conf-thres 0.005
...
Namespace(batch_size=32, cfg='cfg/yolov3.cfg', conf_thres=0.005, data_cfg='cfg/coco.data', img_size=416, iou_thres=0.5, nms_thres=0.45, save_json=True, weights='weights/yolov3.weights')
loading annotations into memory...
Done (t=4.17s)
creating index...
index created!
Loading and preparing results...
DONE (t=1.75s)
creating index...
index created!
Running per image evaluation...
Evaluate annotation type *bbox*
DONE (t=39.30s).
Accumulating evaluation results...
DONE (t=4.63s).
Average Precision (AP) @[ IoU=0.50:0.95 | area= all | maxDets=100 ] = 0.307
Average Precision (AP) @[ IoU=0.50 | area= all | maxDets=100 ] = 0.545
Average Precision (AP) @[ IoU=0.75 | area= all | maxDets=100 ] = 0.309
Average Precision (AP) @[ IoU=0.50:0.95 | area= small | maxDets=100 ] = 0.140
Average Precision (AP) @[ IoU=0.50:0.95 | area=medium | maxDets=100 ] = 0.333
Average Precision (AP) @[ IoU=0.50:0.95 | area= large | maxDets=100 ] = 0.453
Average Recall (AR) @[ IoU=0.50:0.95 | area= all | maxDets= 1 ] = 0.266
Average Recall (AR) @[ IoU=0.50:0.95 | area= all | maxDets= 10 ] = 0.396
Average Recall (AR) @[ IoU=0.50:0.95 | area= all | maxDets=100 ] = 0.415
Average Recall (AR) @[ IoU=0.50:0.95 | area= small | maxDets=100 ] = 0.222
Average Recall (AR) @[ IoU=0.50:0.95 | area=medium | maxDets=100 ] = 0.449
Average Recall (AR) @[ IoU=0.50:0.95 | area= large | maxDets=100 ] = 0.575
```
2018-08-26 08:51:39 +00:00
# Contact
2018-12-28 18:17:33 +00:00
For questions or comments please contact Glenn Jocher at glenn.jocher@ultralytics.com or visit us at https://contact.ultralytics.com.