fix docs

README.md

@@ -9,9 +9,9 @@
 </p>
 
 
-<p align= "center"> PaddleX -- PaddlePaddle End-to-End Development Toolkit, 
+<p align= "center"> PaddleX -- PaddlePaddle End-to-End Development Toolkit,
   enables developers to implement real industry projects in a low-code form quickly </p>
-  
+
 [![License](https://img.shields.io/badge/license-Apache%202-red.svg)](LICENSE) [![Version](https://img.shields.io/github/release/PaddlePaddle/PaddleX.svg)](https://github.com/PaddlePaddle/PaddleX/releases) ![python version](https://img.shields.io/badge/python-3.6+-orange.svg) ![support os](https://img.shields.io/badge/os-linux%2C%20win%2C%20mac-yellow.svg)
  ![QQGroup](https://img.shields.io/badge/QQ_Group-1045148026-52B6EF?style=social&logo=tencent-qq&logoColor=000&logoWidth=20)
 
@@ -52,7 +52,13 @@ Please refer to the [PaddleX installation](https://paddlex.readthedocs.io/zh_CN/
 
 2. **Padlde GUI(Graphical Ueser Interface) mode:**
 
-It's a all-in-one client enable develops could implement deep learning projects without code. 
+<<<<<<< HEAD
+It's a all-in-one client enable develops could implement deep learning projects without code.
+=======
+3. **PaddleX Restful:**  
+  使用基于RESTful API开发的GUI与Web Demo实现远程的深度学习全流程开发；同时开发者也可以基于RESTful API开发个性化的可视化界面
+- 前往[PaddleX RESTful API使用教程](./docs/restful/introduction.md)
+>>>>>>> dae8c7c... fix docs
 
 - Go to [PaddleX Official Website](https://www.paddlepaddle.org.cn/paddle/paddlex) to download the all-in-one client.
 
@@ -81,7 +87,14 @@ It's a all-in-one client enable develops could implement deep learning projects
 
 ### Examples of Online Projects
 
+<<<<<<< HEAD
 To get developers up to speed with the PaddleX API, we've created a complete series of sample tutorials that you can run PaddleX projects online through the **AIStudio** quickly.
+=======
+- [10分钟快速上手系列教程](https://paddlex.readthedocs.io/zh_CN/develop/quick_start.html)
+- [PaddleX模型训练教程集合](https://paddlex.readthedocs.io/zh_CN/develop/train/index.html)
+- [PaddleX API接口说明](https://paddlex.readthedocs.io/zh_CN/develop/apis/index.html)
+- [PaddleX RESTful API说明](https://paddlex.readthedocs.io/zh_CN/develop/restful/introduction.html)
+>>>>>>> dae8c7c... fix docs
 
 - [PaddleX Quick Start - CV Model Training](https://aistudio.baidu.com/aistudio/projectdetail/450925)
 - [PaddleX Quick Start - MobileNetV3-ssld Cosmetics Classification](https://aistudio.baidu.com/aistudio/projectdetail/450220)

docs/index.rst

@@ -74,16 +74,24 @@ PaddleX是基于飞桨核心框架、开发套件和工具组件的深度学习
    gui/download.md
    gui/how_to_use.md
    gui/FAQ.md
-   gui/introduction_restful.md
-   gui/quick_start.md
-   gui/restful_api.md
-   gui/data_struct.md
-   gui/tree.md
 
 
 .. toctree::
    :maxdepth: 1
-   :caption: 8. 附录
+   :caption: 8. RESTful API使用
+
+   
+   restful/introduction.md
+   restful/restful.md
+   restful/quick_start.md
+   restful/restful_api.md
+   restful/data_struct.md
+   restful/tree.md
+
+
+.. toctree::
+   :maxdepth: 1
+   :caption: 9. 附录
 
    apis/index.rst
    appendix/model_zoo.md

docs/gui/data_struct.md → docs/restful/data_struct.md

@@ -121,9 +121,10 @@ TaskStatus = Enum('TaskStatus',
 'XPRUNEING', #裁剪分析任务运行中
 'XPRUNETRAIN'#裁剪训练任务运行中
 ),start=0)
-
 ```
 ### ProjectType(项目类型)
+
+```
 ProjectType = Enum('ProjectType',
 ('classification',#分类
 'detection',#检测
@@ -131,16 +132,22 @@ ProjectType = Enum('ProjectType',
 'instance_segmentation',#实例分割
 'remote_segmentation'#摇杆分割
 ),start=0)
+```
 
 ### DownloadStatus(下载状态变量)
+
+```
 DownloadStatus = Enum('DownloadStatus',
 ('XDDOWNLOADING',#下载中
 'XDDOWNLOADFAIL',#下载失败
 'XDDOWNLOADDONE',下载完成
 'XDDECOMPRESSED'解压完成
 ),start=0)
+```
+
 
 ### PruneStatus(裁剪状态变量)
+
 ```
 PruneStatus = Enum('PruneStatus',
 ('XSPRUNESTART',#启动裁剪任务
@@ -152,6 +159,7 @@ PruneStatus = Enum('PruneStatus',
 ```
 
 ### PredictStatus(预测任务状态变量)
+
 ```
 PredictStatus = Enum('PredictStatus',
 ('XPRESTART',#预测开始
@@ -160,12 +168,15 @@ PredictStatus = Enum('PredictStatus',
 ), start=0)
 ```
 ### PretrainedModelStatus(预训练模型状态变量)
+
+```
 PretrainedModelStatus = Enum('PretrainedModelStatus',
 ('XPINIT', #初始化
 'XPSAVING', #正在保存
 'XPSAVEFAIL',#保存失败
 'XPSAVEDONE' #保存完成
 ),start=0)
+```
 
 ### ExportedModelType(模型导出状态变量)
 ```

docs/restful/index.rst

@@ -0,0 +1,50 @@
+
+PaddleX RESTful
+=======================================
+
+PaddleX RESTful是基于PaddleX开发的RESTful API。
+
+对于开发者来说通过如下指令启动PaddleX RESTful服务，开启RESTful服务后可以通过下载Remote版本的GUI或者是web demo连接开启RESTful服务的服务端完成深度学习全流程开发。
+
+同样您还可以根据RESTful API来开发自己的可视化界面。
+
+**paddlex --start_restful --port [端口号] --workspace_dir [工作空间地址]**
+
+支持RESTful版本的GUI
+---------------------------------------
+
+支持RESTful版本的GUI是针对PaddleX RESTful开发的可视化客户端。开发者可以通过客户端连接开启RESTful服务的服务端，通过GUI远程的实现深度学习全流程：**数据处理** 、 **超参配置** 、 **模型训练及优化** 、 **模型发布**，无需开发一行代码，即可得到高性深度学习推理模型。
+
+
+支持RESTful版本Web Demo
+---------------------------------------
+
+支持RESTful版本Web Demo是针对PaddleX RESTful开发的网页版可视化客户端。开发者可以通过Web Demo连接开启RESTful服务的服务端，远程实现深度学习全流程：**数据处理** 、 **超参配置** 、 **模型训练及优化** 、 **模型发布**，无需开发一行代码，即可得到高性深度学习推理模型。
+
+PaddleX RESTful API 二次开发
+---------------------------------------
+
+开发者可以使用PaddleX RESTful API 进行二次开发，按照自己的需求开发可视化界面
+
+
+
+.. toctree::
+   :maxdepth: 2
+   :caption: 文档目录
+   
+   introduction.md
+   restful.md
+   quick_start.md
+   restful_api.md
+   data_struct.md
+   tree.md
+
+
+* 项目官网: http://www.paddlepaddle.org.cn/paddle/paddlex  
+* 项目GitHub: https://github.com/PaddlePaddle/PaddleX/tree/develop  
+* 官方QQ用户群: 1045148026  
+* GitHub Issue反馈: http://www.github.com/PaddlePaddle/PaddleX/issues
+
+
+
+

docs/gui/introduction.md → docs/restful/introduction.md

@@ -1,7 +1,19 @@
-# PaddleX RESTful介绍与使用
+# 介绍与使用
 PaddleX RESTful是基于PaddleX开发的RESTful API。  
 
+<<<<<<< HEAD:docs/gui/introduction.md
 对于开发者来说通过如下指令启动PaddleX RESTful服务，开启RESTful服务后可以通过下载Remote版本的GUI或者是web demo连接开启RESTful服务的服务端完成深度学习全流程开发。  
+=======
+对于开发者来说可以通过如下指令启动PaddleX RESTful服务  
+**paddlex --start_restful --port [端口号] --workspace_dir [工作空间地址]**
+
+开启RESTful服务后可以实现如下功能：
+
+- 通过下载基于RESTful API的GUI连接开启RESTful服务的服务端，实现远程深度学习全流程开发。
+- 通过使用web demo连接开启RESTful服务的服务端，实现远程深度学习全流程开发。
+- 根据RESTful API来开发您自己个性化的可视化界面。  
+
+>>>>>>> dae8c7c... fix docs:docs/restful/introduction.md
 
 同样您还可以根据RESTful API来开发自己的可视化界面。  
 
@@ -15,7 +27,7 @@ PaddleX Remote GUI是针对PaddleX RESTful开发的可视化客户端。开发
 
 ### 客户端使用流程
 
-#### step1：安装paddlex  
+#### step1：安装PaddleX  
 ```
 pip install paddlex
 ```  
@@ -29,6 +41,7 @@ pip install pycuda
 paddlex --start_restful --port [端口号] --workspace_dir [工作空间地址]
 ```
 
+<<<<<<< HEAD:docs/gui/introduction.md
 #### setp3：根据上面的连接下载Remote版本的客户端
 
 #### step4：运行客户端、如图所示填写开启RESTful后端的ip与端口,点击确定遍可正常使用GUI
@@ -38,6 +51,17 @@ paddlex --start_restful --port [端口号] --workspace_dir [工作空间地址]
 ## PaddleX Web Demo
 PaddleX Web Demo是针对PaddleX RESTful开发的web可视化客户端。
 [Wed demo](../../paddlex/restful/frontend_demo/paddlex_restful_demo.html)
+=======
+#### setp3：根据上面的链接下载支持RESTful版本的GUI
+
+#### step4：运行客户端，如图所示填写开启RESTful后端的ip与端口，点击确定便可正常使用GUI
+![](./img/gui_use.png)
+
+
+## PaddleX Web Demo
+PaddleX Web Demo是针对PaddleX RESTful开发的Web可视化客户端。  
+[Wed demo传送门](https://github.com/PaddlePaddle/PaddleX/blob/develop/paddlex/restful/frontend_demo/paddlex_restful_demo.html)
+>>>>>>> dae8c7c... fix docs:docs/restful/introduction.md
 
 ### Web DEMO使用流程
 
@@ -55,10 +79,18 @@ pip install pycuda
 paddlex --start_restful --port [端口号] --workspace_dir [工作空间地址]
 ```
 
+<<<<<<< HEAD:docs/gui/introduction.md
 #### step3：通过浏览器打开demo文件
 
 
 #### step4：点击设置服务器信息，填写正确的后端ip与端口
+=======
+#### step3：通过浏览器打开[Demo](https://github.com/PaddlePaddle/PaddleX/blob/develop/paddlex/restful/frontend_demo/paddlex_restful_demo.html)文件
+
+
+#### step4：点击设置服务器信息，填写正确的后端ip与端口
+![](./img/web_demo.png)
+>>>>>>> dae8c7c... fix docs:docs/restful/introduction.md
 
 ## PaddleX RESTful API 二次开发
 开发者可以使用PaddleX RESTful API 进行二次开发，按照自己的需求开发可视化界面，详细请参考以下文档  

docs/gui/quick_start.md → docs/restful/quick_start.md

@@ -6,25 +6,25 @@
 - pycocotools  
 
 
-## 服务端启动PaddleX Restful服务
+## 服务端启动PaddleX RESTful服务
 ```
  paddlex --start_restful --port [端口号] --workspace_dir [工作空间目录]
 ```  
 
-## 客服端请求服务端
+## 客户端请求服务端
 ```
 import requests
 url = "https://127.0.0.1:5000"
 ```
-- url为实际服务端ip
+- url为实际服务端ip与端口
 - 所有的请求，通过ret.status_code是否为200，判断是否正确给Server执行
 - 在status_code为200的前提下，如果ret.json()['status']为-1，则表明出错，出错信息在ret.json()['message']里面，如果执行成功， status是1
 
 ## 创建一个PaddleX的训练任务  
-**下面介绍如何通过api创建一个PaddleX的训练任务，对于每个restful api的详细的输入参数与返回请参考[api 接口文档](./restful_api.md)，对于示例中用到自定的数据结构请参考[数据结构](./data_struct.md)**
+**下面介绍如何通过API完成模型的训练、评估、预测与导出，对于每个RESTful API的详细介绍请参考[API 接口文档](./restful_api.md)，对于示例中用到自定的数据结构请参考[数据结构](./data_struct.md)**
 
 ### 流程
-对于通过restful api创建一个PaddleX的训练任务的主要流程如下
+对于通过RESTful API创建一个PaddleX的训练任务的主要流程如下
 - 1)：创建并导入数据集
 - 2)：创建项目并绑定数据集
 - 3)：获取参数并创建任务

docs/gui/restful.md → docs/restful/restful.md

@@ -1,12 +1,12 @@
-# RESTful API 二次开发简介
-如图，PaddleX Restful主要由数据集(dataset)，项目(project)，任务(task)，模型(model)组成。上述模块数据保存在指定的工作空间(workspace)内，相应的结构化信息通过protobuf保存，[workspace的protobuf消息定义](./data_struct.md#Protobuf结构化数据)。  
+# 二次开发简介
+如图，PaddleX Restful主要由数据集(dataset)，项目(project)，任务(task)，模型(model)组成。上述模块数据保存在指定的工作空间(workspace)内，相应的结构化信息通过protobuf保存，[workspace的protobuf消息定义](./data_struct.md)。  
 
-![alt](./img/framework.png)  
+![](./img/framework.png)  
 
 **说明**：后续restful api通过`[Http request method] url`来表示  
 
 ## 流程介绍
-对于通过Restful接口来进行二次开发，主要的流程如下：
+对于通过RESTtful接口来进行二次开发，主要的流程如下：
 - 1）：指定工作空间启动restful服务
 - 2）：创建、导入并切分数据到数据集
 - 3）：创建项目，绑定数据集到该项目，并根据项目类型获取训练的默认参数
@@ -16,27 +16,27 @@
 
 ## 工作空间
 
-通过如下命令在启动paddlex的restful服务时指定工作空间同时初始化工作空间，初始化工作空间主要做载入工作空间内已有的数据集、项目等模块的信息。初始化工作空间后就可以正常调用其他的restful api，所有新建的数据集、项目等数据都会保存在此工作空间目录下面  
+通过如下命令启动PaddleX的RESTful服务，同时会初始化工作空间，初始化工作空间主要做载入工作空间内已有的数据集、项目等模块的信息。初始化工作空间后就可以正常调用其他的RESTful API，所有新建的数据集、项目等数据都会保存在此工作空间目录下面  
 ```
  paddlex --start_restful --port [端口号] --workspace_dir [工作空间目录]
 ```  
 
 
 ## 数据集
-可以通过调用["[post] /dataset"](./restful_api.md)接口创建数据集、创建数据集后会在工作空间内创建相应的文件夹，并保存数据集信息到按照workspace protobuf定义的变量中存储。创建数据集后可以通过["[put] \dataset"](./restful_api.md)接口导入数据集，目前仅支持从路径导入且数据集必须储存在后端。目前支持图像分类、目标检测、语义分割与实例分割四种数据集，具体格式如下  
+可以通过调用["[post] /dataset"](./restful_api.md)接口创建数据集、创建数据集后会在工作空间内创建相应的文件夹，按照workspace protobuf定义的变量保存数据集信息。创建数据集后可以通过["[put] \dataset"](./restful_api.md)接口导入数据集，目前仅支持从路径导入并且数据集需储存在后端服务器。目前支持图像分类、目标检测、语义分割与实例分割四种数据集，具体格式如下  
 ### 图像分类
 如图所示
 - 文件夹名为需要分类的类名，输入限定为英文字符，不可包含：空格、中文或特殊字符；
 - 图片格式支持png，jpg，jpeg，bmp格式  
 
-![alt](./img/classify_help.jpg)
+![](./img/classify_help.jpg)
 
 ### 目标检测
 如图所示
 - 图片文件名需要为"JPEGImages"，标签文件夹命名需要为"Annotations"
 - 图片格式支持png，jpg，jpeg，bmp格式；标签文件格式为.xml  
 
-![alt](./img/detect_help.jpg)
+![](./img/detect_help.jpg)
 
 ### 语义分割
 如图所示
@@ -45,7 +45,7 @@
 - 标注需要与图片像素严格保持一一对应，格式只可为png。每个像素值需标注为[0,255]区间从0开始依序递增整数ID，除255外，标注ID值的增加不能跳跃。其中255表示模型中需忽略的像素，0为背景类标注。
 - (可选)可以提供一份命名为"labels.txt"的包含所有标注名的清单  
 
-![alt](./img/seg_help.jpg)
+![](./img/seg_help.jpg)
 
 
 ### 实例分割
@@ -53,17 +53,17 @@
 - 图片文件名需要为"JPEGImages"，标签文件名需要为"annotations.json"
 - 图片格式支持png，jpg，jpeg，bmp格式；标签文件格式为.json  
 
-![alt](./img/ins_seg_help.jpg)
+![](./img/ins_seg_help.jpg)
 
 ## 项目
-可以通过调用["[post] /project"](./restful_api.md)接口创建项目，目前支持的项目类型有分类(classification)、检测(detection)、语义分割(segmentation)、示例分割(instance_segmentation)、摇杆分割(remote_segmentation)。对于新建的项目首先需要绑定项目类型对应的数据集，通过["[post] \workspace"](./restful_api.md)可以实现，注意对于摇杆分割项目数据集按照语义分割格式处理即可。一个项目可以包含多个任务。  
+可以通过调用["[post] /project"](./restful_api.md)接口创建项目，目前支持的项目类型有分类(classification)、检测(detection)、语义分割(segmentation)、实例分割(instance_segmentation)。对于新建的项目首先需要绑定项目类型对应的数据集，通过["[post] \workspace"](./restful_api.md)可以实现；然后便可以在项目下创建任务，进行一系列任务相关的操作。  
 
 ## 任务
-在创建项目后,首先需要通过["[get] /project/task/params"](./restful_api.md)获得默认的训练参数,可以通过调用["[post] /project/task"](./restful_api.md)接口在项目中创建任务，目前任务可以包括：
+在创建项目后,首先需要通过["[get] /project/task/params"](./restful_api.md)获得默认的训练参数,可以通过调用["[post] /project/task"](./restful_api.md)接口在项目中创建任务，创建好任务后可以通过API实现以下功能：
 - 训练(train):进行模型的训练
 - 裁剪(prune):对训练好的模型模型进行裁剪
 - 评估(eval):对训练好的模型进行评估
 - 预测(predict):用训练好的模型进行预测，目前仅支持单张图片的预测
 
 ## 模型
-目前PaddleX restful api支持将训练评估后的模型保存为预训练模型、导出inference模型、导出Padlle-lite模型、同时能支持模型的量化，可以通过调用["[post] /model](./restful_api.md)接口来完成这些功能
+目前PaddleX RESTful API支持将训练评估后的模型保存为预训练模型、导出inference模型、导出Padlle-Lite模型、同时能支持模型的量化，可以通过调用["[post] /model](./restful_api.md)接口来完成这些功能

docs/gui/restful_api.md → docs/restful/restful_api.md

@@ -1,7 +1,11 @@
 # RestFUL API 参考文档
 ## API 总览
 ![](./img/restful_api.png)
+<<<<<<< HEAD:docs/gui/restful_api.md
 图片包含目前PaddleX restful模块提供所有的restful api以及api支持的https请求方式：
+=======
+图片包含目前PaddleX RESTful模块提供所有的RESTful API:
+>>>>>>> dae8c7c... fix docs:docs/restful/restful_api.md
 
 - /workspace: 工作空间相关
 - /dataset：数据集操作
@@ -12,9 +16,9 @@
 - /demo: 示例
 
 
-## api 接口文档
+## API 接口文档
 **说明**：
-- 后续例子中https请求通过requests完成，url代表运行paddlex restful服务的主机ip
+- 后续例子中HTTP请求通过requests完成，url代表运行PaddleX RESTful服务的主机ip与端口号
 - 所有的请求，通过ret.status_code是否为200，判断是否正确给Server执行
 - 在status_code为200的前提下，如果ret.json()['status']为-1，则表明出错，出错信息在ret.json()['message']里面，如果执行成功， status是1
 
@@ -23,7 +27,7 @@
 主要是对工作空间的结构化信息进行操作，包括修改合和获取工作空间中数据集、项目、任务的属性
 - GET请求：获取workspace中数据集、项目、任务、模型的属性
 - PUT请求：修改workspace中数据集、项目、任务、模型的属性，对于创建项目之后我们需求通过该接口将数据集与项目绑定才能进行训练任务
-对于可以获取和修改的属性请参考[Protobuf结构化数据](./data_struct.md#Protobuf结构化数据)  
+对于可以获取和修改的属性请参考[Protobuf结构化数据](./data_struct.md)  
 
 ```
 methods=='GET':获取工作目录中项目、数据集、任务的属性
@@ -64,15 +68,14 @@ methods=='PUT':修改工作目录中项目、数据集、任务的属性
 
 
 
-### /dataset
+### /dataset [GET,POST,PUT,DELETE]
 对数据集进行操作，包括创建、导入、查询、删除数据集的功能
 - POST请求:创建数据集，创建时需要指定数据集类型可以是['classification', 'detection', 'segmentation','instance_segmentation']中的一种
 - GET请求:创建好数据集后，可以通过GET请求获取数据集信息，目前支持获取单个或者所有数据集的信息
 - PUT请求:导入数据集，创建数据集后并没有真实的数据与数据集关联，需要通过导入功能，将数据导入到工作空间内，需要导入的数据集必须按照
 - DELETE:删除一个数据集  
-DatasetStatus定义了数据集状态，具体请参考[数据集状态变量](./data_struct.md#状态枚举变量)  
+DatasetStatus定义了数据集状态，具体请参考[数据集状态变量](./data_struct.md)  
 
-methods = [GET,POST,PUT,DELETE]
 ```
 methods=='GET':获取所有数据集或者单个数据集的信息
 	Args：
@@ -316,7 +319,7 @@ methods=='DELETE':删除一个项目，以及项目相关的task
 - POST请求:创建一个任务可以是训练任务也可以是剪裁任务，剪裁任务需要指定parent_id
 - GET请求: 获取单个任务、单个项目内所有任务、所有任务的信息，当tid存在时返回指定任务的信息，如果任务状态(TaskStatus)显示任务停止可以通过resume查询任务是否可以恢复训练以及保存的最大epoch；当pid存在时返回该项目下面所有任务信息
 - DELETE请求:删除任务  
-TaskStatus定义了任务状态，具体请参考[任务状态变量](./data_struct.md#状态枚举变量)  
+TaskStatus定义了任务状态，具体请参考[任务状态变量](./data_struct.md)  
 
 ```
 methods=='GET':#获取某个任务的信息或者所有任务的信息
@@ -455,7 +458,7 @@ methods=='PUT':#改变任务训练的状态，即终止训练或者恢复训练
 - GET请求:获取剪裁任务状态信息
 - POST请求:创建剪裁分析任务，异步操作
 - PUT请求:停止正在进行的剪裁分析任务  
-PruneStatus定义了裁剪分析任务状态，具体请参考[裁剪分析状态变量](./data_struct.md#状态枚举变量)  
+PruneStatus定义了裁剪分析任务状态，具体请参考[裁剪分析状态变量](./data_struct.md)  
 
 ```
 methods=='GET':#获取剪裁任务的状态
@@ -565,7 +568,7 @@ methods=='GET':#获取日志数据
 - POST请求:创建一个预测任务、图片输入需要先进行base64编码、异步操作
 - GET请求:获取预测任务的状态
 - PUT请求:停止一个预测任务
-PredictStatus定义了预测任务状态变量，具体请参考[预测任务状态变量](./data_struct.md#状态枚举变量)  
+PredictStatus定义了预测任务状态变量，具体请参考[预测任务状态变量](./data_struct.md)  
 
 ```
 methods=='GET':#获取预测状态