Merge pull request #45 from yzl19940819/doc

update_docs

README.md

@@ -5,7 +5,7 @@
     <img src="./docs/images/logo.png" align="middle" width = "500" />
   </p>
 
-  **飞桨高性能遥感图像处理开发套件，端到端地完成从训练到部署的全流程遥感深度学习应用。**
+  **基于飞桨框架开发的高性能遥感图像处理开发套件，端到端地完成从训练到部署的全流程遥感深度学习应用。**
 
   <!-- [![Build Status](https://travis-ci.org/PaddleCV-SIG/PaddleRS.svg?branch=release/0.1)](https://travis-ci.org/PaddleCV-SIG/PaddleRS) -->
   <!-- [![Version](https://img.shields.io/github/release/PaddleCV-SIG/PaddleRS.svg)](https://github.com/PaddleCV-SIG/PaddleRS/releases) -->
@@ -16,11 +16,11 @@
 
 ## 最新动态 <img src="docs/images/seg_news_icon.png" width="30"/>
 
-* [2022-03-30] PaddleRS alpha版本发布！详细发版信息请参考[Release Note](https://github.com/PaddleCV-SIG)。
+* [2022-04-09] PaddleRS 将发布alpha版本！详细发版信息请参考[Release Note](https://github.com/PaddleCV-SIG)。
 
 ## 简介
 
-PaddleRS是xxx、xxx、xxx等遥感科研院所共同基于飞桨开发的遥感处理平台，支持遥感图像分类，目标检测，图像分割，以及变化检测等常用遥感任务，帮助开发者更便捷地完成从训练到部署全流程遥感深度学习应用。
+PaddleRS是遥感科研院所、相关高校共同基于飞桨开发的遥感处理平台，支持遥感图像分类，目标检测，图像分割，以及变化检测等常用遥感任务，帮助开发者更便捷地完成从训练到部署全流程遥感深度学习应用。
 
 <div align="center">
 <img src="docs/images/whole_image.jpg"  width = "2000" />  
@@ -176,7 +176,7 @@ PaddleRS是xxx、xxx、xxx等遥感科研院所共同基于飞桨开发的遥感
 * 如果你发现任何PaddleRS存在的问题或者是建议, 欢迎通过[GitHub Issues](https://github.com/PaddleCV-SIG/PaddleRS/issues)给我们提issues。
 * 欢迎加入PaddleRS 微信群
 <div align="center">
-<img src="./docs/images/wechat.jpg"  width = "200" />  
+<img src="./docs/images/wechat.jpg"  width = "150" />  
 </div>
 
 ## 使用教程 <img src="./docs/images/teach.png" width="30"/>
@@ -187,11 +187,14 @@ PaddleRS是xxx、xxx、xxx等遥感科研院所共同基于飞桨开发的遥感
    * [遥感数据集](./docs/data/dataset_cn.md)
    * [智能标注工具EISeg](https://github.com/PaddlePaddle/PaddleSeg/tree/release/2.4/EISeg)
    * [遥感数据处理脚本](./docs/data/tools.md)
-* APIs
-   * [模型库](./docs/apis/model_zoo.md)
-   * [数据增强](./docs/apis/transforms.md)
 * 模型训练
+   * [数据增强](./docs/apis/transforms.md)
+   * [模型库](./docs/apis/model_zoo.md)
+   * [模型训练说明](./docs/apis/model_zoo.md)
+   * 模型验证
 * 推理部署
+   * 模型导出
+   * 推理预测
 * 应用案例
   * [变化检测示例](./docs/cases/csc_cd_cn.md)
   * [超分模块示例](./docs/cases/sr_seg_cn.md)
@@ -216,3 +219,5 @@ PaddleRS是xxx、xxx、xxx等遥感科研院所共同基于飞桨开发的遥感
     year={2022}
 }
 ```
+
+

docs/apis/model_zoo.md

@@ -4,19 +4,19 @@ PaddleRS的基础模型库来自[PaddleClas](https://github.com/PaddlePaddle/Pad
 
 ## 自定义模型库
 
-| 模型名称        | 用途     | ...  |
+| 模型名称        | 用途     | 
-| --------------- | -------- | ---- |
+| --------------- | -------- | 
-| FarSeg          | 语义分割 | ...  |
+| FarSeg          | 语义分割 |
-| BIT             | 变化检测 | ...  |
+| BIT             | 变化检测 |
-| CDNet           | 变化检测 | ...  |
+| CDNet           | 变化检测 |
-| DSIFN           | 变化检测 | ...  |
+| DSIFN           | 变化检测 |
-| STANet          | 变化检测 | ...  |
+| STANet          | 变化检测 |
-| SNUNet          | 变化检测 | ...  |
+| SNUNet          | 变化检测 | 
-| DSAMNet         | 变化检测 | ...  |
+| DSAMNet         | 变化检测 |
-| UNetEarlyFusion | 变化检测 | ...  |
+| UNetEarlyFusion | 变化检测 | 
-| UNetSiamConc    | 变化检测 | ...  |
+| UNetSiamConc    | 变化检测 | 
-| UNetSiamDiff    | 变化检测 | ...  |
+| UNetSiamDiff    | 变化检测 | 
-| ...             | ...      | ...  |
+
 
 ## 如何导入
 

docs/cases/sr_seg_cn.md

@@ -1,4 +1,4 @@
-# [PaddleRS：使用超分模块提高真实的低分辨率无人机影像的分割精度](https://aistudio.baidu.com/aistudio/projectdetail/3696814)
+# [使用图像超分提高低分辨率无人机影像的分割精度](https://aistudio.baidu.com/aistudio/projectdetail/3696814)
 
 ## 一、项目背景
 

docs/install.md

@@ -1,11 +0,0 @@
-PaddleRS develop安装
-
-github代码会跟随开发进度不断更新，可以安装develop分支的代码使用最新的功能，安装方式如下：
-
-```commandline
-git clone https://github.com/PaddleCV-SIG/PaddleRS
-cd PaddleRS
-git checkout develop
-pip install -r requirements.txt
-python setup.py install
-```

docs/quick_start.md

@@ -0,0 +1,42 @@
+
+## 环境准备
+
+- [PaddlePaddle安装](https://www.paddlepaddle.org.cn/install/quick)
+* 版本要求：PaddlePaddle>=2.1.0
+
+- PaddleRS安装
+
+
+PaddleRS代码会跟随开发进度不断更新，可以安装develop分支的代码使用最新的功能，安装方式如下：
+
+```
+git clone https://github.com/PaddleCV-SIG/PaddleRS
+cd PaddleRS
+git checkout develop
+pip install -r requirements.txt
+python setup.py install
+```
+
+## 开始训练
+* 在安装PaddleRS后，使用如下命令开始训练，代码会自动下载训练数据, 并均使用单张GPU卡进行训练。
+
+```commandline
+export CUDA_VISIBLE_DEVICES=0
+python tutorials/train/semantic_segmentation/deeplabv3p_resnet50_multi_channel.py
+```
+
+* 若需使用多张GPU卡进行训练，例如使用2张卡时执行：
+
+```commandline
+python -m paddle.distributed.launch --gpus 0,1 tutorials/train/semantic_segmentation/deeplabv3p_resnet50_multi_channel.py
+```
+使用多卡时，参考[训练参数调整](../../docs/parameters.md)调整学习率和批量大小。
+
+
+## VisualDL可视化训练指标
+在模型训练过程，在`train`函数中，将`use_vdl`设为True，则训练过程会自动将训练日志以VisualDL的格式打点在`save_dir`（用户自己指定的路径）下的`vdl_log`目录，用户可以使用如下命令启动VisualDL服务，查看可视化指标
+```commandline
+visualdl --logdir output/deeplabv3p_resnet50_multi_channel/vdl_log --port 8001
+```
+
+服务启动后，使用浏览器打开 https://0.0.0.0:8001 或 https://localhost:8001

tutorials/train/README.md

@@ -16,13 +16,23 @@
 * [模型API/模型加载API](../../docs/apis/models/README.md)
 * [预测结果可视化API](../../docs/apis/visualize.md) -->
 
-
+## 环境准备
-# 环境准备
 
 - [PaddlePaddle安装](https://www.paddlepaddle.org.cn/install/quick)
 * 版本要求：PaddlePaddle>=2.1.0
 
-- [PaddleRS安装](../../docs/install.md)
+- PaddleRS安装
+
+
+PaddleRS代码会跟随开发进度不断更新，可以安装develop分支的代码使用最新的功能，安装方式如下：
+
+```
+git clone https://github.com/PaddleCV-SIG/PaddleRS
+cd PaddleRS
+git checkout develop
+pip install -r requirements.txt
+python setup.py install
+```
 
 ## 开始训练
 * 在安装PaddleRS后，使用如下命令开始训练，代码会自动下载训练数据, 并均使用单张GPU卡进行训练。
@@ -48,4 +58,3 @@ visualdl --logdir output/deeplabv3p_resnet50_multi_channel/vdl_log --port 8001
 
 服务启动后，使用浏览器打开 https://0.0.0.0:8001 或 https://localhost:8001
 
-