Merge pull request #1188 from FlyingQianMM/develop_qh

update FAQ

docs/FAQ/FAQ.md

@@ -5,15 +5,16 @@
 - [推理部署问题](#推理部署问题)
 
 ## GUI相关问题
-**Q:**  GUI卡死后怎么解决？
+
+### Q1:  GUI在使用过程中卡死该怎么解决？
 
 **A:**  卡死后点击一下这个按钮即可恢复正常。
 <p align="center">
-  <img src="./images/FAQ1.png"  alt="QR" align="middle" />
+  <img src="./images/gui_FAQ1.png"  alt="QR" align="middle" />
 </p>
 
 
-**Q:**  GUI训练时报错怎么办？
+### Q2:  GUI训练时报错怎么办？
 
 **A:**  首先打开当前项目的日志文件，查看报错信息。
 
@@ -23,39 +24,89 @@
 
 查看上述三个日志文件，基本可以定位出是否是显存不足、或者是数据路径不对等问题。如果是显存不足，请调低batch_size（需同时按比例调低学习率等参数）。其他无法解决的问题，可以前往GitHub[提ISSUE](https://github.com/PaddlePaddle/PaddleX/issues)，描述清楚问题会有工程师及时回复。
 
+### Q3: GUI卡死在启动界面，但之前可以正常使用
+
+GUI之前可以正常使用，但是本次运行一直处于启动界面，无法进入到主界面，如下所示：
+
+<p align="center">
+  <img src="./images/gui_FAQ3.png" width = "400" alt="QR" align="middle" />
+</p>
+
+**A:** 可以尝试先删除PaddleX GUI的日志目录，例如`C:/User/User_name/.paddlex`，然后再重新更新打开GUI。
+
+
+### Q4: 如何及时更新PaddleX GUI 2.0内置的PaddleX API？
+
+**A:** 在PaddleX GUI 2.0的执行文件`PaddleX.exe`的同级目录下有个名为`paddlex`的文件夹，请将该文件夹替换成PaddleX github develop分支下的paddlex，即https://github.com/PaddlePaddle/PaddleX/tree/develop/paddlex。
+
+### Q5: PaddleX GUI 2.0如何无缝切换PaddleX API训练？
+
+**A:** 在PaddleX GUI 2.0中已经生成的项目，如果想要换成PaddleX API进行训练，可进行如下步骤：
+
+1. 找到该项目所在的工作空间，例如`D:/work_space/projects/P0001/T0001/`，该路径下有个名为`script.py`的训练脚本，此脚本包含该项目中的数据集路径和模型参数设置
+2. 安装PaddleX API，参考[安装文档](../install.md#1-paddlex-api开发模式安装)
+3. 开启终端，进入到`script.py`所在路径（例如`D:/work_space/projects/P0001/T0001/`），然后运行训练脚本：
+```
+python script.py
+```
+
+### Q6: Exception: A space is defined as the separator, but it exists in image or label name ...
+
+**A:** 图片路径里面存在空格，因为空格作为图片和标注文件之间的空格符，所以需要把路径里的空格删掉。另外需要注意，路径中不要有中文
+
+
 ## API训练相关问题
-**Q:**  loss为nan时怎么办？
+
+### Q1: loss为nan时怎么办？
 
 **A:**  loss为nan表示梯度爆炸，导致loss为无穷大。这时候，需要将学习率（learning rate）调小，或者增大批大小（batch_size）。
 
 
-**Q:**  YOLO系列为什么要训练这么久？
+### Q2:  YOLO系列为什么要训练这么久？
 
 **A:**  像yolo系列的数据增强比较多，所以训练的epoch要求要多一点，具体在不同的数据集上的时候，训练参数需要调整一下。比如我们先前示例给出ppyolo，ppyolov2的训练参数都是针对COCO数据集换算到单卡上的配置，但是在昆虫这份数据集上的效果并不好，后来我们进行了调整，您可以参考我们调整的参数相应调整自己的参数，具体调了哪些可以看我们之前的[pr](https://github.com/PaddlePaddle/PaddleX/pull/853/files)。
 
 
-**Q:**  用命令行跑 `.\paddlex_inference\detector.exe` 这个指令没有什么提示，也没有输出，怎么回事？
+### Q3: windows下shapely报错：lgeos = CDLL(os.path.join(sys.prefix, 'Library', 'bin', 'geos_c.dll')) OSError: [WinError 126] 找不到指定的模块
 
-**A:**  可能是缺少dll，双击执行一下out目录下的detector.exe或model_infer.exe，会有提示。
+**A:** windows上，在conda环境内通过pip install shapely后会出现该问题，具体可以看shapely issue [Toblerity/Shapely#1032](https://github.com/Toblerity/Shapely/issues/1032)。解决办法：
+
+1. 卸载pip安装的shapely
+
+```
+pip uninstall shapely
+```
+
+2. 然后用conda安装
+
+```
+conda install shapely==1.7.1
+
+```
 
 
 ## 推理部署问题
-**Q:**  如何在程序中手动释放inference model和占用的显存?
+
+### Q1:  如何在程序中手动释放inference model和占用的显存?
 
 **A:**  在主进程中初始化predictor，然后在线程里完成图片的预测，这样使用是没有问题的。线程退出后显存不会释放，主进程退出才会释放显存。线程退出后，后续显存是可以复用的，不会一直增长。
 
 
-**Q:**  提高预测速度的策略都有哪些？
+### Q2:  提高预测速度的策略都有哪些？
 
 **A:**  1. 可以考虑使用更加轻量的backbone；看看图像预处理和预测结果后处理有没有优化空间；相比于python推理预测，用C++会更快；同时对批量图片进行预测；可以尝试使用加速库，例如在CPU上部署时可以开启mkdldnn，或者使用用OpenVINO推理引擎加速性能，在Nvidia GPU上部署时可以使用TensorRT加速性能；
 2. 在测试性能时，需要注意给模型进行预热，例如先让模型预测100轮之后，再开始进行性能测试和记录，这样得到的性能指标才准确。
 
 
-**Q:**  预测结果如何可视化？
+### Q3:  预测结果如何可视化？
 
 **A:**  检测结果可以用`pdx.det.visualize`，分割结果可以用`pdx.seg.visualize`，API说明见[文档](https://github.com/PaddlePaddle/PaddleX/blob/develop/docs/apis/prediction.md)
 
 
-**Q:**  如何用旧的部署代码部署新的模型？
+### Q4:  如何用1.x的部署代码部署2.0的模型？
 
-**A:**  2.0版本的cpp部署支持新旧版本的paddlex/gui导出的模型进行部署， 但是python不兼容。 GUI新旧版本也不兼容， 新版本只能加载新版本训练的模型。
+**A:**  2.0版本的cpp部署支持新旧版本的paddlex/gui导出的模型进行部署，但是2.0版本的python部署目前不兼容1.x版本模型。2.0版本PaddleX GUI/API的训练功能对1.x版本也不兼容，1.x版本的训练脚本和模型只能安装1.x版本的PaddleX才能正常运行。
+
+### Q5:  用命令行跑 `.\paddlex_inference\detector.exe` 这个指令没有什么提示，也没有输出，是怎么回事？
+
+**A:**  可能是缺少dll，双击执行一下out目录下的detector.exe或model_infer.exe，会有提示。

docs/install.md

@@ -59,6 +59,7 @@ github代码会跟随开发进度不断更新，可以安装develop分支的代
 ```commandline
 git clone https://github.com/PaddlePaddle/PaddleX.git
 cd PaddleX
+git checkout develop
 pip install -r requirements.txt
 python setup.py install
 ```

paddlex/cls.py

@@ -15,9 +15,12 @@
 import sys
 from . import cv
 
-message = 'Your running script needs PaddleX<2.0.0, please refer to {} to solve this issue.'.format(
-    'https://github.com/PaddlePaddle/PaddleX/tree/release/2.0-rc/tutorials/train#%E7%89%88%E6%9C%AC%E5%8D%87%E7%BA%A7'
-)
+
+message = 'Your script can be run normally only under PaddleX<2.0.0 ' + \
+    'but the installed PaddleX version is greater than or equal to 2.0.0, ' + \
+    'the solution is writen in the link {}, please refer to this link ro solve this issue.'.format(
+        'https://github.com/PaddlePaddle/PaddleX/tree/develop/tutorials/train#%E7%89%88%E6%9C%AC%E5%8D%87%E7%BA%A7'
+    )
 
 
 def __getattr__(attr):

paddlex/det.py

@@ -17,9 +17,12 @@ from . import cv
 from .cv.models.utils.visualize import visualize_detection, draw_pr_curve
 from .cv.models.utils.det_metrics.coco_utils import coco_error_analysis
 
-message = 'Your running script needs PaddleX<2.0.0, please refer to {} to solve this issue.'.format(
-    'https://github.com/PaddlePaddle/PaddleX/tree/release/2.0-rc/tutorials/train#%E7%89%88%E6%9C%AC%E5%8D%87%E7%BA%A7'
-)
+
+message = 'Your script can be run normally only under PaddleX<2.0.0 ' + \
+    'but the installed PaddleX version is greater than or equal to 2.0.0, ' + \
+    'the solution is writen in the link {}, please refer to this link ro solve this issue.'.format(
+        'https://github.com/PaddlePaddle/PaddleX/tree/develop/tutorials/train#%E7%89%88%E6%9C%AC%E5%8D%87%E7%BA%A7'
+    )
 
 
 def __getattr__(attr):

paddlex/seg.py

@@ -16,9 +16,12 @@ import sys
 from . import cv
 from .cv.models.utils.visualize import visualize_segmentation
 
-message = 'Your running script needs PaddleX<2.0.0, please refer to {} to solve this issue.'.format(
-    'https://github.com/PaddlePaddle/PaddleX/tree/release/2.0-rc/tutorials/train#%E7%89%88%E6%9C%AC%E5%8D%87%E7%BA%A7'
-)
+
+message = 'Your script can be run normally only under PaddleX<2.0.0 ' + \
+    'but the installed PaddleX version is greater than or equal to 2.0.0, ' + \
+    'the solution is writen in the link {}, please refer to this link ro solve this issue.'.format(
+        'https://github.com/PaddlePaddle/PaddleX/tree/develop/tutorials/train#%E7%89%88%E6%9C%AC%E5%8D%87%E7%BA%A7'
+    )
 
 
 def __getattr__(attr):