From ba5a1b79e1162e473e44dbc12a221cda13a0881a Mon Sep 17 00:00:00 2001
From: felixhjh <852142024@qq.com>
Date: Mon, 13 Feb 2023 07:20:07 +0000
Subject: [PATCH] Update by comments

---
 docs/api_docs/cpp/vision_results_cn.md        | 34 +++++++++++++----
 docs/api_docs/cpp/vision_results_en.md        | 38 +++++++++++++------
 docs/cn/build_and_install/huawei_ascend.md    |  2 +-
 docs/cn/faq/vision_result_related_problems.md |  2 +-
 .../segmentation/paddleseg/android/README.md  |  4 +-
 .../paddleseg/android/README_CN.md            |  4 +-
 6 files changed, 58 insertions(+), 26 deletions(-)

diff --git a/docs/api_docs/cpp/vision_results_cn.md b/docs/api_docs/cpp/vision_results_cn.md
index 73af7f9ed..669343eb4 100644
--- a/docs/api_docs/cpp/vision_results_cn.md
+++ b/docs/api_docs/cpp/vision_results_cn.md
@@ -1,3 +1,5 @@
+[English](./vision_results_en.md) | 简体中文
+
 # 视觉模型预测结果说明
 
 ## ClassifyResult 图像分类结果
@@ -6,7 +8,9 @@ ClassifyResult代码定义在`fastdeploy/vision/common/result.h`中，用于表
 
 ### C++ 定义
 
