Skip to content

Commit

Permalink
[Docs] fix names (Cambricon#254)
Browse files Browse the repository at this point in the history
Co-authored-by: tudejiang <[email protected]>
  • Loading branch information
tudejiang79 and tudejiang authored Oct 17, 2022
1 parent 9372175 commit 2fe7c8e
Show file tree
Hide file tree
Showing 23 changed files with 66 additions and 65 deletions.
9 changes: 5 additions & 4 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ If you want to know how to do operator testing, you can see [GTest-User-Guide-zh

#### 3.1.1 Accuracy Acceptance Standard

For static threshold standard details, see: [MLU-OPS Accuracy Acceptance Standard](../docs/MLU-OPS精度验收标准.md).
For static threshold standard details, see: [MLU-OPS Accuracy Acceptance Standard](../docs/MLU-OPS-Accuracy-Acceptance-Standard.md).

- [ ] diff1, diff1 <= 3e-3
- [ ] diff2, diff2 <= 3e-3
Expand Down Expand Up @@ -46,22 +46,23 @@ If you have checked the following items, please tick the relevant box.
- [ ] Multiple platform test
- [ ] Gen_case module test
- [ ] Nan/INF tests
- [ ] Bug fix tests
- [ ] For memory leak check details, see[GTest-User-Guide-zh](../docs/GTest-User-Guide-zh.md).
- [ ] For code coverage check details, see: [GTest-User-Guide-zh](../docs/GTest-User-Guide-zh.md).
- [ ] For I/O calculation efficiency check details, see: [MLU-OPS Performance Acceptance Criteria](../docs/MLU-OPS性能验收标准.md).
- [ ] For I/O calculation efficiency check details, see: [MLU-OPS Performance Acceptance Standard](../docs/MLU-OPS-Performance-Acceptance-Standard.md).

#### 3.1.4 Parameter Check

When a new operator is submitted, the test points are given and the test results are stated.

| Test Point | Acceptance Criteria | Test Result (Error Message) |
| Test Point | Acceptance Standard | Test Result (Error Message) |
| -------------- | -------- | -------------------- |
| Whether it conforms to the operator restriction | Normal error | |
| Whether illegal parameters are passed | Normal error | |

### 3.2 Performance Test

See [MLU-OPS Performance Acceptance Criteria](../docs/MLU-OPS性能验收标准.md) for details.
See [MLU-OPS Performance Acceptance Standard](../docs/MLU-OPS-Performance-Acceptance-Standard.md) for details.

Platform :MLU270

Expand Down
6 changes: 3 additions & 3 deletions CONTRIBUTION.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,18 @@

## 如何添加新算子

1. 调研算子功能,撰写算子设计文档,参考[BANGC-OPS算子设计文档模板](docs/bangc-docs/BANGC-OPS算子设计文档模板.md)[BANGPy-OPS算子设计文档模板](docs/bangpy-docs/BANGPy-OPS算子设计文档模板.md),主要包括:
1. 调研算子功能,撰写算子设计文档,参考[BANGC-OPS算子设计文档模板](docs/bangc-docs/BANGC-OPS-Operator-Design-Doc-Template.md)[BANGPy-OPS算子设计文档模板](docs/bangpy-docs/BANGPy-OPS-Operator-Design-Doc-Template.md),主要包括:
- 算子需求分析
- 算子接口设计
- 算子实现方案设计

2. 算子代码开发,参考[BANGC-OPS算子开发流程](docs/bangc-docs/BANGC-OPS算子开发流程.md)[BANGPy-OPS算子开发流程](docs/bangpy-docs/BANGPy-OPS算子开发流程.md)[PULL REQUEST流程](./docs/pr.md),主要包括:
2. 算子代码开发,参考[BANGC-OPS算子开发流程](docs/bangc-docs/BANGC-OPS-Operator-Development-Process.md)[BANGPy-OPS算子开发流程](docs/bangpy-docs/BANGPy-OPS-Operator-Development-Process.md)[PULL REQUEST流程](./docs/pr.md),主要包括:
- 算子设计文档提交 `PR`(Pull Requset),其中 BANGC 算子设计文档目录为`docs/bangc-docs/design_docs` ,BANGPy 算子设计文档目录为`docs/bangpy-docs/design_docs`
- GTest 代码开发
- 算子伪代码开发
- 算子主体代码开发

3. 完成测试并撰写测试报告,参考[MLU-OPS性能验收标准](docs/MLU-OPS性能验收标准.md)[MLU-OPS测试报告模板](docs/MLU-OPS测试报告模板.md)[MLU-OPS精度验收标准](docs/MLU-OPS精度验收标准.md),主要包括:
3. 完成测试并撰写测试报告,参考[MLU-OPS性能验收标准](docs/MLU-OPS-Performance-Acceptance-Standard.md)[MLU-OPS测试报告模板](docs/MLU-OPS-Test-Report-Template.md)[MLU-OPS-Accuracy-Acceptance-Standard](docs/MLU-OPS-Accuracy-Acceptance-Standard.md),主要包括:
- 测例规模
- 测例数据类型
- 性能测试
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,8 @@ MLU-OPS 旨在通过提供示例代码,供开发者参考使用,可用于开

## 新算子开发流程

详情可以参考文档 [BANGC-OPS 算子开发流程.md](docs/bangc-docs/BANGC-OPS算子开发流程.md)
[BANGPy-OPS 算子开发流程.md](docs/bangpy-docs/BANGPy-OPS算子开发流程.md) 以及 docs 目录下的其它补充说明,
详情可以参考文档 [BANGC-OPS 算子开发流程.md](docs/bangc-docs/BANGC-OPS-Operator-Development-Process.md)
[BANGPy-OPS 算子开发流程.md](docs/bangpy-docs/BANGPy-OPS-Operator-Development-Process.md) 以及 docs 目录下的其它补充说明,
同时也需要参考 C 接口说明文档[README.md](bangc-ops/README.md) 和 Python 接口说明文档[README.md](bangpy-ops/README.md)

## 获取开发手册
Expand Down
2 changes: 1 addition & 1 deletion bangc-ops/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ cd bangc-ops/build/test/

## 新算子开发流程

详情可以参考文档 [BANGC-OPS 算子开发流程.md](../docs/bangc-docs/BANGC-OPS算子开发流程.md)以及 docs 目录下的其它补充说明。
详情可以参考文档 [BANGC-OPS 算子开发流程.md](../docs/bangc-docs/BANGC-OPS-Operator-Development-Process.md)以及 docs 目录下的其它补充说明。

1.`mlu-ops/bangc-ops/kernels/`路径下,创建算子文件夹,添加算子实现,可以参考现有的 abs 算子进行添加。
2.`mlu-ops/bangc-ops/test/mlu_op_gtest/src/zoo`创建算子文件夹,添加测试代码。
Expand Down
2 changes: 1 addition & 1 deletion bangpy-ops/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@

## 新算子开发流程

详情可以参考文档 [BANGPy-OPS 算子开发流程.md](../docs/bangpy-docs/BANGPy-OPS算子开发流程.md)
详情可以参考文档 [BANGPy-OPS 算子开发流程.md](../docs/bangpy-docs/BANGPy-OPS-Operator-Development-Process.md)

1.`mlu-ops/bangpy-ops/ops/` 路径下,创建算子文件夹,添加算子实现文件,可以参考现有的 add 算子中的[add.py](./ops/add/add.py)进行添加。
2. 在算子文件夹下创建以 `test_` 为前缀的算子测试文件,添加测试代码,可以参考[test_add.py](./ops/add/test_add.py)进行添加。
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ MLU-OPS 算子精度验收标准

各评价指标计算公式如下:

<img src="./精度标准公式.png" alt="img" style="zoom:60%;" />
<img src="./accuracy_standard_formula.png" alt="img" style="zoom:60%;" />

其中:

Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

如:算子采用静态阈值标准:diffs=[diff1, diff2], diff1<=3e-3 && diff2 <= 3e-3

详细见 [MLU-OPS 精度验收标准](./MLU-OPS精度验收标准.md)
详细见 [MLU-OPS 精度验收标准](./MLU-OPS-Accuracy-Acceptance-Standard.md)

### 1.2 算子方案CHECKLIST

Expand All @@ -39,11 +39,11 @@
- [ ] nan / inf测试
- [ ] 内存泄漏检查, 详见[GTest-User-Guide-zh](./GTest-User-Guide-zh.md)
- [ ] 代码覆盖率检查,详见[GTest-User-Guide-zh](./GTest-User-Guide-zh.md)
- [ ] IO计算效率检查,详见[MLU-OPS性能验收标准](./MLU-OPS性能验收标准.md)
- [ ] IO计算效率检查,详见[MLU-OPS性能验收标准](./MLU-OPS-Performance-Acceptance-Standard.md)

**_关于功能测试,是希望算子开发者能够针对每一个逻辑,每一个分支,每一个判断,进行对应的测例设计,尽量覆盖到所有代码逻辑。_**

### 1.3 参数检查
### 1.4 参数检查

提交新算子时,给出测试点,并说明测试结果。

Expand All @@ -54,7 +54,7 @@

# 2. 性能测试

详见:[MLU-OPS性能验收标准](./MLU-OPS性能验收标准.md)
详见:[MLU-OPS性能验收标准](./MLU-OPS-Performance-Acceptance-Standard.md)

平台:MLU270

Expand Down
File renamed without changes
Original file line number Diff line number Diff line change
Expand Up @@ -110,13 +110,13 @@ example:

#### 1.5.1 精度验收标准

按照[精度验收标准](../MLU-OPS精度验收标准.md)的要求明确本算子的精度标准。
按照[精度验收标准](../MLU-OPS-Accuracy-Acceptance-Standard.md)的要求明确本算子的精度标准。

例如:本算子属于纯 IO 类算子,验收标准为 diff3=0。

#### 1.5.2 性能验收标准

[MLU-OPS 性能验收标准](../MLU-OPS性能验收标准.md)
[MLU-OPS 性能验收标准](../MLU-OPS-Performance-Acceptance-Standard.md)

## 2 算子接口设计

Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# BANGC-OPS 算子开发流程

[概述](./BANGC-OPS算子开发流程.md#概述)
[概述](./BANGC-OPS-Operator-Development-Process.md#概述)

[需要添加的文件](./BANGC-OPS算子开发流程.md#需要添加的文件)
[需要添加的文件](./BANGC-OPS-Operator-Development-Process.md#需要添加的文件)

[算子设计文档](./BANGC-OPS算子开发流程.md#算子设计文档)
[算子设计文档](./BANGC-OPS-Operator-Development-Process.md#算子设计文档)

[算子测试报告](./BANGC-OPS算子开发流程.md#算子测试报告)
[算子测试报告](./BANGC-OPS-Operator-Development-Process.md#算子测试报告)

[代码提交流程](./BANGC-OPS算子开发流程.md#代码提交流程)
[代码提交流程](./BANGC-OPS-Operator-Development-Process.md#代码提交流程)

## 概述

Expand Down Expand Up @@ -43,7 +43,7 @@ $ cd add
$ vim add.md
```

在 add 目录下添加的 add.md 文件,为算子的设计文档,设计文档模板可参考[BANGC-OPS 算子设计文档模板](./BANGC-OPS算子设计文档模板.md)
在 add 目录下添加的 add.md 文件,为算子的设计文档,设计文档模板可参考[BANGC-OPS 算子设计文档模板](./BANGC-OPS-Operator-Design-Doc-Template.md)

如果一个算子存在正向和反向,那么正反向算子当做两个不同的算子来处理。如卷积算子存在卷积前向与卷积反向,目录结构应为

Expand Down Expand Up @@ -121,22 +121,22 @@ GTest 测试例的添加原则为能够测试到该算子的各种应用场景

## 算子测试报告

详见:[MLU-OPS测试报告模板](../MLU-OPS测试报告模板.md)
详见:[MLU-OPS测试报告模板](../MLU-OPS-Test-Report-Template.md)

### 1. 测试覆盖率

MLU-OPS coverage test 是面向 bangc 语言的代码覆盖率测试工具。
关于 MLU-OPS coverage test 的使用方法见[MLU-OPS 测试报告模板.md](../MLU-OPS测试报告模板.md)
关于 MLU-OPS coverage test 的使用方法见[MLU-OPS 测试报告模板.md](../MLU-OPS-Test-Report-Template.md)

### 2. 算子验收标准

#### 2.1 精度验收标准

kernels 下的 bangc 算子实现需要与 GTest 中的 cpuCompute()实现作为 baseline 进行精度对比验证,具体精度标准见 [MLU-OPS 精度验收标准](../MLU-OPS精度验收标准.md)
kernels 下的 bangc 算子实现需要与 GTest 中的 cpuCompute()实现作为 baseline 进行精度对比验证,具体精度标准见 [MLU-OPS 精度验收标准](../MLU-OPS-Accuracy-Acceptance-Standard.md)

#### 2.1 性能验收标准

[MLU-OPS 性能验收标准](../MLU-OPS性能验收标准.md)
[MLU-OPS 性能验收标准](../MLU-OPS-Performance-Acceptance-Standard.md)

## 代码提交流程

Expand Down
4 changes: 2 additions & 2 deletions docs/bangc-docs/design_docs/ball_query/ball_query.md
Original file line number Diff line number Diff line change
Expand Up @@ -245,13 +245,13 @@ tensor([[[0, 0, 0],

#### 1.5.1 精度验收标准

按照[精度验收标准](../MLU_OPS精度验收标准.md)的要求明确本算子的精度标准。
按照[精度验收标准](../MLU-OPS-Accuracy-Acceptance-Standard.md)的要求明确本算子的精度标准。
- 算子精度验收标准:diff1、diff2;
- 算子精度阈值描述:diff1 = 0 && diff2 = 0;

#### 1.5.2 性能验收标准

[MLU_OPS 性能验收标准](../MLU_OPS性能验收标准.md)
[MLU-OPS 性能验收标准](../MLU-OPS-Performance-Acceptance-Standard.md)

## 2 算子接口设计

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -253,7 +253,7 @@ Tensor(shape=[2, 4], dtype=float32, place=Place(gpu:0), stop_gradient=True,
### 1.5 验收标准
#### 1.5.1 精度验收标准

按照[精度验收标准](../../../MLU-OPS精度验收标准.md)的要求明确本算子的精度标准。
按照[精度验收标准](../../../MLU-OPS-Accuracy-Acceptance-Standard.md)的要求明确本算子的精度标准。
`generate_proposals_v2` 是复合类算子。<br>
`rpn_rois`参数精度设为 diff1 <= 3e-3 && diff2 <=3e-3。<br>
`rpn_roi_probs``rpn_rois_num``rpn_rois_batch_size`的精度设置为 diff3=0。
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -254,7 +254,7 @@ box_out, var_out = exe.run(fluid.default_main_program(),

该算子属于算术类算子

按照[精度验收标准](../../MLU_OPS精度验收标准.md)的要求明确本算子的精度标准。
按照[精度验收标准](../../MLU-OPS-Accuracy-Acceptance-Standard.md)的要求明确本算子的精度标准。

第一个输出output:

Expand All @@ -269,7 +269,7 @@ box_out, var_out = exe.run(fluid.default_main_program(),

#### 1.5.2 性能验收标准

-[MLU_OPS 性能验收标准](../../MLU_OPS性能验收标准.md)
-[MLU-OPS 性能验收标准](../../MLU-OPS-Performance-Acceptance-Standard.md)

Paddle cuda性能测试: 在`Tesla V100-SXM2-16GB`平台上测试`Paddle`框架的`prior_box`算子性能; 算子输入输出规模分别为:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -249,13 +249,13 @@ tensor([[[[nan, 0., 0.],

#### 1.5.1 精度验收标准

按照[精度验收标准](../MLU_OPS精度验收标准.md)的要求明确本算子的精度标准。
按照[精度验收标准](../MLU-OPS-Accuracy-Acceptance-Standard.md)的要求明确本算子的精度标准。
- 算子精度验收标准:diff1、diff2;
- 算子精度阈值描述:diff1 <= 3e-3 && diff2 <= 3e-3;

#### 1.5.2 性能验收标准

[MLU_OPS 性能验收标准](../MLU_OPS性能验收标准.md)
[MLU-OPS 性能验收标准](../MLU-OPS-Performance-Acceptance-Standard.md)

## 2 算子接口设计

Expand Down
18 changes: 9 additions & 9 deletions docs/bangc-docs/design_docs/roi_crop/roi_crop_design_docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@

### 1.1 算子需求分析

该需求分析为框架原生算子实现功能的需求分析,对于框架原生支持但 MLU_OPS 当前版本不支持的功能,需要在`1.4算子限制` 章节中显式注明。未明确注明不支持的功能,默认 MLU_OPS 全部支持。
该需求分析为框架原生算子实现功能的需求分析,对于框架原生支持但 MLU-OPS 当前版本不支持的功能,需要在`1.4算子限制` 章节中显式注明。未明确注明不支持的功能,默认 MLU-OPS 全部支持。

| 算子功能简介 | 根据感兴趣区域提取固定大小的输出特征|
| -------------------------- | ---------------------------------------- |
Expand Down Expand Up @@ -118,7 +118,7 @@ Ay = (y + 1) * (height - 1) / 2; Ay_weight = 1 - (Ay - floor(Ay));

| 参数 | 语义 | 类型(输入/输出) | 支持类型 | 物理布局 | 规模限制 |
| ----------- | ---- | ----------------- | ----------- | -------- | -------- |
| handle |MLU_OPS 上下文的指针| 输入 |mluOpHandle_t| / ||
| handle |MLU-OPS 上下文的指针| 输入 |mluOpHandle_t| / ||
| input_desc |对输入数据 input 的形状描述,包含了 input 的数据类型、数据维度和布局等信息| 输入 |mluOpTensorDescriptor_t| / ||
| input |输入 tensor input 的地址| 输入 | float | NHWC ||
| grid_desc |对输入数据 gird 的形状描述,包含了 grid 的数据类型、数据维度和布局等信息| 输入 |mluOpTensorDescriptor_t| / ||
Expand All @@ -130,7 +130,7 @@ Ay = (y + 1) * (height - 1) / 2; Ay_weight = 1 - (Ay - floor(Ay));

| 参数 | 语义 | 类型(输入/输出) | 支持类型 | 物理布局 | 规模限制 |
| ----------- | ---- | ----------------- | ----------- | -------- | -------- |
| handle |MLU_OPS 上下文的指针 | 输入 |mluOpHandle_t | / ||
| handle |MLU-OPS 上下文的指针 | 输入 |mluOpHandle_t | / ||
| grad_output_desc |对输入数据 grad_output 的形状描述,包含了 grad_output 的数据类型、数据维度和布局等信息| 输入 |mluOpTensorDescriptor_t | / ||
| grad_output |输入 tensor grad_output 的地址|输入 | float | NHWC ||
| grid_desc |对输入数据 gird 的形状描述结构体,包含了 grid 的数据类型、数据维度和布局等信息| 输入 |mluOpTensorDescriptor_t | / ||
Expand All @@ -156,13 +156,13 @@ Ay = (y + 1) * (height - 1) / 2; Ay_weight = 1 - (Ay - floor(Ay));

#### 1.5.1 精度验收标准

按照[精度验收标准](../MLU_OPS精度验收标准.md)的要求明确本算子的精度标准。
按照[精度验收标准](../MLU-OPS-Accuracy-Acceptance-Standard.md)的要求明确本算子的精度标准。
- 算子精度验收标准:diff1、diff2;
- 算子精度阈值描述:diff1 <= 3e-3 && diff2 <=3e-3;

#### 1.5.2 性能验收标准

[MLU_OPS 性能验收标准](../MLU_OPS性能验收标准.md)
[MLU-OPS 性能验收标准](../MLU-OPS-Performance-Acceptance-Standard.md)

## 2 算子接口设计

Expand Down Expand Up @@ -333,8 +333,8 @@ bins_loop_per = bins_first_per + task_bins;<br>

- 2022.4.19 ~ 4.21 调研源码+开始设计方案
- 2022.4.22 设计方案评审:算子功能+接口设计
- 2022.4.24 算子在 MLU_OPS 下的 GTest 代码开发
- 2022.4.25 ~ 4.29 算子在 MLU_OPS 下的 host、kernel 代码开发
- 2022.4.24 算子在 MLU-OPS 下的 GTest 代码开发
- 2022.4.25 ~ 4.29 算子在 MLU-OPS 下的 host、kernel 代码开发
- 2022.5.5 算子在黄区下的 Generator 开发
- 2022.5.10 ~ 5.18 大规模测试
- 2022.5.23 提交交 MR + 代码 review
Expand All @@ -344,8 +344,8 @@ bins_loop_per = bins_first_per + task_bins;<br>

- 5.30 ~ 6.1 算子需求分析和方案设计
- 6.2 算子方案评审
- 6.6 算子在 MLU_OPS 下的 GTest 开发
- 6.7 ~ 6.10 算子在 MLU_OPS 下的 host、kernel 代码开发
- 6.6 算子在 MLU-OPS 下的 GTest 开发
- 6.7 ~ 6.10 算子在 MLU-OPS 下的 host、kernel 代码开发
- 6.11 算子在黄区下的 Generator开发
- 6.13 ~ 5.16 大规模测试
- 6.17 提交交 MR + 代码 review
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -179,14 +179,14 @@ RuntimeError: CUDA error: invalid configuration argument

#### 1.5.1 精度验收标准

按照[精度验收标准](../MLU-OPS精度验收标准.md)的要求明确本算子的精度标准。
按照[精度验收标准](../MLU-OPS-Accuracy-Acceptance-Standard.md)的要求明确本算子的精度标准。

- 算子精度验收标准:diff1、diff2;
- 算子精度阈值描述:diff1 <= 3e-3 && diff2 <=3e-3

#### 1.5.2 性能验收标准

见 [MLU-OPS 性能验收标准](../MLU-OPS性能验收标准.md)。
见 [MLU-OPS 性能验收标准](../MLU-OPS-Performance-Acceptance-Standard.md)。

## 2 算子接口设计

Expand Down
2 changes: 1 addition & 1 deletion docs/bangc-docs/design_docs/yolo_box/yolo_box.md
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,7 @@

#### 1.5.1 精度验收标准

按照[精度验收标准](../MLU-OPS精度验收标准.md)的要求明确本算子的精度标准。
按照[精度验收标准](../MLU-OPS-Accuracy-Acceptance-Standard.md)的要求明确本算子的精度标准。

本算子属于复合类算子,验收标准为 diff1 <= 3e-3 && diff2 <= 3e-3

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -103,13 +103,13 @@ example:

#### 1.5.1 精度验收标准

按照[精度验收标准](../MLU-OPS精度验收标准.md)的要求明确本算子的精度标准。
按照[精度验收标准](../MLU-OPS-Accuracy-Acceptance-Standard.md)的要求明确本算子的精度标准。

例如:本算子属于纯 IO 类算子,验收标准为 diff3=0。

#### 1.5.2 性能验收标准

[MLU-OPS 性能验收标准](../MLU-OPS性能验收标准.md)
[MLU-OPS 性能验收标准](../MLU-OPS-Performance-Acceptance-Standard.md)

## 2 算子接口设计

Expand Down
Loading

0 comments on commit 2fe7c8e

Please sign in to comment.