Fix and Polish Documents (#149)

Dockerfile

@@ -9,7 +9,7 @@ RUN wget https://paddlers.bj.bcebos.com/dependencies/gdal/GDAL-3.4.1-cp37-cp37m-
 	&& pip install GDAL-3.4.1-cp37-cp37m-manylinux_2_5_x86_64.manylinux1_x86_64.whl \
 	&& rm -rf GDAL-3.4.1-cp37-cp37m-manylinux_2_5_x86_64.manylinux1_x86_64.whl
 
-# 3. clone paddlers
+# 3. clone PaddleRS
 WORKDIR /opt
 RUN git clone https://github.com/PaddlePaddle/PaddleRS.git \
 	&& chmod 777 -R /opt/PaddleRS/examples
@@ -19,12 +19,12 @@ ENV PYTHONPATH /opt/PaddleRS
 WORKDIR /opt/PaddleRS
 RUN pip install -r /opt/PaddleRS/requirements.txt -i https://mirror.baidu.com/pypi/simple
 
-# 5. install pydensecrf
+# 5. install PyDenseCRF
 WORKDIR /usr/src
 RUN pip install git+https://github.com/lucasb-eyer/pydensecrf.git \
 	&& rm -rf /usr/src/pydensecrf
 
-# 6. (optional) install eiseg
+# 6. (optional) install EISeg
 ARG EISEG
 RUN if [ "$EISEG" = "ON" ] ; then \
 	pip install --upgrade pip \
@@ -43,5 +43,5 @@ RUN if [ "$EISEG" = "ON" ] ; then \
 	fi
 ENV DISPLAY host.docker.internal:0
 
-# 7. finish
-WORKDIR /opt/PaddleRS
+# 7. set working directory
+WORKDIR /opt/PaddleRS

README_CN.md

@@ -260,9 +260,9 @@ PaddleRS具有以下五大特色：
       <td>
       <details><summary><b>官方案例</b></summary>
       <ul>
-        <li><a href="https://github.com/PaddleCV-SIG/GeoView">遥感影像智能解译工具GeoView</a></li>
         <li><a href="./examples/rs_research/README.md">PaddleRS科研实战：设计深度学习变化检测模型</a></li>
         <li><a href="./examples/c2fnet/README.md">基于PaddleRS的遥感图像小目标语义分割优化方法</a></li>
+        <li><a href="./examples/building_extraction/README.md">建筑物提取全流程案例</a></li>
       </ul>
       </details>
       <details><summary><b>社区案例</b></summary>
@@ -293,6 +293,7 @@ PaddleRS具有以下五大特色：
 * 模型部署
   * [模型导出](./deploy/export/README.md)
   * [Python部署](./deploy/README.md)
+  * [遥感影像智能解译工具GeoView](https://github.com/PaddleCV-SIG/GeoView)
 * 代码贡献
   * [贡献指南](./docs/CONTRIBUTING_CN.md)
   * [开发指南](./docs/dev/dev_guide_cn.md)
@@ -302,7 +303,6 @@ PaddleRS具有以下五大特色：
 
 ## <img src="./docs/images/anli.png" width="30"/> 实践案例
 
-* [遥感影像智能解译工具GeoView](https://github.com/PaddleCV-SIG/GeoView)
 * [PaddleRS科研实战：设计深度学习变化检测模型](./examples/rs_research/README.md)
 * [基于PaddleRS的遥感图像小目标语义分割优化方法](./examples/c2fnet/README.md)
 

README_EN.md

@@ -260,9 +260,9 @@ PaddleRS is an end-to-end high-efficent development toolkit for remote sensing a
       <td>
       <details><summary><b>Official Examples</b></summary>
       <ul>
-        <li><a href="https://github.com/PaddleCV-SIG/GeoView">GeoView</a></li>
         <li><a href="./examples/rs_research/README.md">change detection research</a></li>
         <li><a href="./examples/c2fnet/README.md">small object optimization</a></li>
+        <li><a href="./examples/building_extraction/README.md">building extraction</a></li>
       </ul>
       </details>
       <details><summary><b>Community Examples</b></summary>
@@ -292,6 +292,7 @@ PaddleRS is an end-to-end high-efficent development toolkit for remote sensing a
 * Model Deployment
   * [Model export](./deploy/export/README.md)
   * [Paddle Inference (Python)](./deploy/README.md)
+  * [Interactive intelligent interprementation tool GeoView](https://github.com/PaddleCV-SIG/GeoView)
 * Development and Contribution
   * [Contributing guides](./docs/CONTRIBUTING_EN.md)
   * [Development manual](./docs/dev/dev_guide_en.md)
@@ -301,7 +302,6 @@ PaddleRS is an end-to-end high-efficent development toolkit for remote sensing a
 
 ## <img src="./docs/images/anli.png" width="30"/> Application Examples
 
-* [Interactive intelligent interprementation tool GeoView](https://github.com/PaddleCV-SIG/GeoView)
 * [Scientific research based on PaddleRS: designing a deep learning change detection model](./examples/rs_research/README.md)
 * [Optimization method for semantic segmentation of small objects in remote sensing images based on PaddleRS](./examples/c2fnet/README.md)
 

deploy/README.md

@@ -55,7 +55,7 @@ res = predictor.predict(("demo_data/A.png", "demo_data/B.png"))
 cm_1024x1024 = res['label_map']
 ```
 
-请注意，**`predictor.predict()`方法接受的影像列表长度与导出模型时指定的batch size必须一致**（若指定的batch size不为-1），这是因为`Predictor`对象将所有输入影像拼接成一个batch执行预测。您可以在[模型推理API说明](https://github.com/PaddlePaddle/PaddleRS/blob/develop/docs/apis/infer_cn.md)中了解关于`predictor.predict()`方法返回结果格式的更多信息。
+请注意，**`predictor.predict()`方法接受的影像列表长度与导出模型时指定的batch size必须一致**（若指定的batch size不为-1），这是因为`Predictor`对象将所有输入影像拼接成一个batch执行预测。您可以在[模型推理API说明](../docs/apis/infer_cn.md)中了解关于`predictor.predict()`方法返回结果格式的更多信息。
 
 ### 2.2 指定预热轮数与重复次数
 

docs/docker_cn.md

@@ -1,46 +1,40 @@
-# PaddleRS镜像构建与使用
+# Docker镜像构建与使用
 
 ## 1. 镜像构建
 
-首先需要拉取仓库：
+PaddleRS提供`Dockerfile`，可构建基础镜像用于开发或部署。在镜像构建过程中，默认将拉取PaddleRS develop分支内容，并存放在`/opt/PaddleRS`。在构建镜像时可以通过`PPTAG`参数指定要使用的PaddlePaddle版本，例如：
 
-```shell
-git clone https://github.com/PaddlePaddle/PaddleRS
-```
-
-- 安装CPU版本，默认为2.4.1：
+- 安装CPU版本的PaddlePaddle-2.4.1，未指定`PPTAG`的情况下将默认安装此版本：
 
 ```shell
 docker build -t paddlers:latest -f Dockerfile .
 ```
 
-- （可选）安装GPU版本，若要使用PaddleRS进行训练，最好使用GPU版本，请确保Docker版本大于19，其他环境的`PPTAG`可以参考[https://hub.docker.com/r/paddlepaddle/paddle/tags](https://hub.docker.com/r/paddlepaddle/paddle/tags)：
+- 安装GPU版本PaddlePaddle-2.4.1，使用CUDA 11.7、cuDNN 8.4以及TensorRT 8.4：
 
 ```shell
 docker build -t paddlers:latest -f Dockerfile . --build-arg PPTAG=2.4.1-gpu-cuda11.7-cudnn8.4-trt8.4
 ```
 
-- （可选）若需要使用[EISeg](https://github.com/PaddlePaddle/PaddleSeg/tree/develop/EISeg)提供的交互式分割标注功能，可设置`EISEG="ON"`，默认只安装了支持遥感标注的扩展：
+其他环境的`PPTAG`可以参考[此处](https://hub.docker.com/r/paddlepaddle/paddle/tags)。请注意，如果需要安装GPU版本的PaddlePaddle，请确保Docker版本>=19。
+
+PaddleRS基础镜像中可选地集成[EISeg](https://github.com/PaddlePaddle/PaddleSeg/tree/develop/EISeg)标注工具。若需要使用EISeg提供的交互式分割标注功能，可设置`EISEG="ON"`：
 
 ```shell
 docker build -t paddlers:latest -f Dockerfile . --build-arg EISEG="ON"
 ```
 
-## 2. 镜像使用
+镜像中的EISeg默认只安装了支持遥感标注的扩展。
 
-- 查看当前构建好的镜像，记住需要启动的镜像的`<imageID>`：
-
-```shell
-docker images
-```
+## 2. 镜像使用
 
-- 仅使用PaddleRS（包括EISeg），可直接启动镜像，将本机存放模型参数的文件夹挂载到docker中，若要使用GPU，在docker 19之后，可以添加中括号内的参数启用GPU：
+通过如下指令创建新的容器。`-v`选项可用于将本机目录挂载到Docker容器中。若需要在容器中使用GPU，对于Docker 19及之后的版本，可以使用`[`、`]`内的参数：
 
 ```shell
-docker run -it -v <本机文件夹绝对路径:容器文件夹绝对路径> [--gpus all -e NVIDIA_DRIVER_CAPABILITIES=compute,utility -e NVIDIA_VISIBLE_DEVICES=all] <imageID>
+docker run -it -v <本机文件夹绝对路径>:<容器文件夹绝对路径> [--gpus all -e NVIDIA_DRIVER_CAPABILITIES=compute,utility -e NVIDIA_VISIBLE_DEVICES=all] paddlers:latest /bin/bash
 ```
 
-- （可选）若需要使用EISeg，则需要在本机安装和开启X11，用于接收Qt的GUI界面。Windows可使用[VcXsrv](https://sourceforge.net/projects/vcxsrv/)，Linux可使用[Xserver](https://blog.csdn.net/a806689294/article/details/111462627)。在相关工具启动之后，再启动EISeg：
+若需要使用EISeg，则需要在本机安装和开启X11。Windows用户可使用[VcXsrv](https://sourceforge.net/projects/vcxsrv/)，Linux用户可使用[Xserver](https://blog.csdn.net/a806689294/article/details/111462627)。在相关工具启动之后，再启动EISeg：
 
 ```shell
 eiseg

docs/docker_en.md

@@ -1,46 +1,40 @@
-# PaddleRS Image Build and Use
+# Docker Image Build and Use
 
-## 1. Image Build
+## 1. Build the Image
 
-First, you need to clone the repository:
+PaddleRS provides `Dockerfile` to build a base Docker image for development/deployment. By default the develop branch of PaddleRS is fetched and stored in `/opts/PaddleRS` during image build. The `PPTAG` argument can be specified to the PaddlePaddle version you want to install. For example,
 
-```shell
-git clone https://github.com/PaddlePaddle/PaddleRS
-```
-
-- Install the CPU version, which is 2.4.1 by default:
+- To install CPU version of PaddlePaddle-2.4.1 (which is installed when `docker build` does not receive a `PPTAG` argument), run:
 
 ```shell
 docker build -t paddlers:latest -f Dockerfile .
 ```
 
-- (Optional) Install the GPU version. If you want to use PaddleRS for training, it is recommended to use the GPU version. Make sure that the Docker version is greater than 19. For other environments, the `PPTAG` can refer to [https://hub.docker.com/r/paddlepaddle/paddle/tags](https://hub.docker.com/r/paddlepaddle/paddle/tags):
+- To install GPU version of PaddlePaddle-2.4.1, with CUDA 11.8, cuDNN 8.4, and TensorRT 8.4, run:
 
 ```shell
 docker build -t paddlers:latest -f Dockerfile . --build-arg PPTAG=2.4.1-gpu-cuda11.7-cudnn8.4-trt8.4
 ```
 
-- (Optional) If you need to use the interactive segmentation annotation function provided by [EISeg](https://github.com/PaddlePaddle/PaddleSeg/tree/develop/EISeg), you can set `EISEG="ON"`. By default, only the extensions that support remote sensing annotation are installed:
+You can find a full list of available PaddlePaddle versions [here](https://hub.docker.com/r/paddlepaddle/paddle/tags). Please note that if a GPU version of PaddlePaddle is to be used, the version of Docker should >=19.
+
+If you want to use the interactive segmentation annotation tool [EISeg](https://github.com/PaddlePaddle/PaddleSeg/tree/develop/EISeg), please set `EISEG="ON"`:
 
 ```shell
 docker build -t paddlers:latest -f Dockerfile . --build-arg EISEG="ON"
 ```
 
-## 2. Image Use
+By default, only the remote sensing extension of EISeg is installed.
 
-- View the currently built images and remember the `<imageID>` of the image to be started:
-
-```shell
-docker images
-```
+## 2. Start a Container
 
-- To use only PaddleRS (including EISeg), you can directly start the image, and mount the folder where the model parameters are stored on the local machine to Docker. If you want to use the GPU, after docker 19, you can add the parameter in square brackets to enable the GPU:
+Create and start a container using the following command. You can mount a file or directory on the host machine into the container by the `-v` option. For Docker 19 and newer versions, you can add the options between `[` and `]` to enable the use of GPU inside the container:
 
 ```shell
-docker run -it -v <local_folder_absolute_path:container_folder_absolute_path> [--gpus all -e NVIDIA_DRIVER_CAPABILITIES=compute,utility -e NVIDIA_VISIBLE_DEVICES=all] <imageID>
+docker run -it -v <absolute_path_on_host_machine>:<absolute_path_in_the_container> [--gpus all -e NVIDIA_DRIVER_CAPABILITIES=compute,utility -e NVIDIA_VISIBLE_DEVICES=all] paddlers:latest /bin/bash
 ```
 
-- (Optional) If you need to use EISeg, you need to install and enable X11 on the local machine to receive the GUI interface of Qt. Windows can use [VcXsrv](https://sourceforge.net/projects/vcxsrv/), and Linux can use [Xserver](https://blog.csdn.net/a806689294/article/details/111462627). After the relevant tools are started, start EISeg:
+If you want to use EISeg, you need to install and enable X11 on the local machine. For Windows users, please refer to [VcXsrv](https://sourceforge.net/projects/vcxsrv/). For Linux users, we recommend [Xserver](https://blog.csdn.net/a806689294/article/details/111462627). With the relevant tools running, start EISeg:
 
 ```shell
 eiseg

docs/quick_start_en.md

@@ -55,7 +55,7 @@ cd paddlers/models/ppdet/ext_op
 python setup.py install
 ```
 
-We also provide a docker image for installation, see [here](./docker_en.md).
+We also provide a Docker image for installation. Please see [here](./docker_en.md) for more details.
 
 ## Model Training
 

examples/README.md

@@ -6,6 +6,7 @@ PaddleRS提供从科学研究到产业应用的丰富示例，希望帮助遥感
 
 - [PaddleRS科研实战：设计深度学习变化检测模型](./rs_research/)
 - [基于PaddleRS的遥感图像小目标语义分割优化方法](./c2fnet/)
+- [建筑物提取全流程案例](./building_extraction/)
 
 ## 2 社区贡献案例
 

examples/building_extraction/Dockerfile

@@ -10,8 +10,7 @@ RUN apt-get update \
 
 # 2. clone geoview
 WORKDIR /opt
-RUN git clone https://github.com/PaddleCV-SIG/GeoView.git \
-	&& mv PaddleRS GeoView
+RUN git clone --recursive -b release/0.1 https://github.com/PaddleCV-SIG/GeoView.git \
 ENV PYTHONPATH /opt/GeoView/PaddleRS
 
 # 3. install backend requirements 
@@ -23,5 +22,5 @@ RUN pip install -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple
 WORKDIR /opt/GeoView/frontend
 RUN npm install
 
-# 5. finish
-WORKDIR /opt/GeoView
+# 5. set working directory
+WORKDIR /opt/GeoView

examples/building_extraction/README.md

@@ -1,32 +1,47 @@
-# 基于Docker环境的PaddleRS全流程建筑物提取
+# 建筑物提取全流程案例
 
-PaddleRS提供了对遥感影像的训练和推理能力，那么结合EISeg提供的标注能力和GeoView提供的部署和展示能力就能全流程的完成遥感的语义分割任务了，此说明将基于docker环境完成使用上述工具对卫星影像中的建筑物从标注到训练再到部署的全流程。
+PaddleRS提供遥感模型训练和推理能力，结合EISeg提供的标注能力和GeoView提供的部署与展示能力，即可全流程地完成遥感图像分割任务。本案例基于Docker环境，在Windows 10系统使用上述工具实现对卫星影像建筑物提取任务从标注到训练再到部署的全流程开发。
 
 ## 〇、准备
 
-- 构建镜像并运行镜像，详细过程请参考PaddleRS关于Docker构建的[文档](../../docs/docker_cn.md)。这里使用的容器文件夹绝对路径为`/usr/qingdao`。该路径包含一张青岛的tif影像。
-- 使用[GeoView](https://github.com/PaddleCV-SIG/GeoView/tree/develop)提供的智能遥感影像解译功能，可在完成PaddleRS镜像的基础上安装该文件夹内提供的镜像。若PaddleRS的基本镜像名称自定义为`<imageName>`，需要编辑该文件夹下的`Dockerfile`，将`From paddlers:latest`改为`From <imageName>`，然后构建镜像：
+- 构建PaddleRS基础Docker镜像，详细过程请参考PaddleRS关于Docker镜像构建的[文档](https://github.com/PaddlePaddle/PaddleRS/blob/release/1.1/docs/docker_cn.md)。
+- 为使用[GeoView](https://github.com/PaddleCV-SIG/GeoView)提供的遥感影像智能解译功能，可在PaddleRS基础镜像基础上使用本案例提供的`Dockerfile`构建GeoView镜像。若PaddleRS基础镜像名称为`<imageName>`，需要将`Dockerfile`中的`FROM paddlers:latest`改为`FROM <imageName>`，然后构建镜像：
 
 ```shell
 docker build -t geoview:latest -f Dockerfile .
 ```
 
+基于构建的镜像创建并运行Docker容器。
+
+```shell
+docker run -it -v <本机文件夹绝对路径>:<容器文件夹绝对路径> [--gpus all -e NVIDIA_DRIVER_CAPABILITIES=compute,utility -e NVIDIA_VISIBLE_DEVICES=all] geoview:latest /bin/bash
+```
+
+`-v`选项指定的`<本机文件夹绝对路径>`可用于在Docker容器和宿主机之间共享文件。
+
+为便于说明，本案例提供一幅青岛地区tif影像作为示例数据。在Docker容器中执行如下指令下载数据并解压到`/usr/qingdao`目录：
+
+```shell
+wget https://paddlers.bj.bcebos.com/datasets/qingdao.zip
+unzip -d /usr/qingdao qingdao.zip
+```
+
 ## 一、数据标注
 
-- 安装paddlers。
+- 切换到`/opt/GeoView/PaddleRS`目录，安装PaddleRS。
 
 ```shell
 python setup.py install
 ```
 
-- 首先进行切分图像，虽然EISeg可以直接读取大图进行分块标注和保存，但为了控制标注的数量，可以先使用PaddleRS提供的切分工具。
+- 切分图像。虽然EISeg可以直接读取大图并进行分块标注和保存，但为了控制标注的数量，可以先使用PaddleRS提供的工具预先对图像进行切分。
 
 ```shell
 cd tools/
 python split.py --image_path /usr/qingdao/qingdao.tif --block_size 512 --save_dir /usr/qingdao/dataset/
 ```
 
-- 等待进度条完成后则数据划分完毕。此时将建筑交互式模型参数[下载](https://paddleseg.bj.bcebos.com/eiseg/0.4/static_hrnet18_ocr48_rsbuilding_instance.zip)到共享文件夹中，打开[VcXsrv](https://sourceforge.net/projects/vcxsrv/)（宿主机系统为Windows10），准备使用EISeg进行标注。具体操作参考PaddleRS关于Docker构建的[文档](../docker/README.md)中关于EISeg的使用部分。
+- 等待进度条完成后数据划分完毕。将[适用于建筑物提取的交互式分割模型参数](https://paddleseg.bj.bcebos.com/eiseg/0.4/static_hrnet18_ocr48_rsbuilding_instance.zip)下载到共享文件夹中，打开[VcXsrv](https://sourceforge.net/projects/vcxsrv/)（宿主机系统为Windows 10），准备使用EISeg进行标注。具体操作请参考PaddleRS [Docker镜像构建与使用文档](https://github.com/PaddlePaddle/PaddleRS/blob/release/1.1/docs/docker_cn.md#2-%E9%95%9C%E5%83%8F%E4%BD%BF%E7%94%A8)中关于EISeg使用的部分。
 
 ![eiseg](https://user-images.githubusercontent.com/71769312/222040539-34a369f3-6da8-4047-a3a5-ebf9b831d175.png)
 
@@ -40,18 +55,20 @@ python split.py --image_path /usr/qingdao/qingdao.tif --block_size 512 --save_di
 
 ## 二、模型训练
 
-- 标注完成后可参考PaddleRS的[训练文档](../../tutorials/train/README.md)进行训练。对于标注好的数据，在EISeg的保存目录中为如下格式：
+标注完成后，可参考PaddleRS的[训练文档](https://github.com/PaddlePaddle/PaddleRS/blob/release/1.0/tutorials/train/README.md)进行模型训练。
 
-```
+- 对于标注好的数据，在EISeg的保存目录中存储为如下结构：
+
+```plaintext
 dataset
   ├- label
   |    └- A.tif
   └- A.tif
 ```
 
-- 因此需要将数据移动为下列格式：
+需要变更为如下结构：
 
-```
+```plaintext
 dataset
   ├- label
   |    └- A.tif
@@ -59,7 +76,7 @@ dataset
        └- A.tif
 ```
 
-- 然后生成对应的数据列表，可以在`dataset`中新建如下脚本文件并运行：
+- 接着，生成对应的列表文件。可以创建一个Python脚本文件，填充如下内容并执行：
 
 ```python
 import os
@@ -84,7 +101,14 @@ if __name__ == "__main__":
                     tf.write(img_path + " " + lab_path + "\n")
 ```
 
-- 完成后得到标准的数据集结构，以Farseg为例，可以参照[Farseg的训练文件](../../tutorials/train/segmentation/farseg.py)进行训练。进入路径`../tutorials/train/segmentation`修改`farseg.py`中的数据集路径，并把数据下载和选择前三个波段进行注释：
+在`/usr/qingdao/dataset`中创建`labels.txt`文件，填入如下内容：
+
+```plaintext
+background
+building
+```
+
+- 上述步骤完成后，数据集已被处理为PaddleRS要求的格式。接下来需要编写训练脚本，或者可以选择对PaddleRS提供的示例脚本进行修改。以FarSeg模型为例，可对FarSeg训练示例脚本（位于`/opt/GeoView/PaddleRS/tutorials/train/semantic_segmentation/farseg.py`）进行修改，调整路径参数，并注释或去除数据下载部分。本案例使用的示例影像波段数量等于3，故无需使用波段选择算子（`T.SelectBand`），去除之。对于波段数量大于3的情况，可以使用该算子挑选作为模型输入的波段。
 
 ```python
 # 数据集存放目录
@@ -105,14 +129,9 @@ EXP_DIR = '/usr/qingdao/output/farseg/'
 # T.SelectBand([1, 2, 3]),
 ```
 
-- 其中`labels.txt`可以手动创建，里面为：
-
-```
-background
-building
-```
+除上述修改外，也可以根据实际需求对模型训练使用的超参数、数据变换算子等进行修改。
 
-- 然后可以对下面的超参数进行调整，调整完成后保存退出，使用下列命令进行训练：
+- 切换到训练脚本所在目录，使用下列命令执行脚本：
 
 ```shell
 python farseg.py
@@ -122,10 +141,10 @@ python farseg.py
 
 ## 三、可视化
 
-- 新建一个终端，启动镜像加载后端，将训练好的模型挂载到容器内：
+- 在另一个终端中启动Docker容器，将训练好的模型存放路径挂载到容器内：
 
 ```shell
-docker run --name <containerName> -p 5008:5008 -p 3000:3000 -it -v <本机文件夹绝对路径:容器文件夹绝对路径> [--gpus all -e NVIDIA_DRIVER_CAPABILITIES=compute,utility -e NVIDIA_VISIBLE_DEVICES=all] <imageID>
+docker run --name <containerName> -p 5008:5008 -p 3000:3000 -it -v <本机模型存放路径>:<容器内挂载绝对路径> [--gpus all -e NVIDIA_DRIVER_CAPABILITIES=compute,utility -e NVIDIA_VISIBLE_DEVICES=all] geoview:latest /bin/bash
 ```
 
 - 启动MySQL：
@@ -135,7 +154,7 @@ service mysql start
 mysql -u root
 ```
 
-- 注册MySQL的用户并赋予权限：
+- 创建MySQL用户并赋予权限：
 
 ```shell
 CREATE USER 'paddle_rs'@'localhost' IDENTIFIED BY '123456';
@@ -144,20 +163,19 @@ FLUSH PRIVILEGES;
 quit;
 ```
 
-- 进入后端，根据实际修改flaskenv：
+- 切换到`backend`目录，根据实际情况修改`.flaskenv`：
 
 ```shell
-cd backend
 vim .flaskenv
 ```
 
-- 设置百度地图Access Key，百度地图的Access Key可在[百度地图开放平台](http://lbsyun.baidu.com/apiconsole/key?application=key)申请：
+- 设置百度地图Access Key。百度地图的Access Key可在[百度地图开放平台](http://lbsyun.baidu.com/apiconsole/key?application=key)申请。
 
 ```shell
 vim ../config.yaml
 ```
 
-- 参考GeoView的文档进行[模型准备](https://github.com/geoyee/GeoView/blob/develop/docs/dev.md)，将模型导出为部署模型，使用以下脚本：
+- 参考GeoView文档进行[模型准备](https://github.com/PaddleCV-SIG/GeoView/blob/release/0.1/docs/dev.md)，将模型导出为部署格式。具体而言，执行如下命令：
 
 ```shell
 cd /opt/GeoView/
@@ -172,14 +190,14 @@ python deploy/export/export_model.py --model_dir=/usr/qingdao/output/farseg/best
 python app.py
 ```
 
-- 新建一个终端，根据上面的`<containerName>`来启动前端：
+- 在另一个终端中根据`<containerName>`启动前端：
 
 ```shell
 docker exec -it <containerName> bash -c "cd frontend && npm run serve"
 ```
 
-- 进入到`http://localhost:3000/`，这里我们已经按照要求将训练好的模型放到了`backend/model/semantic_segmentation`文件夹下，可以看到在`地物分类`的可选模型中，已经有了我们放过去的模型。
+- 在浏览器打开`http://localhost:3000/`，如果在`地物分类`的可选模型中未包含先前训练的模型，需要确认是否已将模型存放在`backend/model/semantic_segmentation`。
 
 ![geoview](https://github.com/geoyee/img-bed/assets/71769312/7228c87c-5d2a-4e4a-bd98-b76a6a791b68)
 
-- 上传图像，开始处理，就能得到可视化的结果了。
+- 根据[GeoView文档](https://github.com/PaddleCV-SIG/GeoView/blob/release/0.1/docs/semantic_segmentation.md)上传图像，得到建筑物提取结果。

examples/c2fnet/README.md

@@ -1,5 +1,5 @@
 # 基于PaddleRS的遥感图像小目标语义分割优化方法
-本项目为C2FNet基于PaddleRS的官方实现代码。本方法实现了一个从粗到细的模型，对现有的任意语义分割方法进行优化，实现对小目标的准确分割。
+本案例为C2FNet基于PaddleRS的官方实现代码。本方法实现了一个从粗到细的模型，对现有的任意语义分割方法进行优化，实现对小目标的准确分割。
 
 ## 安装说明
 ### 环境依赖
@@ -10,22 +10,23 @@ PaddleRS: 1.0
 ```
 
 ### 安装过程
-a. 创建并激活一个conda虚拟环境。
+
+a. （可选）创建并激活一个conda虚拟环境。
 ```bash
 conda create -n paddlers python=3.8
 conda activate paddlers
 ```
+
 b. 安装PaddlePaddle [详见官方网址](https://www.paddlepaddle.org.cn/en/install/quick?docurl=/documentation/docs/en/install/pip/linux-pip_en.html) (PaddlePaddle版本需要 >= 2.3)。
 
 c. 克隆PaddleRS代码库。
 ```bash
-git clone https://github.com/PaddlePaddle/PaddleRS
+git clone -b release/1.0 https://github.com/PaddlePaddle/PaddleRS
 ```
 
 d. 安装PaddleRS环境依赖。
 ```bash
 cd PaddleRS
-git checkout develop
 pip install -r requirements.txt
 ```
 

examples/c2fnet/train.py

@@ -24,20 +24,25 @@ NUM_BANDS = 3
 # 使用Compose组合多种变换方式。Compose中包含的变换将按顺序串行执行
 # API说明：https://github.com/PaddlePaddle/PaddleRS/blob/develop/docs/apis/data.md
 train_transforms = T.Compose([
+    # 读取影像
+    T.DecodeImg(),
     # 将影像缩放到512x512大小
     T.Resize(target_size=512),
     # 以50%的概率实施随机水平翻转
     T.RandomHorizontalFlip(prob=0.5),
     # 将数据归一化到[-1,1]
     T.Normalize(
-        mean=[0.5] * NUM_BANDS, std=[0.5] * NUM_BANDS)
+        mean=[0.5] * NUM_BANDS, std=[0.5] * NUM_BANDS),
+    T.ArrangeSegmenter('train')
 ])
 
 eval_transforms = T.Compose([
+    T.DecodeImg(),
     # 验证阶段与训练阶段的数据归一化方式必须相同
     T.Normalize(
         mean=[0.5] * NUM_BANDS, std=[0.5] * NUM_BANDS),
-    T.ReloadMask()
+    T.ReloadMask(),
+    T.ArrangeSegmenter('eval')
 ])
 
 # 分别构建训练和验证所用的数据集

examples/rs_research/README.md

@@ -4,7 +4,7 @@
 
 ## 1 环境配置
 
-根据[教程](https://github.com/PaddlePaddle/PaddleRS/tree/develop/tutorials/train#环境准备)安装PaddleRS及相关依赖。在本案例中，GDAL库并不是必需的。
+根据[教程](https://github.com/PaddlePaddle/PaddleRS/tree/develop/tutorials/train#环境准备)安装PaddleRS **1.0**及相关依赖。在本案例中，GDAL库并不是必需的。
 
 配置好环境后，在PaddleRS仓库根目录中执行如下指令切换到本案例所在目录：
 

examples/rs_research/configs/levircd/ablation/custom_model_c.yaml

@@ -3,6 +3,6 @@ _base_: ../levircd.yaml
 save_dir: ./exp/levircd/ablation/att_c/
 
 model: !Node
-  type: CustomTrainer
-  args:
-    att_types: c
+    type: CustomTrainer
+    args:
+        att_types: c

examples/rs_research/configs/levircd/ablation/custom_model_t.yaml

@@ -3,6 +3,6 @@ _base_: ../levircd.yaml
 save_dir: ./exp/levircd/ablation/att_t/
 
 model: !Node
-  type: CustomTrainer
-  args:
-    att_types: t
+    type: CustomTrainer
+    args:
+        att_types: t

examples/rs_research/configs/levircd/custom_model.yaml

@@ -3,4 +3,4 @@ _base_: ./levircd.yaml
 save_dir: ./exp/levircd/custom_model/
 
 model: !Node
-  type: CustomTrainer
+    type: CustomTrainer

examples/rs_research/configs/levircd/fc_ef.yaml

@@ -3,4 +3,4 @@ _base_: ./levircd.yaml
 save_dir: ./exp/levircd/fc_ef/
 
 model: !Node
-  type: FCEarlyFusion
+    type: FCEarlyFusion

examples/rs_research/configs/levircd/fc_siam_conc.yaml

@@ -3,4 +3,4 @@ _base_: ./levircd.yaml
 save_dir: ./exp/levircd/fc_siam_conc/
 
 model: !Node
-  type: FCSiamConc
+    type: FCSiamConc

examples/rs_research/configs/levircd/fc_siam_diff.yaml

@@ -3,4 +3,4 @@ _base_: ./levircd.yaml
 save_dir: ./exp/levircd/fc_siam_diff/
 
 model: !Node
-  type: FCSiamDiff
+    type: FCSiamDiff

examples/rs_research/configs/levircd/levircd.yaml

@@ -1,63 +1,69 @@
 # Basic configurations of LEVIR-CD dataset
 
 datasets:
-  train: !Node
-    type: CDDataset
-    args:
-      data_dir: ./data/levircd/
-      file_list: ./data/levircd/train.txt
-      label_list: null
-      num_workers: 2
-      shuffle: True
-      with_seg_labels: False
-      binarize_labels: True
-  eval: !Node
-    type: CDDataset
-    args:
-      data_dir: ./data/levircd/
-      file_list: ./data/levircd/val.txt
-      label_list: null
-      num_workers: 0
-      shuffle: False
-      with_seg_labels: False
-      binarize_labels: True
+    train: !Node
+        type: CDDataset
+        args: 
+            data_dir: ./data/levircd/
+            file_list: ./data/levircd/train.txt
+            label_list: null
+            num_workers: 2
+            shuffle: True
+            with_seg_labels: False
+            binarize_labels: True
+    eval: !Node
+        type: CDDataset
+        args:
+            data_dir: ./data/levircd/
+            file_list: ./data/levircd/val.txt
+            label_list: null
+            num_workers: 0
+            shuffle: False
+            with_seg_labels: False
+            binarize_labels: True
 transforms:
-  train:
-    - !Node
-      type: DecodeImg
-    - !Node
-      type: RandomFlipOrRotate
-      args:
-        probs: [0.35, 0.35]
-        probsf: [0.5, 0.5, 0, 0, 0]
-        probsr: [0.33, 0.34, 0.33]
-    - !Node
-      type: Normalize
-      args:
-        mean: [0.5, 0.5, 0.5]
-        std: [0.5, 0.5, 0.5]
-  eval:
-    - !Node
-      type: DecodeImg
-    - !Node
-      type: Normalize
-      args:
-        mean: [0.5, 0.5, 0.5]
-        std: [0.5, 0.5, 0.5]
+    train:
+        - !Node
+          type: DecodeImg
+        - !Node
+          type: RandomFlipOrRotate
+          args:
+            probs: [0.35, 0.35]
+            probsf: [0.5, 0.5, 0, 0, 0]
+            probsr: [0.33, 0.34, 0.33]
+        - !Node
+          type: Normalize
+          args:
+            mean: [0.5, 0.5, 0.5]
+            std: [0.5, 0.5, 0.5]
+        - !Node
+          type: ArrangeChangeDetector
+          args: ['train']
+    eval:
+        - !Node
+          type: DecodeImg
+        - !Node
+          type: Normalize
+          args:
+            mean: [0.5, 0.5, 0.5]
+            std: [0.5, 0.5, 0.5]
+        - !Node
+          type: ArrangeChangeDetector
+          args: ['eval']
 download_on: False
 
 num_epochs: 50
 train_batch_size: 8
 optimizer: !Node
-  type: Adam
-  args:
-    learning_rate: !Node
-      type: StepDecay
-      module: paddle.optimizer.lr
-      args:
-        learning_rate: 0.002
-        step_size: 35000
-        gamma: 0.2
+    type: Adam
+    args:
+        learning_rate: !Node
+            type: StepDecay
+            module: paddle.optimizer.lr
+            args:
+                learning_rate: 0.002
+                step_size: 35000
+                gamma: 0.2
 save_interval_epochs: 5
 log_interval_steps: 50
 save_dir: ./exp/levircd/

examples/rs_research/train_cd.py

@@ -18,6 +18,8 @@ EXP_DIR = 'exp/levircd/custom_model/'
 # 使用Compose组合多种变换方式。Compose中包含的变换将按顺序串行执行
 # API说明：https://github.com/PaddlePaddle/PaddleRS/blob/develop/docs/apis/data.md
 train_transforms = T.Compose([
+    # 读取影像
+    T.DecodeImg(),
     # 随机翻转和旋转
     T.RandomFlipOrRotate(
         # 以0.35的概率执行随机翻转，0.35的概率执行随机旋转
@@ -28,13 +30,16 @@ train_transforms = T.Compose([
         probsr=[0.33, 0.34, 0.33]),
     # 将数据归一化到[-1,1]
     T.Normalize(
-        mean=[0.5, 0.5, 0.5], std=[0.5, 0.5, 0.5])
+        mean=[0.5, 0.5, 0.5], std=[0.5, 0.5, 0.5]),
+    T.ArrangeChangeDetector('train')
 ])
 
 eval_transforms = T.Compose([
+    T.DecodeImg(),
     # 验证阶段与训练阶段的数据归一化方式必须相同
     T.Normalize(
-        mean=[0.5, 0.5, 0.5], std=[0.5, 0.5, 0.5])
+        mean=[0.5, 0.5, 0.5], std=[0.5, 0.5, 0.5]),
+    T.ArrangeChangeDetector('eval')
 ])
 
 # 分别构建训练、验证和测试所用的数据集

requirements.txt

@@ -15,9 +15,9 @@ opencv-contrib-python <= 4.3.0.28
 openpyxl
 # paddlepaddle >= 2.2.0
 # paddlepaddle-gpu >= 2.2.0
-paddleslim >= 2.2.1
+paddleslim >= 2.2.1, < 2.3.5
 pandas
-protobuf >= 3.1.0, <= 3.20.0
+protobuf >= 3.1.0, <= 3.20.3
 pycocotools
 # pydensecrf
 scikit-learn