From c8c3ddda87fcf809b774b1c90422242e2c162526 Mon Sep 17 00:00:00 2001 From: qingqing01 Date: Wed, 3 Jul 2019 19:02:57 +0800 Subject: [PATCH] Fix some docs. (#2698) * Fix some docs * Unify COCO and VOC * Change PASCAL to Pascal * Unify dataset/coco --- configs/retinanet_r101_fpn_1x.yml | 4 ++-- demo/mask_rcnn_demo.ipynb | 2 +- docs/CONFIG.md | 4 ++-- docs/CONFIG_cn.md | 4 ++-- docs/DATA.md | 4 ++-- docs/DATA_cn.md | 2 +- docs/INSTALL.md | 22 +++++++++++----------- docs/MODEL_ZOO.md | 2 +- 8 files changed, 22 insertions(+), 22 deletions(-) diff --git a/configs/retinanet_r101_fpn_1x.yml b/configs/retinanet_r101_fpn_1x.yml index 3c481ab1b..67399e13d 100644 --- a/configs/retinanet_r101_fpn_1x.yml +++ b/configs/retinanet_r101_fpn_1x.yml @@ -79,7 +79,7 @@ FasterRCNNTrainFeed: - !PadBatch pad_to_stride: 128 dataset: - dataset_dir: data/coco + dataset_dir: dataset/coco annotation: annotations/instances_train2017.json image_dir: train2017 num_workers: 2 @@ -90,7 +90,7 @@ FasterRCNNEvalFeed: - !PadBatch pad_to_stride: 128 dataset: - dataset_dir: data/coco + dataset_dir: dataset/coco annotation: annotations/instances_val2017.json image_dir: val2017 num_workers: 2 diff --git a/demo/mask_rcnn_demo.ipynb b/demo/mask_rcnn_demo.ipynb index eae1100c1..860b18504 100644 --- a/demo/mask_rcnn_demo.ipynb +++ b/demo/mask_rcnn_demo.ipynb @@ -28,7 +28,7 @@ "name": "stdout", "output_type": "stream", "text": [ - "/home/yang/models/PaddleCV/object_detection\n" + "/home/yang/models/PaddleCV/PaddleDetection\n" ] } ], diff --git a/docs/CONFIG.md b/docs/CONFIG.md index 3d8560dd6..10376e055 100644 --- a/docs/CONFIG.md +++ b/docs/CONFIG.md @@ -111,13 +111,13 @@ The corresponding(generated) YAML snippet is as follows, note this is the config ```yaml RPNHead: - test_prop: + test_proposal: eta: 1.0 min_size: 0.1 nms_thresh: 0.5 post_nms_top_n: 1000 pre_nms_top_n: 6000 - train_prop: + train_proposal: eta: 1.0 min_size: 0.1 nms_thresh: 0.5 diff --git a/docs/CONFIG_cn.md b/docs/CONFIG_cn.md index 8f765c7b3..f27b7bdcc 100644 --- a/docs/CONFIG_cn.md +++ b/docs/CONFIG_cn.md @@ -103,13 +103,13 @@ class RPNHead(object): ```yaml RPNHead: - test_prop: + test_proposal: eta: 1.0 min_size: 0.1 nms_thresh: 0.5 post_nms_top_n: 1000 pre_nms_top_n: 6000 - train_prop: + train_proposal: eta: 1.0 min_size: 0.1 nms_thresh: 0.5 diff --git a/docs/DATA.md b/docs/DATA.md index 05f90110f..73f821f34 100644 --- a/docs/DATA.md +++ b/docs/DATA.md @@ -26,7 +26,7 @@ following data sources are supported: Loads `COCO` type datasets with directory structures like this: ``` - data/coco/ + dataset/coco/ ├── annotations │ ├── instances_train2017.json │ ├── instances_val2017.json @@ -167,7 +167,7 @@ The main APIs are as follows: #### Canned Datasets -Preset for common datasets, e.g., `MS-COCO` and `Pascal Voc` are included. In +Preset for common datasets, e.g., `COCO` and `Pascal Voc` are included. In most cases, user can simply use these canned dataset as is. Moreover, the whole data pipeline is fully customizable through the yaml configuration files. diff --git a/docs/DATA_cn.md b/docs/DATA_cn.md index 7c724d69a..c1f50d879 100644 --- a/docs/DATA_cn.md +++ b/docs/DATA_cn.md @@ -14,7 +14,7 @@ 该数据集目前分为COCO2012和COCO2017，主要由json文件和image文件组成，其组织结构如下所示： ``` - data/coco/ + dataset/coco/ ├── annotations │ ├── instances_train2014.json │ ├── instances_train2017.json diff --git a/docs/INSTALL.md b/docs/INSTALL.md index 2941ec02b..b4b3b0592 100644 --- a/docs/INSTALL.md +++ b/docs/INSTALL.md @@ -13,7 +13,7 @@ ## Introduction This document covers how to install PaddleDetection, its dependencies -(including PaddlePaddle), together with COCO and PASCAL VOC dataset. +(including PaddlePaddle), together with COCO and Pascal VOC dataset. For general information about PaddleDetection, please see [README.md](../README.md). @@ -68,12 +68,12 @@ with the following commands: ``` cd git clone https://github.com/PaddlePaddle/models -cd models/PaddleCV/object_detection +cd models/PaddleCV/PaddleDetection ``` **Install Python dependencies:** -Required python packages are specified in [requirements.txt](./requirements.txt), and can be installed with: +Required python packages are specified in [requirements.txt](../requirements.txt), and can be installed with: ``` pip install -r requirements.txt @@ -89,31 +89,31 @@ python ppdet/modeling/tests/test_architectures.py ## Datasets -PaddleDetection includes support for [MSCOCO](http://cocodataset.org) and [PASCAL VOC](http://host.robots.ox.ac.uk/pascal/VOC/) by default, please follow these instructions to set up the dataset. +PaddleDetection includes support for [COCO](http://cocodataset.org) and [Pascal VOC](http://host.robots.ox.ac.uk/pascal/VOC/) by default, please follow these instructions to set up the dataset. **Create symlinks for local datasets:** -Default dataset path in config files is `data/coco` and `data/voc`, if the +Default dataset path in config files is `dataset/coco` and `dataset/voc`, if the datasets are already available on disk, you can simply create symlinks to their directories: ``` -ln -sf /data/coco -ln -sf /data/voc +ln -sf /dataset/coco +ln -sf /dataset/voc ``` **Download datasets manually:** On the other hand, to download the datasets, run the following commands: -- MS-COCO +- COCO ``` cd dataset/coco ./download.sh ``` -- PASCAL VOC +- Pascal VOC ``` cd dataset/voc @@ -123,8 +123,8 @@ cd dataset/voc **Download datasets automatically:** If a training session is started but the dataset is not setup properly (e.g, -not found in `data/coc` or `data/voc`), PaddleDetection can automatically -download them from [MSCOCO-2017](http://images.cocodataset.org) and +not found in `dataset/coco` or `dataset/voc`), PaddleDetection can automatically +download them from [COCO-2017](http://images.cocodataset.org) and [VOC2012](http://host.robots.ox.ac.uk/pascal/VOC), the decompressed datasets will be cached in `~/.cache/paddle/dataset/` and can be discovered automatically subsequently. diff --git a/docs/MODEL_ZOO.md b/docs/MODEL_ZOO.md index f20776bf6..114c5749f 100644 --- a/docs/MODEL_ZOO.md +++ b/docs/MODEL_ZOO.md @@ -77,7 +77,7 @@ randomly color distortion, randomly cropping, randomly expansion, randomly inter **Notes:** In RetinaNet, the base LR is changed to 0.01 for minibatch size 16. -### SSD on PascalVOC +### SSD on Pascal VOC | Backbone | Size | Image/gpu | Lr schd | Box AP | Download | | :----------- | :--: | :-----: | :-----: | :----: | :-------: | -- GitLab