Skip to content

Commit 02eab97

Browse files
charl-ucharl-u
authored
[Doc]Add English version of documents in docs/cn and api/vision_results (#931)
* 第一次提交 * 补充一处漏翻译 * deleted: docs/en/quantize.md * Update one translation * Update en version * Update one translation in code * Standardize one writing * Standardize one writing * Update some en version * Fix a grammer problem * Update en version for api/vision result * Merge branch 'develop' of https://github.com/charl-u/FastDeploy into develop * Checkout the link in README in vision_results/ to the en documents * Modify a title * Add link to serving/docs/ * Finish translation of demo.md
1 parent ac255b8 commit 02eab97

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

80 files changed

+1430
-53
lines changed

‎docs/api/vision_results/README.md ‎docs/api/vision_results/README_CN.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
[English](README_EN.md)| 简体中文
12
# 视觉模型预测结果说明
23

34
FastDeploy根据视觉模型的任务类型，定义了不同的结构体(`fastdeploy/vision/common/result.h`)来表达模型预测结果，具体如下表所示

‎docs/api/vision_results/README_EN.md

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
[简体中文](README_CN.md)| English
2+
# Prediction Results of the Vision Model
3+
4+
FastDeploy defines different structures (`fastdeploy/vision/common/result.h`) to express the model prediction results according to the vision model task.
5+
6+
| Structure | Document | Description | Corresponding Model |
7+
|:------------------------|:----------------------------------------------|:------------------|:------------------------|
8+
| ClassifyResult | [C++/Python document](./classification_result_EN.md) | Image classification return results | ResNet50, MobileNetV3, etc. |
9+
| SegmentationResult | [C++/Python document](./segmentation_result_EN.md) | Image segmentation result | PP-HumanSeg, PP-LiteSeg, etc. |
10+
| DetectionResult | [C++/Python document](./detection_result_EN.md) | Target detection result | PP-YOLOE, YOLOv7, etc. |
11+
| FaceDetectionResult | [C++/Python document](./face_detection_result_EN.md) | Result of face detection | SCRFD, RetinaFace, etc. |
12+
| FaceAlignmentResult | [C++/Python document](./face_alignment_result_EN.md) | Face alignment result(Face keypoint detection) | PFLD model, etc. |
13+
| KeyPointDetectionResult | [C++/Python document](./keypointdetection_result_EN.md) | Result of keypoint detection | PP-Tinypose model, etc. |
14+
| FaceRecognitionResult | [C++/Python document](./face_recognition_result_EN.md) | Result of face recognition | ArcFace, CosFace, etc. |
15+
| MattingResult | [C++/Python document](./matting_result_EN.md) | Image/video keying result | MODNet, RVM, etc. |
16+
| OCRResult | [C++/Python document](./ocr_result_EN.md) | Text box detection, classification and text recognition result | OCR, etc. |
17+
| MOTResult | [C++/Python document](./mot_result_EN.md) | Multi-target tracking result | pptracking, etc. |
18+
| HeadPoseResult | [C++/Python document](./headpose_result_EN.md) | Head pose estimation result | FSANet, etc. |

‎docs/api/vision_results/classification_result.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
中文 ｜ [English](classification_result_EN.md)
12
# ClassifyResult 图像分类结果
23

34
ClassifyResult代码定义在`fastdeploy/vision/common/result.h`中，用于表明图像的分类结果和置信度。

‎docs/api/vision_results/classification_result_EN.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
English | [中文](classification_result.md)
2+
# Image Classification Result
3+
4+
The ClassifyResult code is defined in `fastdeploy/vision/common/result.h`, and is used to indicate the classification result and confidence level of the image.
5+
6+
## C++ Definition
7+
8+
`fastdeploy::vision::ClassifyResult`
9+
10+
```c++
11+
struct ClassifyResult {
12+
std::vector<int32_t> label_ids;
13+
std::vector<float> scores;
14+
void Clear();
15+
std::string Str();
16+
};
17+
```
18+
19+
- **label_ids**: Member variable which indicates the classification results of a single image. Its number is determined by the topk passed in when using the classification model, e.g. it can return the top 5 classification results.
20+
- **scores**: Member variable which indicates the confidence level of a single image on the corresponding classification result. Its number is determined by the topk passed in when using the classification model, e.g. it can return the top 5 classification confidence level.
21+
- **Clear()**: Member function used to clear the results stored in the structure.
22+
- **Str()**: Member function used to output the information in the structure as string (for Debug).
23+
24+
## Python Definition
25+
26+
`fastdeploy.vision.ClassifyResult`
27+
28+
- **label_ids**(list of int): Member variable which indicates the classification results of a single image. Its number is determined by the topk passed in when using the classification model, e.g. it can return the top 5 classification results.
29+
- **scores**(list of float): Member variable which indicates the confidence level of a single image on the corresponding classification result. Its number is determined by the topk passed in when using the classification model, e.g. it can return the top 5 classification confidence level.

‎docs/api/vision_results/detection_result.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
中文 ｜ [English](detection_result_EN.md)
12
# DetectionResult 目标检测结果
23

34
DetectionResult代码定义在`fastdeploy/vision/common/result.h`中，用于表明图像检测出来的目标框、目标类别和目标置信度。

‎docs/api/vision_results/detection_result_EN.md

+66
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
English | [中文](detection_result.md)
2+
3+
# Target Detection Result
4+
5+
The DetectionResult code is defined in `fastdeploy/vision/common/result.h`, and is used to indicate the target frame, target class and target confidence level detected in the image.
6+
7+
## C++ Definition
8+
9+
```c++
10+
fastdeploy::vision::DetectionResult
11+
```
12+
13+
```c++
14+
struct DetectionResult {
15+
std::vector<std::array<float, 4>> boxes;
16+
std::vector<float> scores;
17+
std::vector<int32_t> label_ids;
18+
std::vector<Mask> masks;
19+
bool contain_masks = false;
20+
void Clear();
21+
std::string Str();
22+
};
23+
```
24+
25+
- **boxes**: Member variable which indicates the coordinates of all detected target boxes in a single image. `boxes.size()` indicates the number of boxes, each box is represented by 4 float values in order of xmin, ymin, xmax, ymax, i.e. the coordinates of the top left and bottom right corner.
26+
- **scores**: Member variable which indicates the confidence level of all targets detected in a single image, where the number of elements is the same as `boxes.size()`.
27+
- **label_ids**: Member variable which indicates all target categories detected in a single image, where the number of elements is the same as `boxes.size()`.
28+
- **masks**: Member variable which indicates all detected instance masks of a single image, where the number of elements and the shape size are the same as `boxes`.
29+
- **contain_masks**: Member variable which indicates whether the detected result contains instance masks, which is generally true for the instance segmentation model.
30+
- **Clear()**: Member function used to clear the results stored in the structure.
31+
- **Str()**: Member function used to output the information in the structure as string (for Debug).
32+
33+
```c++
34+
fastdeploy::vision::Mask
35+
```
36+
```c++
37+
struct Mask {
38+
std::vector<int32_t> data;
39+
std::vector<int64_t> shape; // (H,W) ...
40+
41+
void Clear();
42+
std::string Str();
43+
};
44+
```
45+
- **data**: Member variable which indicates a detected mask.
46+
- **shape**: Member variable which indicates the shape of the mask, e.g. (h,w).
47+
- **Clear()**: Member function used to clear the results stored in the structure.
48+
- **Str()**: Member function used to output the information in the structure as string (for Debug).
49+
50+
## Python Definition
51+
52+
```python
53+
fastdeploy.vision.DetectionResult
54+
```
55+
56+
- **boxes**(list of list(float)): Member variable which indicates the coordinates of all detected target boxes in a single frame. It is a list, and each element in it is also a list of length 4, representing a box with 4 float values representing xmin, ymin, xmax, ymax, i.e. the coordinates of the top left and bottom right corner.
57+
- **scores**(list of float): Member variable which indicates the confidence level of all targets detected in a single image.
58+
- **label_ids**(list of int): Member variable which indicates all target categories detected in a single image.
59+
- **masks**: Member variable which indicates all detected instance masks of a single image, where the number of elements and the shape size are the same as `boxes`.
60+
- **contain_masks**: Member variable which indicates whether the detected result contains instance masks, which is generally true for the instance segmentation model.
61+
62+
```python
63+
fastdeploy.vision.Mask
64+
```
65+
- **data**: Member variable which indicates a detected mask.
66+
- **shape**: Member variable which indicates the shape of the mask, e.g. (h,w).

‎docs/api/vision_results/face_alignment_result.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
中文 ｜ [English](face_alignment_result_EN.md)
12
# FaceAlignmentResult 人脸对齐(人脸关键点检测)结果
23

34
FaceAlignmentResult 代码定义在`fastdeploy/vision/common/result.h`中，用于表明人脸landmarks。

‎docs/api/vision_results/face_alignment_result_EN.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
English | [中文](face_alignment_result.md)
2+
# Face Alignment Result
3+
4+
The FaceAlignmentResult code is defined in `fastdeploy/vision/common/result.h`, and is used to indicate face landmarks.
5+
6+
## C++ Definition
7+
8+
`fastdeploy::vision::FaceAlignmentResult`
9+
10+
```c++
11+
struct FaceAlignmentResult {
12+
std::vector<std::array<float, 2>> landmarks;
13+
void Clear();
14+
std::string Str();
15+
};
16+
```
17+
18+
- **landmarks**: Member variable which indicates all the key points detected in a single face image.
19+
- **Clear()**: Member function used to clear the results stored in the structure.
20+
- **Str()**: Member function used to output the information in the structure as string (for Debug).
21+
22+
## Python Definition
23+
24+
`fastdeploy.vision.FaceAlignmentResult`
25+
26+
- **landmarks**(list of list(float)): Member variable which indicates all the key points detected in a single face image.

‎docs/api/vision_results/face_detection_result.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
中文 | [English](face_detection_result_EN.md)
12
# FaceDetectionResult 人脸检测结果
23

34
FaceDetectionResult 代码定义在`fastdeploy/vision/common/result.h`中，用于表明人脸检测出来的目标框、人脸landmarks，目标置信度和每张人脸的landmark数量。

‎docs/api/vision_results/face_detection_result_EN.md

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
English | [中文](face_detection_result.md)
2+
# Face Detection Result
3+
4+
The FaceDetectionResult code is defined in `fastdeploy/vision/common/result.h`, and is used to indicate the target frames, face landmarks, target confidence and the number of landmark per face.
5+
6+
## C++ Definition
7+
8+
``fastdeploy::vision::FaceDetectionResult``
9+
10+
```c++
11+
struct FaceDetectionResult {
12+
std::vector<std::array<float, 4>> boxes;
13+
std::vector<std::array<float, 2>> landmarks;
14+
std::vector<float> scores;
15+
int landmarks_per_face;
16+
void Clear();
17+
std::string Str();
18+
};
19+
```
20+
21+
- **boxes**: Member variable which indicates the coordinates of all detected target boxes in a single image. `boxes.size()` indicates the number of boxes, each box is represented by 4 float values in order of xmin, ymin, xmax, ymax, i.e. the coordinates of the top left and bottom right corner.
22+
- **scores**: Member variable which indicates the confidence level of all targets detected in a single image, where the number of elements is the same as `boxes.size()`.
23+
- **landmarks**: Member variable which indicates the keypoints of all faces detected in a single image, where the number of elements is the same as `boxes.size()`.
24+
- **landmarks_per_face**: Member variable which indicates the number of keypoints in each face box.
25+
- **Clear()**: Member function used to clear the results stored in the structure.
26+
- **Str()**: Member function used to output the information in the structure as string (for Debug).
27+
28+
## Python Definition
29+
30+
`fastdeploy.vision.FaceDetectionResult`
31+
32+
- **boxes**(list of list(float)): Member variable which indicates the coordinates of all detected target boxes in a single frame. It is a list, and each element in it is also a list of length 4, representing a box with 4 float values representing xmin, ymin, xmax, ymax, i.e. the coordinates of the top left and bottom right corner.
33+
- **scores**(list of float): Member variable which indicates the confidence level of all targets detected in a single image.
34+
- **landmarks**(list of list(float)): Member variable which indicates the keypoints of all faces detected in a single image.
35+
- **landmarks_per_face**(int): Member variable which indicates the number of keypoints in each face box.

‎docs/api/vision_results/face_recognition_result.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
中文 ｜ [English](face_recognition_result_EN.md)
12
# FaceRecognitionResult 人脸识别结果
23

34
FaceRecognitionResult 代码定义在`fastdeploy/vision/common/result.h`中，用于表明人脸识别模型对图像特征的embedding。

‎docs/api/vision_results/face_recognition_result_EN.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
English | [中文](face_recognition_result.md)
2+
3+
# Face Recognition Result
4+
5+
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.
6+
## C++ Definition
7+
8+
`fastdeploy::vision::FaceRecognitionResult`
9+
10+
```c++
11+
struct FaceRecognitionResult {
12+
std::vector<float> embedding;
13+
void Clear();
14+
std::string Str();
15+
};
16+
```
17+
18+
- **embedding**: Member variable which indicates the final extracted feature embedding of the face recognition model, and can be used to calculate the facial feature similarity.
19+
- **Clear()**: Member function used to clear the results stored in the structure.
20+
- **Str()**: Member function used to output the information in the structure as string (for Debug).
21+
22+
## Python Definition
23+
24+
`fastdeploy.vision.FaceRecognitionResult`
25+
26+
- **embedding**(list of float): Member variable which indicates the final extracted feature embedding of the face recognition model, and can be used to calculate the facial feature similarity.

‎docs/api/vision_results/headpose_result.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
中文 ｜ [English](headpose_result_EN.md)
12
# HeadPoseResult 头部姿态结果
23

34
HeadPoseResult 代码定义在`fastdeploy/vision/common/result.h`中，用于表明头部姿态结果。

‎docs/api/vision_results/headpose_result_EN.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
English | [中文](headpose_result.md)
2+
# Head Pose Result
3+
4+
The HeadPoseResult code is defined in `fastdeploy/vision/common/result.h`, and is used to indicate the head pose result.
5+
6+
## C++ Definition
7+
8+
``fastdeploy::vision::HeadPoseResult`''
9+
10+
```c++
11+
struct HeadPoseResult {
12+
std::vector<float> euler_angles;
13+
void Clear();
14+
std::string Str();
15+
};
16+
```
17+
18+
- **euler_angles**: Member variable which indicates the Euler angles predicted for a single face image, stored in the order (yaw, pitch, roll), with yaw representing the horizontal turn angle, pitch representing the vertical angle, and roll representing the roll angle, all with a value range of [-90,+90].
19+
- **Clear()**: Member function used to clear the results stored in the structure.
20+
- **Str()**: Member function used to output the information in the structure as string (for Debug).
21+
22+
## Python Definition
23+
24+
`fastdeploy.vision.HeadPoseResult`
25+
26+
- **euler_angles**(list of float): Member variable which indicates the Euler angles predicted for a single face image, stored in the order (yaw, pitch, roll), with yaw representing the horizontal turn angle, pitch representing the vertical angle, and roll representing the roll angle, all with a value range of [-90,+90].

‎docs/api/vision_results/keypointdetection_result.md

+11-8
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
中文 | [English](keypointdetection_result_EN.md)
12
# KeyPointDetectionResult 目标检测结果
23

34
KeyPointDetectionResult 代码定义在`fastdeploy/vision/common/result.h`中，用于表明图像中目标行为的各个关键点坐标和置信度。
@@ -16,10 +17,12 @@ struct KeyPointDetectionResult {
1617
};
1718
```
1819
19-
- **keypoints**: 成员变量，表示识别到的目标行为的关键点坐标。`keypoints.size()= N * J`，
20+
- **keypoints**: 成员变量，表示识别到的目标行为的关键点坐标。
21+
`keypoints.size()= N * J`
2022
- `N`：图片中的目标数量
2123
- `J`：num_joints（一个目标的关键点数量）
22-
- **scores**: 成员变量，表示识别到的目标行为的关键点坐标的置信度。`scores.size()= N * J`
24+
- **scores**: 成员变量，表示识别到的目标行为的关键点坐标的置信度。
25+
`scores.size()= N * J`
2326
- `N`：图片中的目标数量
2427
- `J`:num_joints（一个目标的关键点数量）
2528
- **num_joints**: 成员变量，一个目标的关键点数量
@@ -31,11 +34,11 @@ struct KeyPointDetectionResult {
3134
`fastdeploy.vision.KeyPointDetectionResult`
3235
3336
- **keypoints**(list of list(float)): 成员变量，表示识别到的目标行为的关键点坐标。
34-
`keypoints.size()= N * J`
35-
`N`:图片中的目标数量
36-
`J`:num_joints（关键点数量）
37+
`keypoints.size()= N * J`
38+
- `N`:图片中的目标数量
39+
- `J`:num_joints（关键点数量）
3740
- **scores**(list of float): 成员变量，表示识别到的目标行为的关键点坐标的置信度。
38-
`scores.size()= N * J`
39-
`N`:图片中的目标数量
40-
`J`:num_joints（一个目标的关键点数量）
41+
`scores.size()= N * J`
42+
- `N`:图片中的目标数量
43+
- `J`:num_joints（一个目标的关键点数量）
4144
- **num_joints**(int): 成员变量，一个目标的关键点数量

‎docs/api/vision_results/keypointdetection_result_EN.md

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
English | [中文](keypointdetection_result.md)
2+
# Keypoint Detection Result
3+
4+
The KeyPointDetectionResult code is defined in `fastdeploy/vision/common/result.h`, and is used to indicate the coordinates and confidence level of each keypoint of the target's behavior in the image.
5+
6+
## C++ Definition
7+
8+
``fastdeploy::vision::KeyPointDetectionResult``
9+
10+
```c++
11+
struct KeyPointDetectionResult {
12+
std::vector<std::array<float, 2>> keypoints;
13+
std::vector<float> scores;
14+
int num_joints = -1;
15+
void Clear();
16+
std::string Str();
17+
};
18+
```
19+
20+
- **keypoints**: Member variable which indicates the coordinates of the identified target behavior keypoint.
21+
` keypoints.size() = N * J`:
22+
- `N`: the number of targets in the image
23+
- `J`: num_joints (the number of keypoints of a target)
24+
- **scores**: Member variable which indicates the confidence level of the keypoint coordinates of the identified target behavior.
25+
`scores.size() = N * J`:
26+
- `N`: the number of targets in the picture
27+
- `J`:num_joints (the number of keypoints of a target)
28+
- **num_joints**: Member variable which indicates the number of keypoints of a target.
29+
- **Clear()**: Member function used to clear the results stored in the structure.
30+
- **Str()**: Member function used to output the information in the structure as string (for Debug).
31+
32+
## Python Definition
33+
34+
`fastdeploy.vision.KeyPointDetectionResult`
35+
36+
- **keypoints**(list of list(float)): Member variable which indicates the coordinates of the identified target behavior keypoint.
37+
` keypoints.size() = N * J`:
38+
- `N`: the number of targets in the image
39+
- `J`: num_joints (the number of keypoints of a target)
40+
- **scores**(list of float): Member variable which indicates the confidence level of the keypoint coordinates of the identified target behavior.
41+
`scores.size() = N * J`:
42+
- `N`: the number of targets in the picture
43+
- `J`:num_joints (the number of keypoints of a target)
44+
- **num_joints**(int): Member variable which indicates the number of keypoints of a target.

‎docs/api/vision_results/matting_result.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
中文 ｜ [English](matting_result_EN.md)
12
# MattingResult 抠图结果
23

34
MattingResult 代码定义在`fastdeploy/vision/common/result.h`中，用于表明模型预测的alpha透明度的值，预测的前景等。

0 commit comments

Comments
 (0)