-`fastdeploy::vision::ClassifyResult`
+```c++
+fastdeploy::vision::ClassifyResult
+```
 
 ```c++
 struct ClassifyResult {
@@ -28,7 +32,9 @@ SegmentationResult代码定义在`fastdeploy/vision/common/result.h`中，用于
 
 ### C++ 定义
 
-`fastdeploy::vision::SegmentationResult`
+```c++
+fastdeploy::vision::SegmentationResult
+```
 
 ```c++
 struct SegmentationResult {
@@ -102,7 +108,9 @@ FaceAlignmentResult 代码定义在`fastdeploy/vision/common/result.h`中，用
 
 ### C++ 定义
 
-`fastdeploy::vision::FaceAlignmentResult`
+```c++
+fastdeploy::vision::FaceAlignmentResult
+```
 
 ```c++
 struct FaceAlignmentResult {
@@ -122,7 +130,9 @@ KeyPointDetectionResult 代码定义在`fastdeploy/vision/common/result.h`中，
 
 ### C++ 定义
 
-`fastdeploy::vision::KeyPointDetectionResult`
+```c++
+fastdeploy::vision::KeyPointDetectionResult
+```
 
 ```c++
 struct KeyPointDetectionResult {
@@ -152,7 +162,9 @@ struct KeyPointDetectionResult {
 FaceRecognitionResult 代码定义在`fastdeploy/vision/common/result.h`中，用于表明人脸识别模型对图像特征的embedding。
 ### C++ 定义
 
-`fastdeploy::vision::FaceRecognitionResult`
+```c++
+fastdeploy::vision::FaceRecognitionResult
+```
 
 ```c++
 struct FaceRecognitionResult {
@@ -174,7 +186,9 @@ MattingResult 代码定义在`fastdeploy/vision/common/result.h`中，用于表
 
 ### C++ 定义
 
-`fastdeploy::vision::MattingResult`
+```c++
+fastdeploy::vision::MattingResult
+```
 
 ```c++
 struct MattingResult {
@@ -232,7 +246,9 @@ FaceDetectionResult 代码定义在`fastdeploy/vision/common/result.h`中，用
 
 ### C++ 定义
 
-`fastdeploy::vision::FaceDetectionResult`
+```c++
+fastdeploy::vision::FaceDetectionResult
+```
 
 ```c++
 struct FaceDetectionResult {
@@ -258,7 +274,9 @@ HeadPoseResult 代码定义在`fastdeploy/vision/common/result.h`中，用于表
 
 ### C++ 定义
 
-`fastdeploy::vision::HeadPoseResult`
+```c++
+fastdeploy::vision::HeadPoseResult
+```
 
 ```c++
 struct HeadPoseResult {
diff --git a/docs/api_docs/cpp/vision_results_en.md b/docs/api_docs/cpp/vision_results_en.md
index 122e90293..356f66b8e 100644
--- a/docs/api_docs/cpp/vision_results_en.md
+++ b/docs/api_docs/cpp/vision_results_en.md
@@ -1,6 +1,6 @@
-# Description of Vision Results
+English | [简体中文](./vision_results_cn.md)
 
-本文档的中文版本参考[视觉模型预测结果说明](./vision_results_cn.md)
+# Description of Vision Results
 
 ## Image Classification Result
 
@@ -8,7 +8,9 @@ The ClassifyResult code is defined in `fastdeploy/vision/common/result.h`, and i
 
 ### C++ Definition
 
-`fastdeploy::vision::ClassifyResult`
+```c++
+fastdeploy::vision::ClassifyResult
+```
 
 ```c++
 struct ClassifyResult {
@@ -31,7 +33,9 @@ The SegmentationResult code is defined in `fastdeploy/vision/common/result.h`, i
 
 ### C++ Definition
 
-``fastdeploy::vision::SegmentationResult``
+```c++
+fastdeploy::vision::SegmentationResult
+```
 
 ```c++
 struct SegmentationResult {
@@ -104,7 +108,9 @@ The FaceDetectionResult code is defined in `fastdeploy/vision/common/result.h`,
 
 ### C++ Definition
 
-``fastdeploy::vision::FaceDetectionResult``
+```c++
+fastdeploy::vision::FaceDetectionResult
+```
 
 ```c++
 struct FaceDetectionResult {
@@ -131,7 +137,9 @@ The KeyPointDetectionResult code is defined in `fastdeploy/vision/common/result.
 
 ### C++ Definition
 
-``fastdeploy::vision::KeyPointDetectionResult``
+```c++
+fastdeploy::vision::KeyPointDetectionResult
+```
 
 ```c++
 struct KeyPointDetectionResult {
@@ -161,7 +169,9 @@ struct KeyPointDetectionResult {
 The FaceRecognitionResult code is defined in `fastdeploy/vision/common/result.h`, and is used to indicate the image features embedding in the face recognition model.
 ### C++ Definition
 
-`fastdeploy::vision::FaceRecognitionResult`
+```c++
+fastdeploy::vision::FaceRecognitionResult
+```
 
 ```c++
 struct FaceRecognitionResult {
@@ -180,8 +190,9 @@ struct FaceRecognitionResult {
 The MattingResult code is defined in `fastdeploy/vision/common/result.h`, and is used to indicate the predicted value of alpha transparency predicted and the predicted foreground, etc.
 
 ### C++ Definition
-
-``fastdeploy::vision::MattingResult`''
+```c++
+fastdeploy::vision::MattingResult
+```
 
 ```c++
 struct MattingResult {
@@ -239,8 +250,9 @@ struct OCRResult {
 The FaceAlignmentResult code is defined in `fastdeploy/vision/common/result.h`, and is used to indicate face landmarks.
 
 ### C++ Definition
-
-`fastdeploy::vision::FaceAlignmentResult`
+```c++
+fastdeploy::vision::FaceAlignmentResult
+```
 
 ```c++
 struct FaceAlignmentResult {
@@ -261,7 +273,9 @@ The HeadPoseResult code is defined in `fastdeploy/vision/common/result.h`, and i
 
 ### C++ Definition
 
-``fastdeploy::vision::HeadPoseResult`''
+```c++
+fastdeploy::vision::HeadPoseResult
+```
 
 ```c++
 struct HeadPoseResult {
diff --git a/docs/cn/build_and_install/huawei_ascend.md b/docs/cn/build_and_install/huawei_ascend.md
index b95311a28..4e621e305 100644
--- a/docs/cn/build_and_install/huawei_ascend.md
+++ b/docs/cn/build_and_install/huawei_ascend.md
@@ -126,7 +126,7 @@ python setup.py bdist_wheel
 ## 五.昇腾部署时开启FlyCV
 [FlyCV](https://github.com/PaddlePaddle/FlyCV) 是一款高性能计算机图像处理库, 针对ARM架构做了很多优化, 相比其他图像处理库性能更为出色.
 FastDeploy现在已经集成FlyCV, 用户可以在支持的硬件平台上使用FlyCV, 实现模型端到端推理性能的加速.
-模型端到端推理中, 预处理和后处理阶段为CPU计算, 当用户使用ARM CPU + 昇腾的硬件平台时, 我们推荐用户使用FlyCV, 可以实现端到端的推理性能加速, 详见[FLyCV使用文档](../faq/boost_cv_by_flycv.md).
+模型端到端推理中, 预处理和后处理阶段为CPU计算, 当用户使用ARM CPU + 昇腾的硬件平台时, 我们推荐用户使用FlyCV, 可以实现端到端的推理性能加速, 详见[FlyCV使用文档](../faq/boost_cv_by_flycv.md).
 
 
 ## 六.昇腾部署Demo参考
diff --git a/docs/cn/faq/vision_result_related_problems.md b/docs/cn/faq/vision_result_related_problems.md
index 59ce781d8..0426a2d18 100644
--- a/docs/cn/faq/vision_result_related_problems.md
+++ b/docs/cn/faq/vision_result_related_problems.md
@@ -4,7 +4,7 @@
 ## 将视觉模型预测结果转换为numpy格式
 
 这里以[SegmentationResult](./segmentation_result_CN.md)为例，展示如何抽取SegmentationResult中的label_map或者score_map来转为numpy格式，同时也可以利用已有数据new SegmentationResult结构体
-```
+``` python
 import fastdeploy as fd
 import cv2
 import numpy as np
diff --git a/examples/vision/segmentation/paddleseg/android/README.md b/examples/vision/segmentation/paddleseg/android/README.md
index ab06e1868..ad363015b 100644
--- a/examples/vision/segmentation/paddleseg/android/README.md
+++ b/examples/vision/segmentation/paddleseg/android/README.md
@@ -1,5 +1,5 @@
 English | [简体中文](README_CN.md)
-# PaddleSeg Android Demo for Target Detection
+# PaddleSeg Android Demo for Image Segmentation
 
 For real-time portrait segmentation on Android, this demo has good ease of use and openness. You can run your own training model in the demo.
 
@@ -10,7 +10,7 @@ For real-time portrait segmentation on Android, this demo has good ease of use a
 
 ## Deployment Steps
 
-1. Target detection PaddleSeg Demo is located in `fastdeploy/examples/vision/segmentation/paddleseg/android` directory.
+1. Image Segmentation PaddleSeg Demo is located in `fastdeploy/examples/vision/segmentation/paddleseg/android` directory.
 2. Please use Android Studio to open paddleseg/android project.
 3. Connect your phone to your computer, turn on USB debugging and file transfer mode, and connect your own mobile device on Android Studio (your phone needs to be enabled to allow software installation from USB).
 
diff --git a/examples/vision/segmentation/paddleseg/android/README_CN.md b/examples/vision/segmentation/paddleseg/android/README_CN.md
index 30938b697..1414e8ae9 100644
--- a/examples/vision/segmentation/paddleseg/android/README_CN.md
+++ b/examples/vision/segmentation/paddleseg/android/README_CN.md
@@ -1,5 +1,5 @@
 [English](README.md) | 简体中文
-# 目标检测 PaddleSeg Android Demo 使用文档  
+# 图像分割 PaddleSeg Android Demo 使用文档  
 
 在 Android 上实现实时的人像分割功能，此 Demo 有很好的的易用性和开放性，如在 Demo 中跑自己训练好的模型等。
 
@@ -10,7 +10,7 @@
 
 ## 部署步骤
 
-1. 目标检测 PaddleSeg Demo 位于 `path/to/paddleseg/android` 目录
+1. 图像分割 PaddleSeg Demo 位于 `path/to/paddleseg/android` 目录
 2. 用 Android Studio 打开 paddleseg/android 工程
 3. 手机连接电脑，打开 USB 调试和文件传输模式，并在 Android Studio 上连接自己的手机设备（手机需要开启允许从 USB 安装软件权限）