diff --git a/README.md b/README.md index 061638226a8f7bc8cb02245a26ac7af62c3b44cf..22ecd0d02fdbf95f4d131583981f860e39de4bba 100644 --- a/README.md +++ b/README.md @@ -29,17 +29,48 @@ PaddleSeg支持多进程IO、多卡并行、跨卡Batch Norm同步等训练加
-## 环境依赖 +- [安装](#安装) +- [使用教程](#使用教程) + - [快速入门](#快速入门) + - [基础功能](#基础功能) + - [预测部署](#预测部署) + - [高级功能](#高级功能) +- [在线体验](#在线体验) +- [FAQ](#FAQ) +- [交流与反馈](#交流与反馈) +- [更新日志](#更新日志) +
+ +## 安装 + +### 1. 安装PaddlePaddle + +版本要求 * PaddlePaddle >= 1.6.1 * Python 2.7 or 3.5+ -通过以下命令安装python包依赖,请确保在该分支上至少执行过一次以下命令 -```shell -$ pip install -r requirements.txt +由于图像分割模型计算开销大,推荐在GPU版本的PaddlePaddle下使用PaddleSeg. +``` +pip install paddlepaddle-gpu +``` +更多PaddlePaddle的详细安装信息请查看[PaddlePaddle安装](https://www.paddlepaddle.org.cn/install/doc/index)。 + +### 2. 下载PaddleSeg代码 + ``` +git clone https://github.com/PaddlePaddle/PaddleSeg +``` + +### 3. 安装PaddleSeg依赖 + +``` +cd PaddleSeg +pip install -r requirements.txt +``` +通过以下命令安装python包依赖,请确保在该分支上至少执行过一次以下命令。 + -其他如CUDA版本、cuDNN版本等兼容信息请查看[PaddlePaddle安装](https://www.paddlepaddle.org.cn/install/doc/index)
@@ -51,15 +82,15 @@ $ pip install -r requirements.txt ### 快速入门 -* [安装说明](./docs/installation.md) -* [如何训练/评估/可视化](./docs/usage.md) +* [训练/评估/可视化](./docs/usage.md) ### 基础功能 -* [分割模型介绍](./docs/models.md) -* [预训练模型列表](./docs/model_zoo.md) -* [自定义数据的准备与标注](./docs/data_prepare.md) +* [配置说明与准备](./docs/config.md) +* [自定义数据的标注与准备](./docs/data_prepare.md) * [数据和配置校验](./docs/check.md) +* [分割模型介绍](./docs/models.md) +* [预训练模型下载](./docs/model_zoo.md) * [如何训练DeepLabv3+](./turtorial/finetune_deeplabv3plus.md) * [如何训练U-Net](./turtorial/finetune_unet.md) * [如何训练ICNet](./turtorial/finetune_icnet.md) @@ -81,6 +112,19 @@ $ pip install -r requirements.txt * [特色垂类模型使用](./contrib) * [多进程训练和混合精度训练](./docs/multiple_gpus_train_and_mixed_precision_train.md) +## 在线体验 + +我们在AI Studio平台上提供了在线体验的教程,欢迎体验: + +|在线教程|链接| +|-|-| +|快速开始|[点击体验](https://aistudio.baidu.com/aistudio/projectdetail/100798)| +|U-Net宠物分割|[点击体验](https://aistudio.baidu.com/aistudio/projectDetail/102889)| +|DeepLabv3+图像分割|[点击体验](https://aistudio.baidu.com/aistudio/projectDetail/101696)| +|工业质检(零件瑕疵检测)|[点击体验](https://aistudio.baidu.com/aistudio/projectdetail/184392)| +|人像分割|[点击体验](https://aistudio.baidu.com/aistudio/projectdetail/188833)| +|PaddleSeg特色垂类模型|[点击体验](https://aistudio.baidu.com/aistudio/projectdetail/115541)| +
## FAQ @@ -104,25 +148,14 @@ python pdseg/train.py --cfg xxx.yaml TRAIN.RESUME_MODEL_DIR /PATH/TO/MODEL_CKPT/ A: 降低Batch size,使用Group Norm策略;请注意训练过程中当`DEFAULT_NORM_TYPE`选择`bn`时,为了Batch Norm计算稳定性,batch size需要满足>=2 -
#### Q: 出现错误 ModuleNotFoundError: No module named 'paddle.fluid.contrib.mixed_precision' A: 请将PaddlePaddle升级至1.5.2版本或以上。 -## 在线体验 - -PaddleSeg在AI Studio平台上提供了在线体验的教程,欢迎体验: - -|教程|链接| -|-|-| -|U-Net宠物分割|[点击体验](https://aistudio.baidu.com/aistudio/projectDetail/102889)| -|DeepLabv3+图像分割|[点击体验](https://aistudio.baidu.com/aistudio/projectDetail/101696)| -|PaddleSeg特色垂类模型|[点击体验](https://aistudio.baidu.com/aistudio/projectdetail/115541)| -
-## 交流与反馈 +## 交流与反馈 * 欢迎您通过[Github Issues](https://github.com/PaddlePaddle/PaddleSeg/issues)来提交问题、报告与建议 * 微信公众号:飞桨PaddlePaddle * QQ群: 796771754 @@ -161,6 +194,6 @@ PaddleSeg在AI Studio平台上提供了在线体验的教程,欢迎体验:
-## 如何贡献代码 +## 贡献代码 我们非常欢迎您为PaddleSeg贡献代码或者提供使用建议。 diff --git a/contrib/README.md b/contrib/README.md index 0dbbb9b473500820a919badff3ea21b5b9123bef..c39141255acc41ea4f039b65fae8ca3604c7b972 100644 --- a/contrib/README.md +++ b/contrib/README.md @@ -129,8 +129,18 @@ TEST.TEST_MODEL "./pretrained_model/unet_gongyeyongbiao/" 原图:![](imgs/1560143028.5_IMG_3091.JPG) 预测结果:![](imgs/1560143028.5_IMG_3091.png) - -# 备注 + +## 在线体验 + +PaddleSeg在AI Studio平台上提供了在线体验的教程,欢迎体验: + +|教程|链接| +|-|-| +|工业质检|[点击体验](https://aistudio.baidu.com/aistudio/projectdetail/184392)| +|人像分割|[点击体验](https://aistudio.baidu.com/aistudio/projectdetail/188833)| +|特色垂类模型|[点击体验](https://aistudio.baidu.com/aistudio/projectdetail/115541)| + +## 备注 1. 数据及模型路径等详细配置见ACE2P/HumanSeg/RoadLine下的config.py文件 2. ACE2P模型需预留2G显存,若显存超可调小FLAGS_fraction_of_gpu_memory_to_use diff --git a/docs/installation.md b/docs/installation.md deleted file mode 100644 index 80cc341bb8764065dc7fd871e81fdb31225d636a..0000000000000000000000000000000000000000 --- a/docs/installation.md +++ /dev/null @@ -1,44 +0,0 @@ -# PaddleSeg 安装说明 - -## 1. 安装PaddlePaddle - -版本要求 -* PaddlePaddle >= 1.6.1 -* Python 2.7 or 3.5+ - -更多详细安装信息如CUDA版本、cuDNN版本等兼容信息请查看[PaddlePaddle安装](https://www.paddlepaddle.org.cn/install/doc/index) - -### pip安装 - -由于图像分割模型计算开销大,推荐在GPU版本的PaddlePaddle下使用PaddleSeg. - -``` -pip install paddlepaddle-gpu -``` - -### Conda安装 - -PaddlePaddle最新版本1.5支持Conda安装,可以减少相关依赖安装成本,conda相关使用说明可以参考[Anaconda](https://www.anaconda.com/distribution/) - -``` -conda install -c paddle paddlepaddle-gpu cudatoolkit=9.0 -``` - - * 如果有多卡训练需求,请安装 NVIDIA NCCL >= 2.4.7,并在Linux环境下运行 - -更多安装方式详情可以查看 [PaddlePaddle安装说明](https://www.paddlepaddle.org.cn/documentation/docs/zh/beginners_guide/install/index_cn.html) - - -## 2. 下载PaddleSeg代码 - -``` -git clone https://github.com/PaddlePaddle/PaddleSeg -``` - - -## 3. 安装PaddleSeg依赖 - -``` -cd PaddleSeg -pip install -r requirements.txt -``` diff --git a/docs/usage.md b/docs/usage.md index 1c1d18c0b625a962c103171271d5e204705f458e..67d9c81af564400157341e76a903b341344ace07 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -135,3 +135,7 @@ python pdseg/vis.py --use_gpu \ `NOTE` 1. 可视化的图片会默认保存在visual目录下,可以通过`--vis_dir`来指定输出目录 2. 训练过程中会使用DATASET.VIS_FILE_LIST中的图片进行可视化显示,而vis.py则会使用DATASET.TEST_FILE_LIST + +## 在线体验 + +PaddleSeg在AI Studio平台上提供了在线体验的快速入门教程,欢迎[点击体验](https://aistudio.baidu.com/aistudio/projectdetail/100798) diff --git a/turtorial/finetune_deeplabv3plus.md b/turtorial/finetune_deeplabv3plus.md index 35fb677d9d416512a79ded14bcdcadf516aa6b70..140e8e15605ed9a1f4635690cff99a1cbc39bdc0 100644 --- a/turtorial/finetune_deeplabv3plus.md +++ b/turtorial/finetune_deeplabv3plus.md @@ -110,6 +110,10 @@ python pdseg/train.py --use_gpu --cfg ./configs/deeplabv3p_xception65_pet.yaml ```shell python pdseg/eval.py --use_gpu --cfg ./configs/deeplabv3p_xception65_pet.yaml ``` +## 在线体验 + +PaddleSeg在AI Studio平台上提供了在线体验的DeepLabv3+图像分割教程,欢迎[点击体验](https://aistudio.baidu.com/aistudio/projectDetail/101696)。 + ## 模型组合 diff --git a/turtorial/finetune_unet.md b/turtorial/finetune_unet.md index b1baff8b0d6a9438df0ae4ed6a5f0dfdae4d3414..f490b1012ea0cc5b35167e0f3adbfb7b1fc8b9d9 100644 --- a/turtorial/finetune_unet.md +++ b/turtorial/finetune_unet.md @@ -109,6 +109,9 @@ python pdseg/train.py --use_gpu --cfg ./configs/unet_pet.yaml ```shell python pdseg/eval.py --use_gpu --cfg ./configs/unet_pet.yaml ``` +## 在线体验 + +PaddleSeg在AI Studio平台上提供了在线体验的U-Net宠物分割教程,欢迎[点击体验](https://aistudio.baidu.com/aistudio/projectDetail/102889)。 ## 模型组合