From a1a8cc5734451a086f3ed4857b84f427f3c5401b Mon Sep 17 00:00:00 2001 From: caishangqiu Date: Thu, 7 Mar 2024 17:21:26 +0800 Subject: [PATCH] =?UTF-8?q?[accuracy=5Ftools]=E7=B2=BE=E5=BA=A6=E5=B7=A5?= =?UTF-8?q?=E5=85=B7=E6=96=B0=E5=A2=9E=E5=90=88=E4=B8=80=E5=8C=85=E5=AE=89?= =?UTF-8?q?=E8=A3=85=E5=92=8C=E5=91=BD=E4=BB=A4=E8=A1=8C=E6=8C=87=E5=AF=BC?= =?UTF-8?q?=E6=89=8B=E5=86=8C?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- debug/accuracy_tools/README_POC.md | 41 ++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 debug/accuracy_tools/README_POC.md diff --git a/debug/accuracy_tools/README_POC.md b/debug/accuracy_tools/README_POC.md new file mode 100644 index 000000000..d7d081520 --- /dev/null +++ b/debug/accuracy_tools/README_POC.md @@ -0,0 +1,41 @@ +# 精度工具 + +本手册主要介绍精度预检工具和ptdbg_ascend精度工具合一软件包的安装和工具命令行使用指导。 + +## 工具安装 + +精度工具合一软件包名称为：`ascend_training_accuracy_tools-{version}-py3-none-any.whl` + +执行如下命令进行安装。 + +``` +pip3 install ./ascend_training_accuracy_tools-{version}-py3-none-any.whl +``` + +若为覆盖安装，请在命令行末尾增加“--force-reinstall”参数强制安装，例如： + +``` +pip3 install ./ascend_training_accuracy_tools-{version}-py3-none-any.whl --force-reinstall +``` + +提示如下信息则表示安装成功。 + +``` +Successfully installed ascend_training_accuracy_tools-{version} +``` + +## 工具使用 + +安装精度工具合一软件包后，精度工具支持使用命令行启动各种功能（除ptdbg_ascend工具的dump和精度比对操作）。命令格式如下： + +```bash +atat [-h] parse run_ut multi_run_ut benchmark_compare run_overflow_check +``` + +| 参数 | 说明 | +| ------------------ | ------------------------------------------------------------ | +| parse | ptdbg_ascend.parse数据解析功能入口，执行atat parse命令后进入parse交互式界面，更多参数请参见《[ptdbg_ascend精度工具功能说明](https://gitee.com/ascend/att/tree/master/debug/accuracy_tools/ptdbg_ascend/doc)》的“ptdbg_ascend.parse数据解析功能”。 | +| run_ut | 预检工具run_ut功能，可以通过atat run_ut命令执行精度预检操作，更多参数请参见《[Ascend模型精度预检工具](https://gitee.com/ascend/att/tree/master/debug/accuracy_tools/api_accuracy_checker)》的“执行预检”。 | +| multi_run_ut | 预检工具multi_run_ut功能，可以通过atat multi_run_ut命令执行多线程预检操作，更多参数请参见《[Ascend模型精度预检工具](https://gitee.com/ascend/att/tree/master/debug/accuracy_tools/api_accuracy_checker)》的“multi_run_ut多线程预检”。 | +| benchmark_compare | 预检工具预检结果比对功能，可以通过atat benchmark_compare命令执行预检结果比对操作，更多参数请参见《[Ascend模型精度预检工具](https://gitee.com/ascend/att/tree/master/debug/accuracy_tools/api_accuracy_checker)》的“multi_run_ut多线程预检”。 | +| run_overflow_check | 溢出解析工具，可以通过atat run_overflow_check命令执行溢出API解析操作，更多参数请参见《[Ascend模型精度预检工具](https://gitee.com/ascend/att/tree/master/debug/accuracy_tools/api_accuracy_checker)》的“溢出解析工具”。 | \ No newline at end of file -- Gitee