未验证 提交 a8103906 编写于 作者: C cnn 提交者: GitHub

Doc update install, test=document_fix (#1406)

* update INSTALL

* fix typo

* add demo image

* add use_gpu annotation

* fix link

* update style

* update style

* add install paddle

* use python3

* update INSTALL_cn.md

* update INSTALL_cn.md

* update INSTALL_cn.md

* fix typo
上级 d0a3c565
......@@ -4,23 +4,53 @@
## 目录
- [简介](#简介)
- [PaddlePaddle](#paddlepaddle)
- [安装PaddlePaddle](#安装PaddlePaddle)
- [其他依赖安装](#其他依赖安装)
- [PaddleDetection](#PaddleDetection)
- [数据集](#数据集)
## 简介
这份文档介绍了如何安装PaddleDetection及其依赖项(包括PaddlePaddle),以及COCO和Pascal VOC数据集
这份文档介绍了如何安装PaddleDetection及其依赖项(包括PaddlePaddle)。
PaddleDetection的相关信息,请参考[README.md](https://github.com/PaddlePaddle/PaddleDetection/blob/master/README.md).
## PaddlePaddle
## 安装PaddlePaddle
**环境需求:**
- OS 64位操作系统
- Python2 >= 2.7.15 or Python 3(3.5.1+/3.6/3.7),64位版本
- pip/pip3(9.0.1+),64位版本操作系统是
- CUDA >= 9.0
- cuDNN >= 7.6
如果需要 GPU 多卡训练,请先安装NCCL(Windows暂不支持nccl)。
PaddleDetection 依赖 PaddlePaddle 版本关系:
运行PaddleDetection需要PaddlePaddle Fluid v.1.6及更高版本。请按照[安装文档](http://www.paddlepaddle.org.cn/)中的说明进行操作。
| PaddleDetection版本 | PaddlePaddle版本 | 备注 |
| :----------------: | :---------------: | :-------: |
| v0.3 | >=1.7 | -- |
| v0.4 | >= 1.8.4 | PP-YOLO依赖1.8.4 |
```
# install paddlepaddle
python -m pip install paddlepaddle -i https://mirror.baidu.com/pypi/simple
# 如果您的机器安装的是CUDA9,请运行以下命令安装
python -m pip install paddlepaddle-gpu==1.8.4.post97 -i https://mirror.baidu.com/pypi/simple
如果您的机器安装的是CUDA10,请运行以下命令安装
python -m pip install paddlepaddle-gpu==1.8.4.post107 -i https://mirror.baidu.com/pypi/simple
如果您的机器是CPU,请运行以下命令安装
python -m pip install paddlepaddle==1.8.4 -i https://mirror.baidu.com/pypi/simple
```
更多的安装方式如conda, docker安装,请参考[安装文档](https://www.paddlepaddle.org.cn/install/quick)中的说明进行操作
请确保您的PaddlePaddle安装成功并且版本不低于需求版本。使用以下命令进行验证。
......@@ -33,13 +63,6 @@ PaddleDetection的相关信息,请参考[README.md](https://github.com/PaddleP
python -c "import paddle; print(paddle.__version__)"
```
**环境需求:**
- Python2 or Python3 (windows系统仅支持Python3)
- CUDA >= 8.0
- cuDNN >= 5.0
- nccl >= 2.1.2
## 其他依赖安装
......@@ -47,35 +70,19 @@ python -c "import paddle; print(paddle.__version__)"
运行需要COCO-API,安装方式如下:
git clone https://github.com/cocodataset/cocoapi.git
cd cocoapi/PythonAPI
# 若Cython未安装,请安装Cython
pip install Cython
# 安装至全局site-packages
make install
# 若您没有权限或更倾向不安装至全局site-packages
python setup.py install --user
# 或者使用pip安装
pip install "git+https://github.com/cocodataset/cocoapi.git#subdirectory=PythonAPI"
# 安装pycocotools
pip install pycocotools
**windows用户安装COCO-API方式:**
# 若Cython未安装,请安装Cython
pip install Cython
# 由于原版cocoapi不支持windows,采用第三方实现版本,该版本仅支持Python3
pip install git+https://github.com/philferriere/cocoapi.git#subdirectory=PythonAPI
## PaddleDetection
**克隆Paddle models模型库:**
您可以通过以下命令克隆PaddleDetection:
```
cd <path/to/clone/PaddleDetection>
git clone https://github.com/PaddlePaddle/PaddleDetection.git
```
**安装Python依赖库:**
Python依赖库在[requirements.txt](https://github.com/PaddlePaddle/PaddleDetection/blob/master/requirements.txt)中给出,可通过如下命令安装:
......@@ -84,113 +91,47 @@ Python依赖库在[requirements.txt](https://github.com/PaddlePaddle/PaddleDetec
pip install -r requirements.txt
```
**确认测试通过:**
**克隆PaddleDetection库:**
您可以通过以下命令克隆PaddleDetection:
```
python ppdet/modeling/tests/test_architectures.py
cd <path/to/clone/PaddleDetection>
git clone https://github.com/PaddlePaddle/PaddleDetection.git
```
**提示:**
## 数据集
PaddleDetection默认支持[COCO](http://cocodataset.org)[Pascal VOC](http://host.robots.ox.ac.uk/pascal/VOC/)
请按照如下步骤设置数据集。
**为本地数据集创建软链接:**
配置文件中默认的数据集路径是`dataset/coco``dataset/voc`,如果您本地磁盘上已有数据集,
只需创建软链接至数据集目录:
也可以通过 [https://gitee.com/paddlepaddle/PaddleDetection](https://gitee.com/paddlepaddle/PaddleDetection) 克隆。
```
ln -sf <path/to/coco> <path/to/paddle_detection>/dataset/coco
ln -sf <path/to/voc> <path/to/paddle_detection>/dataset/voc
cd <path/to/clone/PaddleDetection>
git clone https://gitee.com/paddlepaddle/PaddleDetection
```
对于Pascal VOC数据集,需通过如下命令创建文件列表:
**确认测试通过:**
```
python dataset/voc/create_list.py
python ppdet/modeling/tests/test_architectures.py
```
**手动下载数据集:**
若您本地没有数据集,可通过如下命令下载:
- COCO
测试通过后会提示如下信息:
```
python dataset/coco/download_coco.py
..........
----------------------------------------------------------------------
Ran 12 tests in 2.480s
OK (skipped=2)
```
`COCO` 数据集目录结构如下:
**预训练模型预测**
```
dataset/coco/
├── annotations
│ ├── instances_train2014.json
│ ├── instances_train2017.json
│ ├── instances_val2014.json
│ ├── instances_val2017.json
│ | ...
├── train2017
│ ├── 000000000009.jpg
│ ├── 000000580008.jpg
│ | ...
├── val2017
│ ├── 000000000139.jpg
│ ├── 000000000285.jpg
│ | ...
| ...
```
- Pascal VOC
使用预训练模型预测图像,快速体验模型预测效果:
```
python dataset/voc/download_voc.py
# use_gpu参数设置是否使用GPU
python tools/infer.py -c configs/ppyolo/ppyolo.yml -o use_gpu=true weights=https://paddlemodels.bj.bcebos.com/object_detection/ppyolo.pdparams --infer_img=demo/000000014439_640x640.jpg
```
`Pascal VOC` 数据集目录结构如下:
```
dataset/voc/
├── trainval.txt
├── test.txt
├── label_list.txt (optional)
├── VOCdevkit/VOC2007
│ ├── Annotations
│ ├── 001789.xml
│ | ...
│ ├── JPEGImages
│ ├── 001789.jpg
│ | ...
│ ├── ImageSets
│ | ...
├── VOCdevkit/VOC2012
│ ├── Annotations
│ ├── 2011_003876.xml
│ | ...
│ ├── JPEGImages
│ ├── 2011_003876.jpg
│ | ...
│ ├── ImageSets
│ | ...
| ...
```
**说明:** 如果你在yaml配置文件中设置`use_default_label=False`, 将从`label_list.txt`
中读取类别列表,反之则可以没有`label_list.txt`文件,检测库会使用Pascal VOC数据集的默
认类别列表,默认类别列表定义在[voc.py](https://github.com/PaddlePaddle/PaddleDetection/blob/master/ppdet/data/source/voc.py)
**自动下载数据集:**
若您在数据集未成功设置(例如,在`dataset/coco``dataset/voc`中找不到)的情况下开始运行,
PaddleDetection将自动从[COCO-2017](http://images.cocodataset.org)
[VOC2012](http://host.robots.ox.ac.uk/pascal/VOC)下载,解压后的数据集将被保存在
`〜/.cache/paddle/dataset/`目录下,下次运行时,也可自动从该目录发现数据集。
会在`output`文件夹下生成一个画有预测结果的同名图像。
**说明:**
结果如下图:
- 如果要使用自定义数据集,请参考[自定义数据集文档](Custom_DataSet.md)
- 更多有关数据集的介绍,请参考[数据处理文档](../advanced_tutorials/READER.md)
![](../images/000000014439_640x640.jpg)
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册