add compare_accuracy

PaddlePaddle · May 11, 2023 · 007d5e9 · 007d5e9
1 parent b37b401
commit 007d5e9
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/docs/api/paddle/amp/Overview_cn.rst b/docs/api/paddle/amp/Overview_cn.rst
@@ -95,6 +95,7 @@ Debug 相关辅助类
 .. csv-table::
     :header: "API 名称", "API 功能"
     :widths: 10, 30
-    
+
     " :ref:`enable_tensor_checker <cn_api_amp_debugging_enable_tensor_checker>` ", "开启模块级别的精度检查"
     " :ref:`disable_tensor_checker <cn_api_amp_debugging_disable_tensor_checker>` ", "关闭模块级别的精度检查"
+    " :ref:`compare_accuracy <cn_api_amp_debugging_compare_accuracy>` ", "精度比对接口"
diff --git a/docs/api/paddle/amp/debugging/compare_accuracy_cn.rst b/docs/api/paddle/amp/debugging/compare_accuracy_cn.rst
@@ -12,7 +12,7 @@ compare_accuracy
     - **another_dump_path** (str): 另一份运行日志的路径，比如数据类型是 float16 的训练日志。
     - **output_filename** (str): 输出 excel 的文件名，用于保存两份日志的比对结果。
     - **loss_scale** (float, 可选): 训练阶段的 loss_scale，默认是 1。
-    - **dump_all_tensors** (bool, 可选): dump 所有的 tensor 数据，当前还不支持这个参数，默认是 False。
+    - **dump_all_tensors** (bool, 可选): True 表示 dump 所有的 tensor 数据，False 表示不做处理，当前还不支持这个参数，默认是 False。
 
 
 返回值
@@ -23,4 +23,3 @@ compare_accuracy
 :::::::::
 
 COPY-FROM: paddle.amp.debugging.compare_accuracy
-~