From 29838a68733d840813428fa3966d44ed5c45f264 Mon Sep 17 00:00:00 2001
From: qingqing01 <dangqingqing@baidu.com>
Date: Mon, 8 Jun 2020 17:14:00 +0800
Subject: [PATCH] Add Python version description for ViualDL (#896)

---
 docs/tutorials/QUICK_STARTED.md    | 23 +++++++++++++++++++----
 docs/tutorials/QUICK_STARTED_cn.md | 27 +++++++++++++++++++++++----
 2 files changed, 42 insertions(+), 8 deletions(-)

diff --git a/docs/tutorials/QUICK_STARTED.md b/docs/tutorials/QUICK_STARTED.md
index 2f8a64cc0..96adefb61 100644
--- a/docs/tutorials/QUICK_STARTED.md
+++ b/docs/tutorials/QUICK_STARTED.md
@@ -20,6 +20,14 @@ python dataset/fruit/download_fruit.py
 
 Training:
 
+```bash
+python -u tools/train.py -c configs/yolov3_mobilenet_v1_fruit.yml --eval
+```
+
+Use `yolov3_mobilenet_v1` to fine-tune the model from COCO dataset.
+
+Meanwhile, loss and mAP can be observed on VisualDL by set `--use_vdl` and `--vdl_log_dir`. But note  Python version required >= 3.5 for VisualDL.
+
 ```bash
 python -u tools/train.py -c configs/yolov3_mobilenet_v1_fruit.yml \
                         --use_vdl=True \
@@ -27,7 +35,7 @@ python -u tools/train.py -c configs/yolov3_mobilenet_v1_fruit.yml \
                         --eval
 ```
 
-Use `yolov3_mobilenet_v1` to fine-tune the model from COCO dataset. Meanwhile, loss and mAP can be observed on VisualDL.
+Then observe the loss and mAP curve through VisualDL command:
 
 ```bash
 visualdl --logdir vdl_fruit_dir/scalar/ --host <host_IP> --port <port_num>
@@ -35,7 +43,9 @@ visualdl --logdir vdl_fruit_dir/scalar/ --host <host_IP> --port <port_num>
 
 Result on VisualDL is shown below:
 
-![visualdl_fruit.jpg](../images/visualdl_fruit.jpg)
+<div align="center">
+  <img src='../images/visualdl_fruit.jpg' width='800'>
+</div>
 
 Model can be downloaded [here](https://paddlemodels.bj.bcebos.com/object_detection/yolov3_mobilenet_v1_fruit.tar)
 
@@ -55,8 +65,13 @@ python -u tools/infer.py -c configs/yolov3_mobilenet_v1_fruit.yml \
 
 Inference images are shown below:
 
+<div align="center">
+  <img src='../../demo/orange_71.jpg' width='600'>
+</div>
+
 
-![orange_71.jpg](../../demo/orange_71.jpg)
-![orange_71_detection.jpg](../images/orange_71_detection.jpg)
+<div align="center">
+  <img src='../images/orange_71_detection.jpg' width='600'>
+</div>
 
 For detailed infomation of training and evalution, please refer to [GETTING_STARTED.md](GETTING_STARTED.md).
diff --git a/docs/tutorials/QUICK_STARTED_cn.md b/docs/tutorials/QUICK_STARTED_cn.md
index 607f0e136..3ba96e90e 100644
--- a/docs/tutorials/QUICK_STARTED_cn.md
+++ b/docs/tutorials/QUICK_STARTED_cn.md
@@ -22,6 +22,16 @@ python dataset/fruit/download_fruit.py
 
 训练命令如下：
 
+```bash
+python -u tools/train.py -c configs/yolov3_mobilenet_v1_fruit.yml --eval
+```
+
+训练使用`yolov3_mobilenet_v1`基于COCO数据集训练好的模型进行finetune。
+
+
+如果想通过VisualDL实时观察loss和精度值，启动命令添加`--use_vdl=True`，以及通过`--vdl_log_dir`设置日志保存路径，但注意**VisualDL需Python>=3.5**：
+
+
 ```bash
 python -u tools/train.py -c configs/yolov3_mobilenet_v1_fruit.yml \
                         --use_vdl=True \
@@ -29,7 +39,7 @@ python -u tools/train.py -c configs/yolov3_mobilenet_v1_fruit.yml \
                         --eval
 ```
 
-训练使用`yolov3_mobilenet_v1`基于COCO数据集训练好的模型进行finetune。训练期间可以通过VisualDL实时观察loss和精度值，启动命令如下：
+通过`visualdl`命令实时查看变化曲线：
 
 ```bash
 visualdl --logdir vdl_fruit_dir/scalar/ --host <host_IP> --port <port_num>
@@ -38,7 +48,9 @@ visualdl --logdir vdl_fruit_dir/scalar/ --host <host_IP> --port <port_num>
 VisualDL结果显示如下：
 
 
-![](../images/visualdl_fruit.jpg)
+<div align="center">
+  <img src='../images/visualdl_fruit.jpg' width='800'>
+</div>
 
 训练模型[下载链接](https://paddlemodels.bj.bcebos.com/object_detection/yolov3_mobilenet_v1_fruit.tar)
 
@@ -61,7 +73,14 @@ python -u tools/infer.py -c configs/yolov3_mobilenet_v1_fruit.yml \
 预测图片如下：
 
 
-![](../../demo/orange_71.jpg)
-![](../images/orange_71_detection.jpg)
+<div align="center">
+  <img src='../../demo/orange_71.jpg' width='600'>
+</div>
+
+
+<div align="center">
+  <img src='../images/orange_71_detection.jpg' width='600'>
+</div>
+
 
 更多训练及评估流程，请参考[入门使用文档](GETTING_STARTED_cn.md)。
-- 
GitLab