已合并
fix: correct typos, table formatting and mixed content in documentation files #4649
tanmengjie创建于 8月31日
fix: correct typos, table formatting and mixed content in documentation files #4649
已合并
共 3 个文件变更+38-44
| @@ -12,44 +12,38 @@ CBLAS接口主要分为两类功能：执行矩阵-向量乘法和执行矩阵- | |||
| 12 | 12 | ||
| 13 | 具体替换方案如下： | 13 | 具体替换方案如下： |
| 14 | 14 | ||
| 15 | -| | | | | ||
| 16 | -| --- | --- | --- | | ||
| 17 | | 新/老接口 | CBLAS接口 | aclnn组合方案 | | 15 | | 新/老接口 | CBLAS接口 | aclnn组合方案 | |
| 16 | +| --- | --- | --- | | ||
| 18 | | 接口名称 | aclblasGemvEx<br>aclblasCreateHandleForGemvEx | aclnnMatmul(n=1) + aclnnMuls + aclnnAdd | | 17 | | 接口名称 | aclblasGemvEx<br>aclblasCreateHandleForGemvEx | aclnnMatmul(n=1) + aclnnMuls + aclnnAdd | |
| 19 | | 数据类型 | FLOAT16/FLOAT | FLOAT16/FLOAT | | 18 | | 数据类型 | FLOAT16/FLOAT | FLOAT16/FLOAT | |
| 20 | | 公式 | y = αAx + βy | 四步：Matmul → Muls → Muls → Add | | 19 | | 公式 | y = αAx + βy | 四步：Matmul → Muls → Muls → Add | |
| 21 | 20 | ||
| 22 | -| | | | | 21 | +| 新/老接口 | CBLAS接口 | aclnn组合方案 | |
| 23 | | --- | --- | --- | | 22 | | --- | --- | --- | |
| 24 | -| 新/老接口 | CBLAS接口 | aclnn 组合方案 | | ||
| 25 | | 接口名称 | aclblasHgemv<br>aclblasCreateHandleForHgemv | aclnnMatmul(n=1) + aclnnMuls + aclnnAdd | | 23 | | 接口名称 | aclblasHgemv<br>aclblasCreateHandleForHgemv | aclnnMatmul(n=1) + aclnnMuls + aclnnAdd | |
| 26 | | 数据类型 | FLOAT16（固定） | FLOAT16（固定） | | 24 | | 数据类型 | FLOAT16（固定） | FLOAT16（固定） | |
| 27 | | 公式 | y = αAx + βy | 四步：Matmul → Muls → Muls → Add | | 25 | | 公式 | y = αAx + βy | 四步：Matmul → Muls → Muls → Add | |
| 28 | 26 | ||
| 29 | -| | | | | 27 | +| 新/老接口 | CBLAS接口 | aclnn组合方案 | |
| 30 | | --- | --- | --- | | 28 | | --- | --- | --- | |
| 31 | -| 新/老接口 | CBLAS接口 | aclnn 组合方案 | | ||
| 32 | | 接口名称 | aclblasS8gemv<br>aclblasCreateHandleForS8gemv | aclnnQuantMatmulV5(n=1) + aclnnMuls + aclnnAdd | | 29 | | 接口名称 | aclblasS8gemv<br>aclblasCreateHandleForS8gemv | aclnnQuantMatmulV5(n=1) + aclnnMuls + aclnnAdd | |
| 33 | | 数据类型 | INT8 × INT8输入 → INT32输出 | INT8输入 → INT32输出 | | 30 | | 数据类型 | INT8 × INT8输入 → INT32输出 | INT8输入 → INT32输出 | |
| 34 | | 公式 | y = αAx + βy | 四步：QuantMatmulV5 → Muls(INT32) → Muls(INT32) → Add | | 31 | | 公式 | y = αAx + βy | 四步：QuantMatmulV5 → Muls(INT32) → Muls(INT32) → Add | |
| 35 | 32 | ||
| 36 | -| | | | | 33 | +| 新/老接口 | CBLAS接口 | aclnn组合方案 | |
| 37 | | --- | --- | --- | | 34 | | --- | --- | --- | |
| 38 | -| 新/老接口 | CBLAS接口 | aclnn 组合方案 | | ||
| 39 | | 接口名称 | aclblasGemmEx<br>aclblasCreateHandleForGemmEx | aclnnMatmul + aclnnMuls + aclnnAdd | | 35 | | 接口名称 | aclblasGemmEx<br>aclblasCreateHandleForGemmEx | aclnnMatmul + aclnnMuls + aclnnAdd | |
| 40 | | 数据类型 | FLOAT16/FLOAT | FLOAT16/FLOAT | | 36 | | 数据类型 | FLOAT16/FLOAT | FLOAT16/FLOAT | |
| 41 | | 公式 | C = alpha × op(A) × op(B) + beta × C | 四步：Matmul → Muls(alpha) → Muls(beta) → Add | | 37 | | 公式 | C = alpha × op(A) × op(B) + beta × C | 四步：Matmul → Muls(alpha) → Muls(beta) → Add | |
| 42 | 38 | ||
| 43 | -| | | | | 39 | +| 新/老接口 | aclblas | aclnn组合方案 | |
| 44 | | --- | --- | --- | | 40 | | --- | --- | --- | |
| 45 | -| 新/老接口 | aclblas | aclnn 组合方案 | | ||
| 46 | | 接口名称 | aclblasHgemm<br>aclblasCreateHandleForHgemm | aclnnMatmul + aclnnMuls + aclnnAdd | | 41 | | 接口名称 | aclblasHgemm<br>aclblasCreateHandleForHgemm | aclnnMatmul + aclnnMuls + aclnnAdd | |
| 47 | | 数据类型 | FLOAT（固定） | FLOAT（固定） | | 42 | | 数据类型 | FLOAT（固定） | FLOAT（固定） | |
| 48 | | 公式 | C = alpha × op(A) × op(B) + beta × C | 四步：Matmul → Muls(alpha) → Muls(beta) → Add | | 43 | | 公式 | C = alpha × op(A) × op(B) + beta × C | 四步：Matmul → Muls(alpha) → Muls(beta) → Add | |
| 49 | 44 | ||
| 50 | -| | | | | 45 | +| 新/老接口 | aclblas | aclnn组合方案 | |
| 51 | | --- | --- | --- | | 46 | | --- | --- | --- | |
| 52 | -| 新/老接口 | aclblas | aclnn 组合方案 | | ||
| 53 | | 接口名称 | aclblasS8gemm<br>aclblasCreateHandleForS8gemm | aclnnQuantMatmulV5 + aclnnMuls + aclnnAdd | | 47 | | 接口名称 | aclblasS8gemm<br>aclblasCreateHandleForS8gemm | aclnnQuantMatmulV5 + aclnnMuls + aclnnAdd | |
| 54 | | 数据类型 | INT8 × INT8输入 → INT32输出 | INT8输入 → INT32输出 | | 48 | | 数据类型 | INT8 × INT8输入 → INT32输出 | INT8输入 → INT32输出 | |
| 55 | | 公式 | C = alpha × A × B + beta × C | 四步：QuantMatmulV5 → Muls(INT32) → Muls(INT32) → Add | | 49 | | 公式 | C = alpha × A × B + beta × C | 四步：QuantMatmulV5 → Muls(INT32) → Muls(INT32) → Add | |
| @@ -6,7 +6,7 @@ GE开发者工具链是graph engine中的一套面向个人开发者的自动化 | |||
| 6 | 6 | ||
| 7 | ## 前置准备 | 7 | ## 前置准备 |
| 8 | 8 | ||
| 9 | -下面是使用GE开发者工具链，需要手动进行的前置准备； | 9 | +下面是使用GE开发者工具链，需要手动进行的前置准备： |
| 10 | 10 | ||
| 11 | 下列是经过验证后的性能最佳推荐配置： | 11 | 下列是经过验证后的性能最佳推荐配置： |
| 12 | 12 | ||
| @@ -35,7 +35,7 @@ GE工具链对应的脚本在scripts下，可以按照下面流程来执行： | |||
| 35 | $ cd ./scripts | 35 | $ cd ./scripts |
| 36 | ``` | 36 | ``` |
| 37 | 37 | ||
| 38 | -2.执行`ge env`自动下载容器环境，并登陆到环境中 | 38 | +2.执行`ge env`自动下载容器环境，并登录到环境中 |
| 39 | 39 | ||
| 40 | ```sh | 40 | ```sh |
| 41 | $ ./ge.sh env | 41 | $ ./ge.sh env |
| @@ -109,12 +109,12 @@ Options: | |||
| 109 | ``` | 109 | ``` |
| 110 | 110 | ||
| 111 | 参数详细解释： | 111 | 参数详细解释： |
| 112 | -- `-b -- build`： 依据“scripts/env/Dockerfile”生成需要运行的容器镜像； | 112 | +- `-b -- build` : 依据“scripts/env/Dockerfile”生成需要运行的容器镜像； |
| 113 | -- `-p -- pull` ： 从本地配置的容器中央仓拉取需要的的容器镜像； | 113 | +- `-p -- pull` : 从本地配置的容器中央仓拉取需要的的容器镜像； |
| 114 | -- `-e -- enter`： 在本地已有容器镜像的前提下，登录容器运行环境； | 114 | +- `-e -- enter` : 在本地已有容器镜像的前提下，登录容器运行环境； |
| 115 | -- `-r -- reset`： 删除本地运行的容器镜像环境； | 115 | +- `-r -- reset` : 删除本地运行的容器镜像环境； |
| 116 | 116 | ||
| 117 | -默认：从中央容器仓拉取对应的容器镜像，运行实例并登陆。 | 117 | +默认：从中央容器仓拉取对应的容器镜像，运行实例并登录。 |
| 118 | 118 | ||
| 119 | ### `ge config` | 119 | ### `ge config` |
| 120 | 120 | ||
| @@ -215,14 +215,14 @@ Options: | |||
| 215 | 215 | ||
| 216 | 参数详细解释： | 216 | 参数详细解释： |
| 217 | 217 | ||
| 218 | -- `-u, --unit` : 执行单元测试 | 218 | +- `-u, --unit` : 执行单元测试； |
| 219 | -- `-c, --component` : 执行组件测试 | 219 | +- `-c, --component` : 执行组件测试； |
| 220 | 220 | ||
| 221 | 默认：执行单元测试。 | 221 | 默认：执行单元测试。 |
| 222 | 222 | ||
| 223 | ### `ge cov` | 223 | ### `ge cov` |
| 224 | 224 | ||
| 225 | -执行代码覆盖率检查, 支持全量覆盖和增量覆盖的功能，该命令需要已经跑完测试用例，目前可以支持参数如下： | 225 | +执行代码覆盖率检查，支持全量覆盖和增量覆盖的功能，该命令需要已经跑完测试用例，目前可以支持参数如下： |
| 226 | 226 | ||
| 227 | ```sh | 227 | ```sh |
| 228 | $ ge cov -h | 228 | $ ge cov -h |
| @@ -242,7 +242,7 @@ Options: | |||
| 242 | - `-i, --increment` : 执行增量覆盖率检查，默认是分析未提交修改的代码覆盖率（如果存在新增加的git未跟踪文件，需要先git add 添加进来才可以）； | 242 | - `-i, --increment` : 执行增量覆盖率检查，默认是分析未提交修改的代码覆盖率（如果存在新增加的git未跟踪文件，需要先git add 添加进来才可以）； |
| 243 | - `-d, --directory` : 代码进行增量覆盖率检查的代码路径，支持传入路径参数； | 243 | - `-d, --directory` : 代码进行增量覆盖率检查的代码路径，支持传入路径参数； |
| 244 | 244 | ||
| 245 | -默认：执行增量覆盖率检查； | 245 | +默认：执行增量覆盖率检查。 |
| 246 | 246 | ||
| 247 | 下面的命令演示了如何检查ge目录下所有代码的增量覆盖率： | 247 | 下面的命令演示了如何检查ge目录下所有代码的增量覆盖率： |
| 248 | 248 | ||
| @@ -6,7 +6,7 @@ Currently supports a series of common developer functions including container-ba | |||
| 6 | 6 | ||
| 7 | ## Prerequisites | 7 | ## Prerequisites |
| 8 | 8 | ||
| 9 | -Below are the manual prerequisites needed for using GE developer toolchain; | 9 | +Below are the manual prerequisites needed for using GE developer toolchain: |
| 10 | 10 | ||
| 11 | The following are verified best performance recommended configurations: | 11 | The following are verified best performance recommended configurations: |
| 12 | 12 | ||
| @@ -47,7 +47,7 @@ GE toolchain corresponding scripts are under scripts, can execute according to f | |||
| 47 | $ ge update | 47 | $ ge update |
| 48 | ``` | 48 | ``` |
| 49 | 49 | ||
| 50 | - (Note: After entering container, `ge` command already automatically registered into system, so container内 doesn't need to write script full name) | 50 | + (Note: After entering container, `ge` command already automatically registered into system, so container doesn't need to write script full name) |
| 51 | 51 | ||
| 52 | 4. Execute testing, default executes unit test cases, `ge test` will automatically trigger build | 52 | 4. Execute testing, default executes unit test cases, `ge test` will automatically trigger build |
| 53 | 53 | ||
| @@ -57,7 +57,7 @@ GE toolchain corresponding scripts are under scripts, can execute according to f | |||
| 57 | 57 | ||
| 58 | ## Detailed Usage | 58 | ## Detailed Usage |
| 59 | 59 | ||
| 60 | -Under scripts directory, run ./ge.sh -h to view all subcommand集合. | 60 | +Under scripts directory, run ./ge.sh -h to view all subcommands. |
| 61 | 61 | ||
| 62 | ```sh | 62 | ```sh |
| 63 | $ ./ge.sh -h | 63 | $ ./ge.sh -h |
| @@ -79,7 +79,7 @@ Commands: | |||
| 79 | clean Clean | 79 | clean Clean |
| 80 | ``` | 80 | ``` |
| 81 | 81 | ||
| 82 | -Each subcommand built into script represents an independent function; each subcommand also provides secondary parameters for flexible specification of execution方式. | 82 | +Each subcommand built into script represents an independent function; each subcommand also provides secondary parameters for flexible specification of execution method. |
| 83 | 83 | ||
| 84 | Each subcommand can view supported configurable parameters through `-h`. | 84 | Each subcommand can view supported configurable parameters through `-h`. |
| 85 | 85 | ||
| @@ -89,11 +89,11 @@ For example querying `env` subcommand parameters, can use following command: | |||
| 89 | $ ./ge.sh env -h | 89 | $ ./ge.sh env -h |
| 90 | ``` | 90 | ``` |
| 91 | 91 | ||
| 92 | -Each subcommand has a default behavior when不带参数. | 92 | +Each subcommand has a default behavior when no parameters are provided. |
| 93 | 93 | ||
| 94 | ### `ge env` | 94 | ### `ge env` |
| 95 | 95 | ||
| 96 | -This command用于 prepares container environment used for building and testing, specifically contains following parameters: | 96 | +This command is used to prepare container environment used for building and testing, specifically contains following parameters: |
| 97 | 97 | ||
| 98 | ```sh | 98 | ```sh |
| 99 | $ ./ge.sh env -h | 99 | $ ./ge.sh env -h |
| @@ -114,14 +114,14 @@ Parameter detailed explanation: | |||
| 114 | 114 | ||
| 115 | - `-b -- build`: Generate required running container image based on "scripts/env/Dockerfile"; | 115 | - `-b -- build`: Generate required running container image based on "scripts/env/Dockerfile"; |
| 116 | - `-p -- pull`: Pull required container image from locally configured container central repository; | 116 | - `-p -- pull`: Pull required container image from locally configured container central repository; |
| 117 | -- `-e -- enter`: Login to container runtime environment前提 existing local container image; | 117 | +- `-e -- enter`: Login to container runtime environment with existing local container image; |
| 118 | - `-r -- reset`: Delete local running container image environment; | 118 | - `-r -- reset`: Delete local running container image environment; |
| 119 | 119 | ||
| 120 | Default: Pull corresponding container image from central container repository, run instance and login. | 120 | Default: Pull corresponding container image from central container repository, run instance and login. |
| 121 | 121 | ||
| 122 | ### `ge config` | 122 | ### `ge config` |
| 123 | 123 | ||
| 124 | -Configure external dependency server, specific parameters如下: | 124 | +Configure external dependency server, specific parameters are as follows: |
| 125 | 125 | ||
| 126 | ```sh | 126 | ```sh |
| 127 | $ ge config -h | 127 | $ ge config -h |
| @@ -136,20 +136,20 @@ Options: | |||
| 136 | -p, --password Config password | 136 | -p, --password Config password |
| 137 | -h, --help | 137 | -h, --help |
| 138 | 138 | ||
| 139 | -Example: ge config -i=<ip-adress> -u=<username> -p=<password> (Need add escape character \ before special character $、#、!) | 139 | +Example: ge config -i=<ip-adress> -u=<username> -p=<password> (Need add escape character \ before special character $, #, !) |
| 140 | ``` | 140 | ``` |
| 141 | 141 | ||
| 142 | Parameter detailed explanation: | 142 | Parameter detailed explanation: |
| 143 | 143 | ||
| 144 | - `-i, --ip` : Configure dependency library server IP address; | 144 | - `-i, --ip` : Configure dependency library server IP address; |
| 145 | -- `-u, --usr` : Configure dependency library server username; | 145 | +- `-u, --user` : Configure dependency library server username; |
| 146 | - `-p, --password` : Configure dependency library address; | 146 | - `-p, --password` : Configure dependency library address; |
| 147 | 147 | ||
| 148 | Default: Print help information. | 148 | Default: Print help information. |
| 149 | 149 | ||
| 150 | ### `ge update` | 150 | ### `ge update` |
| 151 | 151 | ||
| 152 | -Install external dependency libraries required for graph engine building, specific parameters如下: | 152 | +Install external dependency libraries required for graph engine building, specific parameters are as follows: |
| 153 | 153 | ||
| 154 | ```sh | 154 | ```sh |
| 155 | $ ge update -h | 155 | $ ge update -h |
| @@ -178,7 +178,7 @@ Default: Download external dependency libraries according to "scripts/update/dep | |||
| 178 | 178 | ||
| 179 | ### `ge format` | 179 | ### `ge format` |
| 180 | 180 | ||
| 181 | -Use clang-format for code formatting, specific parameters如下: | 181 | +Use clang-format for code formatting, specific parameters are as follows: |
| 182 | 182 | ||
| 183 | ```sh | 183 | ```sh |
| 184 | $ ge format -h | 184 | $ ge format -h |
| @@ -218,14 +218,14 @@ Options: | |||
| 218 | 218 | ||
| 219 | Parameter detailed explanation: | 219 | Parameter detailed explanation: |
| 220 | 220 | ||
| 221 | -- `-u, --unit` : Execute unit testing | 221 | +- `-u, --unit` : Execute unit testing; |
| 222 | -- `-c, --component` : Execute component testing | 222 | +- `-c, --component` : Execute component testing; |
| 223 | 223 | ||
| 224 | Default: Execute unit testing. | 224 | Default: Execute unit testing. |
| 225 | 225 | ||
| 226 | ### `ge cov` | 226 | ### `ge cov` |
| 227 | 227 | ||
| 228 | -Execute code coverage checking, supports full coverage and increment coverage functions, this command需要 already ran test cases, currently supports following parameters: | 228 | +Execute code coverage checking, supports full coverage and increment coverage functions, this command requires already ran test cases, currently supports following parameters: |
| 229 | 229 | ||
| 230 | ```sh | 230 | ```sh |
| 231 | $ ge cov -h | 231 | $ ge cov -h |
| @@ -242,10 +242,10 @@ Options: | |||
| 242 | Parameter detailed explanation: | 242 | Parameter detailed explanation: |
| 243 | 243 | ||
| 244 | - `-a, --all` : Execute full coverage rate statistics; | 244 | - `-a, --all` : Execute full coverage rate statistics; |
| 245 | -- `-i, --increment` : Execute increment coverage checking, default analyzes uncommitted modified code coverage (if new git untracked files exist, need先 git add to add in); | 245 | +- `-i, --increment` : Execute increment coverage checking, default analyzes uncommitted modified code coverage (if new git untracked files exist, need to git add to add in first); |
| 246 | - `-d, --directory` : Code path for increment coverage checking, supports passing path parameters; | 246 | - `-d, --directory` : Code path for increment coverage checking, supports passing path parameters; |
| 247 | 247 | ||
| 248 | -Default: Execute increment coverage checking; | 248 | +Default: Execute increment coverage checking. |
| 249 | 249 | ||
| 250 | Below command demonstrates how to check all code's increment coverage under ge directory: | 250 | Below command demonstrates how to check all code's increment coverage under ge directory: |
| 251 | 251 | ||
| @@ -255,7 +255,7 @@ $ ge cov -d=ge | |||
| 255 | 255 | ||
| 256 | ### `ge docs` | 256 | ### `ge docs` |
| 257 | 257 | ||
| 258 | -Doxygen document generation, includes code logic and physical structure and relationships, convenient for reading and understanding code; currently supports following parameters: | 258 | +Doxygen document generation, includes code logic and physical structure and relationships, convenient for reading and understanding code, currently supports following parameters: |
| 259 | 259 | ||
| 260 | ```sh | 260 | ```sh |
| 261 | $ ge docs -h | 261 | $ ge docs -h |
| @@ -270,14 +270,14 @@ Options: | |||
| 270 | 270 | ||
| 271 | Parameter detailed explanation: | 271 | Parameter detailed explanation: |
| 272 | 272 | ||
| 273 | -- `-b, --brief`: Generate brief documents, ignore部分 relationship diagram generation, fast speed; | 273 | +- `-b, --brief`: Generate brief documents, ignore some relationship diagram generation, fast speed; |
| 274 | - `-a, --all`: Generate full documents, includes various code relationship diagrams, relatively slow speed; | 274 | - `-a, --all`: Generate full documents, includes various code relationship diagrams, relatively slow speed; |
| 275 | 275 | ||
| 276 | Default: Generate full code documents. | 276 | Default: Generate full code documents. |
| 277 | 277 | ||
| 278 | ### `ge clean` | 278 | ### `ge clean` |
| 279 | 279 | ||
| 280 | -Clean various downloaded or generated intermediate files, currently supported parameters如下: | 280 | +Clean various downloaded or generated intermediate files, currently supported parameters are as follows: |
| 281 | 281 | ||
| 282 | ```sh | 282 | ```sh |
| 283 | $ ge clean -h | 283 | $ ge clean -h |
| @@ -303,4 +303,4 @@ Default: Clean temporary files generated by compilation build. | |||
| 303 | 303 | ||
| 304 | ## Follow us | 304 | ## Follow us |
| 305 | 305 | ||
| 306 | -Toolchain functionality还在 continuously improving, please submit issue if problems, thank you! | 306 | +Toolchain functionality is continuously improving, please submit issue if problems, thank you! |