Skip to content

Commit 56ffdc8

Browse files
authored
Merge pull request #456 from tink2123/new_commit_1207
fix some typo in api_cn
2 parents b06883f + 6e6fc9c commit 56ffdc8

File tree

3 files changed

+12
-256
lines changed

3 files changed

+12
-256
lines changed

doc/fluid/api_cn/index_cn.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,4 @@ API Reference
2222
param_attr_cn.rst
2323
profiler_cn.rst
2424
regularizer_cn.rst
25-
transpliter_cn.rst
25+
transpiler_cn.rst

doc/fluid/api_cn/profiler_cn.rst

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,10 @@ CUDA分析器。通过CUDA运行时应用程序编程接口对CUDA程序进行
1818
参数:
1919
- **output_file** (string) – 输出文件名称, 输出结果将会写入该文件
2020
- **output_mode** (string) – 输出格式是有 key-value 键值对 和 逗号的分割的格式。格式应该是' kvp '或' csv '
21-
- **config** (list of string) – 参考Compute Command Line Profiler User Guide 查阅 profiler options 和 counter相关信息
21+
- **config** (list of string) – 参考"Compute Command Line Profiler User Guide" 查阅 profiler options 和 counter相关信息
2222

2323
抛出异常:
24-
- ``ValueError`` - 如果 ``output_mode`` 不在 [kvp’, ‘csv] 中
24+
- ``ValueError`` - 如果 ``output_mode`` 不在 ['kvp', 'csv'] 中
2525

2626

2727
**代码示例**
@@ -70,12 +70,12 @@ profile interface 。与cuda_profiler不同,此profiler可用于分析CPU和GP
7070
如果 state== ' All ',在profile_path 中写入文件 profile proto 。该文件记录执行期间的时间顺序信息。然后用户可以看到这个文件的时间轴,请参考 `https://github.com/PaddlePaddle/Paddle/blob/develop/doc/fluid/howto/optimization/timeline.md <https://github.com/PaddlePaddle/Paddle/blob/develop/doc/fluid/howto/optimization/timeline.md>`_
7171

7272
参数:
73-
- **state** (string) – profiling state, 取值为 CPUGPU, profiler 使用 CPU timer 或GPU timer 进行 profiling. 虽然用户可能在开始时指定了执行位置(CPUPlace/CUDAPlace),但是为了灵活性,profiler不会使用这个位置。
74-
- **sorted_key** (string) – 如果为None,prfile的结果将按照事件的第一次结束时间顺序打印。否则,结果将按标志排序。标志取值为call”、“total”、“max”、“min” “ave之一,根据调用着的数量进行排序。total表示按总执行时间排序,max 表示按最大执行时间排序。min 表示按最小执行时间排序。ave表示按平均执行时间排序。
75-
- **profile_path** (string) – 如果 state == All, 结果将写入文件 profile proto.
73+
- **state** (string) – profiling state, 取值为 'CPU''GPU', profiler 使用 CPU timer 或GPU timer 进行 profiling. 虽然用户可能在开始时指定了执行位置(CPUPlace/CUDAPlace),但是为了灵活性,profiler不会使用这个位置。
74+
- **sorted_key** (string) – 如果为None,prfile的结果将按照事件的第一次结束时间顺序打印。否则,结果将按标志排序。标志取值为"call"、"total"、"max"、"min" "ave"之一,根据调用着的数量进行排序。total表示按总执行时间排序,max 表示按最大执行时间排序。min 表示按最小执行时间排序。ave表示按平均执行时间排序。
75+
- **profile_path** (string) – 如果 state == 'All', 结果将写入文件 profile proto.
7676

7777
抛出异常:
78-
- ``ValueError`` – 如果state 取值不在 [CPU’, ‘GPU’, ‘All]中. 如果 sorted_key 取值不在 [calls’, ‘total’, ‘max’, ‘min’, ‘ave]
78+
- ``ValueError`` – 如果state 取值不在 ['CPU', 'GPU', 'All']中. 如果 sorted_key 取值不在 ['calls', 'total', 'max', 'min', 'ave']
7979

8080
**代码示例**
8181

@@ -139,10 +139,10 @@ start_profiler
139139
如果 state== ' All ',在profile_path 中写入文件 profile proto 。该文件记录执行期间的时间顺序信息。然后用户可以看到这个文件的时间轴,请参考 `https://github.com/PaddlePaddle/Paddle/blob/develop/doc/fluid/howto/optimization/timeline.md <https://github.com/PaddlePaddle/Paddle/blob/develop/doc/fluid/howto/optimization/timeline.md>`_
140140

141141
参数:
142-
- **state** (string) – profiling state, 取值为 CPUGPUAll’, ‘CPU 代表只分析 cpu. GPU 代表只分析 GPU . All 会产生 timeline.
142+
- **state** (string) – profiling state, 取值为 'CPU''GPU''All', 'CPU' 代表只分析 cpu. 'GPU' 代表只分析 GPU . 'All' 会产生 timeline.
143143

144144
抛出异常:
145-
- ``ValueError`` – 如果state 取值不在 [CPU’, ‘GPU’, ‘All]中
145+
- ``ValueError`` – 如果state 取值不在 ['CPU', 'GPU', 'All']中
146146

147147
**代码示例**
148148

@@ -177,12 +177,12 @@ stop_profiler
177177
不能使用 fluid.profiler.profiler``
178178

179179
参数:
180-
- **sorted_key** (string) – 如果为None,prfile的结果将按照事件的第一次结束时间顺序打印。否则,结果将按标志排序。标志取值为call”、“total”、“max”、“min” “ave之一,根据调用着的数量进行排序。total表示按总执行时间排序,max 表示按最大执行时间排序。min 表示按最小执行时间排序。ave表示按平均执行时间排序。
181-
- **profile_path** (string) - 如果 state == All, 结果将写入文件 profile proto.
180+
- **sorted_key** (string) – 如果为None,prfile的结果将按照事件的第一次结束时间顺序打印。否则,结果将按标志排序。标志取值为"call"、"total"、"max"、"min" "ave"之一,根据调用着的数量进行排序。total表示按总执行时间排序,max 表示按最大执行时间排序。min 表示按最小执行时间排序。ave表示按平均执行时间排序。
181+
- **profile_path** (string) - 如果 state == 'All', 结果将写入文件 profile proto.
182182

183183

184184
抛出异常:
185-
- ``ValueError`` – 如果state 取值不在 [CPU’, ‘GPU’, ‘All]中
185+
- ``ValueError`` – 如果state 取值不在 ['CPU', 'GPU', 'All']中
186186

187187
**代码示例**
188188

doc/fluid/api_cn/transpliter_cn.rst

Lines changed: 0 additions & 244 deletions
This file was deleted.

0 commit comments

Comments
 (0)