Skip to content

Commit 61c2f87

Browse files
authored
[Doc] Update English version of some documents (PaddlePaddle#1084)
* Create README_CN.md * Update README.md * Update README_CN.md * Create README_CN.md * Update README.md * Create README_CN.md * Update README.md * Create README_CN.md * Update README.md * Create README_CN.md * Update README.md * Create README_CN.md * Update README.md * Create README_CN.md * Update README.md * Create README_CN.md * Update README.md * Update README.md * Update README_CN.md * Create README_CN.md * Update README.md * Update README.md * Update and rename README_en.md to README_CN.md * Update WebDemo.md * Update and rename WebDemo_en.md to WebDemo_CN.md * Update and rename DEVELOPMENT_cn.md to DEVELOPMENT_CN.md * Update DEVELOPMENT_CN.md * Update DEVELOPMENT.md * Update RNN.md * Update and rename RNN_EN.md to RNN_CN.md * Update README.md * Update and rename README_en.md to README_CN.md * Update README.md * Update and rename README_en.md to README_CN.md * Update README.md * Update README_cn.md * Rename README_cn.md to README_CN.md * Update README.md * Update README_cn.md * Rename README_cn.md to README_CN.md * Update export.md * Update and rename export_EN.md to export_CN.md * Update README.md * Update README.md * Create README_CN.md * Update README.md * Update README.md * Update kunlunxin.md * Update classification_result.md * Update classification_result_EN.md * Rename classification_result_EN.md to classification_result_CN.md * Update detection_result.md * Update and rename detection_result_EN.md to detection_result_CN.md * Update face_alignment_result.md * Update and rename face_alignment_result_EN.md to face_alignment_result_CN.md * Update face_detection_result.md * Update and rename face_detection_result_EN.md to face_detection_result_CN.md * Update face_recognition_result.md * Update and rename face_recognition_result_EN.md to face_recognition_result_CN.md * Update headpose_result.md * Update and rename headpose_result_EN.md to headpose_result_CN.md * Update keypointdetection_result.md * Update and rename keypointdetection_result_EN.md to keypointdetection_result_CN.md * Update matting_result.md * Update and rename matting_result_EN.md to matting_result_CN.md * Update mot_result.md * Update and rename mot_result_EN.md to mot_result_CN.md * Update ocr_result.md * Update and rename ocr_result_EN.md to ocr_result_CN.md * Update segmentation_result.md * Update and rename segmentation_result_EN.md to segmentation_result_CN.md * Update README.md * Update README.md * Update quantize.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md
1 parent 5ea3cb0 commit 61c2f87

File tree

84 files changed

+2162
-1630
lines changed

Some content is hidden

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

84 files changed

+2162
-1630
lines changed
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
中文 | [English](classification_result_EN.md)
2-
# ClassifyResult 图像分类结果
1+
English | [简体中文](classification_result_CN.md)
2+
# Image Classification Result
33

4-
ClassifyResult代码定义在`fastdeploy/vision/common/result.h`中,用于表明图像的分类结果和置信度。
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.
55

6-
## C++ 定义
6+
## C++ Definition
77

88
`fastdeploy::vision::ClassifyResult`
99

@@ -16,14 +16,14 @@ struct ClassifyResult {
1616
};
1717
```
1818
19-
- **label_ids**: 成员变量,表示单张图片的分类结果,其个数根据在使用分类模型时传入的topk决定,例如可以返回top 5的分类结果
20-
- **scores**: 成员变量,表示单张图片在相应分类结果上的置信度,其个数根据在使用分类模型时传入的topk决定,例如可以返回top 5的分类置信度
21-
- **Clear()**: 成员函数,用于清除结构体中存储的结果
22-
- **Str()**: 成员函数,将结构体中的信息以字符串形式输出(用于Debug)
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).
2323
24-
## Python 定义
24+
## Python Definition
2525
2626
`fastdeploy.vision.ClassifyResult`
2727
28-
- **label_ids**(list of int): 成员变量,表示单张图片的分类结果,其个数根据在使用分类模型时传入的topk决定,例如可以返回top 5的分类结果
29-
- **scores**(list of float): 成员变量,表示单张图片在相应分类结果上的置信度,其个数根据在使用分类模型时传入的topk决定,例如可以返回top 5的分类置信度
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.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
简体中文 | [English](classification_result.md)
2+
# ClassifyResult 图像分类结果
3+
4+
ClassifyResult代码定义在`fastdeploy/vision/common/result.h`中,用于表明图像的分类结果和置信度。
5+
6+
## C++ 定义
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**: 成员变量,表示单张图片的分类结果,其个数根据在使用分类模型时传入的topk决定,例如可以返回top 5的分类结果
20+
- **scores**: 成员变量,表示单张图片在相应分类结果上的置信度,其个数根据在使用分类模型时传入的topk决定,例如可以返回top 5的分类置信度
21+
- **Clear()**: 成员函数,用于清除结构体中存储的结果
22+
- **Str()**: 成员函数,将结构体中的信息以字符串形式输出(用于Debug)
23+
24+
## Python 定义
25+
26+
`fastdeploy.vision.ClassifyResult`
27+
28+
- **label_ids**(list of int): 成员变量,表示单张图片的分类结果,其个数根据在使用分类模型时传入的topk决定,例如可以返回top 5的分类结果
29+
- **scores**(list of float): 成员变量,表示单张图片在相应分类结果上的置信度,其个数根据在使用分类模型时传入的topk决定,例如可以返回top 5的分类置信度

docs/api/vision_results/classification_result_EN.md

-29
This file was deleted.
+25-24
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
1-
中文 | [English](detection_result_EN.md)
2-
# DetectionResult 目标检测结果
1+
English | [简体中文](detection_result_CN.md)
32

4-
DetectionResult代码定义在`fastdeploy/vision/common/result.h`中,用于表明图像检测出来的目标框、目标类别和目标置信度。
3+
# Target Detection Result
54

6-
## C++ 定义
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
78

89
```c++
910
fastdeploy::vision::DetectionResult
@@ -21,45 +22,45 @@ struct DetectionResult {
2122
};
2223
```
2324
24-
- **boxes**: 成员变量,表示单张图片检测出来的所有目标框坐标,`boxes.size()`表示框的个数,每个框以4个float数值依次表示xmin, ymin, xmax, ymax, 即左上角和右下角坐标
25-
- **scores**: 成员变量,表示单张图片检测出来的所有目标置信度,其元素个数与`boxes.size()`一致
26-
- **label_ids**: 成员变量,表示单张图片检测出来的所有目标类别,其元素个数与`boxes.size()`一致
27-
- **masks**: 成员变量,表示单张图片检测出来的所有实例mask,其元素个数及shape大小与`boxes`一致
28-
- **contain_masks**: 成员变量,表示检测结果中是否包含实例mask,实例分割模型的结果此项一般为true.
29-
- **Clear()**: 成员函数,用于清除结构体中存储的结果
30-
- **Str()**: 成员函数,将结构体中的信息以字符串形式输出(用于Debug)
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).
3132
3233
```c++
3334
fastdeploy::vision::Mask
3435
```
3536
```c++
3637
struct Mask {
3738
std::vector<int32_t> data;
38-
std::vector<int64_t> shape; // (H,W) ...
39+
std::vector<int64_t> shape; // (H,W) ...
3940

4041
void Clear();
4142
std::string Str();
4243
};
4344
```
44-
- **data**: 成员变量,表示检测到的一个mask
45-
- **shape**: 成员变量,表示mask的shape,如 (h,w)
46-
- **Clear()**: 成员函数,用于清除结构体中存储的结果
47-
- **Str()**: 成员函数,将结构体中的信息以字符串形式输出(用于Debug)
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).
4849
49-
## Python 定义
50+
## Python Definition
5051
5152
```python
5253
fastdeploy.vision.DetectionResult
5354
```
5455

55-
- **boxes**(list of list(float)): 成员变量,表示单张图片检测出来的所有目标框坐标。boxes是一个list,其每个元素为一个长度为4的list, 表示为一个框,每个框以4个float数值依次表示xmin, ymin, xmax, ymax, 即左上角和右下角坐标
56-
- **scores**(list of float): 成员变量,表示单张图片检测出来的所有目标置信度
57-
- **label_ids**(list of int): 成员变量,表示单张图片检测出来的所有目标类别
58-
- **masks**: 成员变量,表示单张图片检测出来的所有实例mask,其元素个数及shape大小与`boxes`一致
59-
- **contain_masks**: 成员变量,表示检测结果中是否包含实例mask,实例分割模型的结果此项一般为True.
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.
6061

6162
```python
6263
fastdeploy.vision.Mask
6364
```
64-
- **data**: 成员变量,表示检测到的一个mask
65-
- **shape**: 成员变量,表示mask的shape,如 (h,w)
65+
- **data**: Member variable which indicates a detected mask.
66+
- **shape**: Member variable which indicates the shape of the mask, e.g. (h,w).
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
简体中文 | [English](detection_result.md)
2+
# DetectionResult 目标检测结果
3+
4+
DetectionResult代码定义在`fastdeploy/vision/common/result.h`中,用于表明图像检测出来的目标框、目标类别和目标置信度。
5+
6+
## C++ 定义
7+
8+
```c++
9+
fastdeploy::vision::DetectionResult
10+
```
11+
12+
```c++
13+
struct DetectionResult {
14+
std::vector<std::array<float, 4>> boxes;
15+
std::vector<float> scores;
16+
std::vector<int32_t> label_ids;
17+
std::vector<Mask> masks;
18+
bool contain_masks = false;
19+
void Clear();
20+
std::string Str();
21+
};
22+
```
23+
24+
- **boxes**: 成员变量,表示单张图片检测出来的所有目标框坐标,`boxes.size()`表示框的个数,每个框以4个float数值依次表示xmin, ymin, xmax, ymax, 即左上角和右下角坐标
25+
- **scores**: 成员变量,表示单张图片检测出来的所有目标置信度,其元素个数与`boxes.size()`一致
26+
- **label_ids**: 成员变量,表示单张图片检测出来的所有目标类别,其元素个数与`boxes.size()`一致
27+
- **masks**: 成员变量,表示单张图片检测出来的所有实例mask,其元素个数及shape大小与`boxes`一致
28+
- **contain_masks**: 成员变量,表示检测结果中是否包含实例mask,实例分割模型的结果此项一般为true.
29+
- **Clear()**: 成员函数,用于清除结构体中存储的结果
30+
- **Str()**: 成员函数,将结构体中的信息以字符串形式输出(用于Debug)
31+
32+
```c++
33+
fastdeploy::vision::Mask
34+
```
35+
```c++
36+
struct Mask {
37+
std::vector<int32_t> data;
38+
std::vector<int64_t> shape; // (H,W) ...
39+
40+
void Clear();
41+
std::string Str();
42+
};
43+
```
44+
- **data**: 成员变量,表示检测到的一个mask
45+
- **shape**: 成员变量,表示mask的shape,如 (h,w)
46+
- **Clear()**: 成员函数,用于清除结构体中存储的结果
47+
- **Str()**: 成员函数,将结构体中的信息以字符串形式输出(用于Debug)
48+
49+
## Python 定义
50+
51+
```python
52+
fastdeploy.vision.DetectionResult
53+
```
54+
55+
- **boxes**(list of list(float)): 成员变量,表示单张图片检测出来的所有目标框坐标。boxes是一个list,其每个元素为一个长度为4的list, 表示为一个框,每个框以4个float数值依次表示xmin, ymin, xmax, ymax, 即左上角和右下角坐标
56+
- **scores**(list of float): 成员变量,表示单张图片检测出来的所有目标置信度
57+
- **label_ids**(list of int): 成员变量,表示单张图片检测出来的所有目标类别
58+
- **masks**: 成员变量,表示单张图片检测出来的所有实例mask,其元素个数及shape大小与`boxes`一致
59+
- **contain_masks**: 成员变量,表示检测结果中是否包含实例mask,实例分割模型的结果此项一般为True.
60+
61+
```python
62+
fastdeploy.vision.Mask
63+
```
64+
- **data**: 成员变量,表示检测到的一个mask
65+
- **shape**: 成员变量,表示mask的shape,如 (h,w)

docs/api/vision_results/detection_result_EN.md

-66
This file was deleted.
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
中文 | [English](face_alignment_result_EN.md)
2-
# FaceAlignmentResult 人脸对齐(人脸关键点检测)结果
1+
English | [简体中文](face_alignment_result_CN.md)
2+
# Face Alignment Result
33

4-
FaceAlignmentResult 代码定义在`fastdeploy/vision/common/result.h`中,用于表明人脸landmarks。
4+
The FaceAlignmentResult code is defined in `fastdeploy/vision/common/result.h`, and is used to indicate face landmarks.
55

6-
## C++ 定义
6+
## C++ Definition
77

88
`fastdeploy::vision::FaceAlignmentResult`
99

@@ -15,12 +15,12 @@ struct FaceAlignmentResult {
1515
};
1616
```
1717
18-
- **landmarks**: 成员变量,表示单张人脸图片检测出来的所有关键点
19-
- **Clear()**: 成员函数,用于清除结构体中存储的结果
20-
- **Str()**: 成员函数,将结构体中的信息以字符串形式输出(用于Debug)
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).
2121
22-
## Python 定义
22+
## Python Definition
2323
2424
`fastdeploy.vision.FaceAlignmentResult`
2525
26-
- **landmarks**(list of list(float)): 成员变量,表示单张人脸图片检测出来的所有关键点
26+
- **landmarks**(list of list(float)): Member variable which indicates all the key points detected in a single face image.

0 commit comments

Comments
 (0)