Skip to content

Commit c8c386b

Browse files
authored
Update README.md
1 parent 7fc0b0a commit c8c386b

File tree

1 file changed

+19
-8
lines changed

1 file changed

+19
-8
lines changed

README.md

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
# SSD: Single Shot MultiBox Object Detector, in PyTorch
22
A [PyTorch](http://pytorch.org/) implementation of [Single Shot MultiBox Detector](http://arxiv.org/abs/1512.02325) from the 2016 paper by Wei Liu, Dragomir Anguelov, Dumitru Erhan, Christian Szegedy, Scott Reed, Cheng-Yang, and Alexander C. Berg. The official and original Caffe code can be found [here](https://github.com/weiliu89/caffe/tree/ssd).
33

4+
***UPDATE:*** We have just added support for MS COCO! Check it out [below](#coco).
5+
46
## Authors
57

68
* [**Max de Groot**](https://github.com/amdegroot)
79
* [**Ellis Brown**](http://github.com/ellisbrown)
810

9-
***Note:*** Unfortunately, this is just a hobby of ours and not a full-time job, so we'll do our best to keep things up to date, but no guarantees. That being said, thanks to everyone for your continued help and feedback as it is really appreciated. We will try to address everything as soon as possible.
11+
***Note:*** Unfortunately, this is just a hobby for us and not a full-time job, so we'll do our best to keep things up to date, but no guarantees. That being said, thanks to everyone for your continued help and feedback as it is really appreciated. We will try to address everything as soon as possible.
1012

1113

1214
<img align="right" src= "https://github.com/amdegroot/ssd.pytorch/blob/master/doc/ssd.png" height = 400/>
@@ -30,7 +32,7 @@ A [PyTorch](http://pytorch.org/) implementation of [Single Shot MultiBox Detecto
3032
- Install [PyTorch](http://pytorch.org/) by selecting your environment on the website and running the appropriate command.
3133
- Clone this repository.
3234
* Note: We currently only support Python 3+.
33-
- Then download the dataset by following the [instructions](#download-voc2007-trainval--test) below.
35+
- Then download the dataset by following the [instructions](#datasets) below.
3436
- We now support [Visdom](https://github.com/facebookresearch/visdom) for real-time loss visualization during training!
3537
* To use Visdom in the browser:
3638
```Shell
@@ -40,22 +42,32 @@ A [PyTorch](http://pytorch.org/) implementation of [Single Shot MultiBox Detecto
4042
python -m visdom.server
4143
```
4244
* Then (during training) navigate to http://localhost:8097/ (see the Train section below for training details).
43-
- Note: For training, we currently only support [VOC](http://host.robots.ox.ac.uk/pascal/VOC/), but are adding [COCO](http://mscoco.org/) and hopefully [ImageNet](http://www.image-net.org/) soon.
45+
- Note: For training, we currently support [VOC](http://host.robots.ox.ac.uk/pascal/VOC/) and [COCO](http://mscoco.org/), and aim to add [ImageNet](http://www.image-net.org/) support soon.
4446
- UPDATE: We have switched from PIL Image support to cv2. The plan is to create a branch that uses PIL as well.
4547

4648
## Datasets
47-
To make things easy, we provide a simple VOC dataset loader that inherits `torch.utils.data.Dataset` making it fully compatible with the `torchvision.datasets` [API](http://pytorch.org/docs/torchvision/datasets.html).
49+
To make things easy, we provide bash scripts to handle the dataset downloads and setup for you. We also provide simple dataset loaders that inherit `torch.utils.data.Dataset`, making them fully compatible with the `torchvision.datasets` [API](http://pytorch.org/docs/torchvision/datasets.html).
50+
51+
52+
### COCO
53+
Microsoft COCO: Common Objects in Context
54+
55+
##### Download COCO 2014
56+
```Shell
57+
# specify a directory for dataset to be downloaded into, else default is ~/data/
58+
sh data/scripts/COCO2014.sh
59+
```
4860

4961
### VOC Dataset
50-
##### Download VOC2007 trainval & test
62+
PASCAL VOC: Visual Object Classes
5163

64+
##### Download VOC2007 trainval & test
5265
```Shell
5366
# specify a directory for dataset to be downloaded into, else default is ~/data/
5467
sh data/scripts/VOC2007.sh # <directory>
5568
```
5669

5770
##### Download VOC2012 trainval
58-
5971
```Shell
6072
# specify a directory for dataset to be downloaded into, else default is ~/data/
6173
sh data/scripts/VOC2012.sh # <directory>
@@ -153,11 +165,10 @@ jupyter notebook
153165
- Running `python -m demo.live` opens the webcam and begins detecting!
154166

155167
## TODO
156-
We have accumulated the following to-do list, which you can expect to be done in the very near future
168+
We have accumulated the following to-do list, which we hope to complete in the near future
157169
- Still to come:
158170
* Train SSD300 with batch norm
159171
* Add support for SSD512 training and testing
160-
* Add support for COCO dataset
161172
* Create a functional model definition for Sergey Zagoruyko's [functional-zoo](https://github.com/szagoruyko/functional-zoo)
162173

163174

0 commit comments

Comments
 (0)