未验证 提交 0c55c79f 编写于 作者: W wangchaochaohu 提交者: GitHub

Polish profiler doc (#22815)

* polish the profiler doc
上级 15e59c31
...@@ -137,15 +137,15 @@ def start_profiler(state, tracer_option='Default'): ...@@ -137,15 +137,15 @@ def start_profiler(state, tracer_option='Default'):
or 'All'. 'CPU' means only profiling CPU; 'GPU' means profiling or 'All'. 'CPU' means only profiling CPU; 'GPU' means profiling
both CPU and GPU; 'All' means profiling both CPU and GPU, and both CPU and GPU; 'All' means profiling both CPU and GPU, and
generates timeline as well. generates timeline as well.
tracer_option (str) : tracer_option can be one of ['Default', 'OpDetail', 'AllOpDetail'], it tracer_option (str, optional) : tracer_option can be one of ['Default', 'OpDetail', 'AllOpDetail'], it
can control the profile level and print the different level profile result. Default option print can control the profile level and print the different level profile result. `Default` option print
the different Op type profiling result and the OpDetail option print the detail profiling the different Op type profiling result and the `OpDetail` option print the detail profiling
result of different op types such as compute and data transform, AllOpDetail option result of different op types such as compute and data transform, `AllOpDetail` option
print the detail profiling result of different op name same as OpDetail. print the detail profiling result of different op name same as `OpDetail`.
Raises: Raises:
ValueError: If `state` is not in ['CPU', 'GPU', 'All']. ValueError: If `state` is not in ['CPU', 'GPU', 'All'] or `tracer_option`
ValueError: If `tracer_option` is not in ['Default', 'OpDetail', 'AllOpDetail'] is not in ['Default', 'OpDetail', 'AllOpDetail'].
Examples: Examples:
...@@ -274,11 +274,11 @@ def profiler(state, ...@@ -274,11 +274,11 @@ def profiler(state,
The `ave` means sorting by the average execution time. The `ave` means sorting by the average execution time.
profile_path (str, optional) : If state == 'All', it will generate timeline, profile_path (str, optional) : If state == 'All', it will generate timeline,
and write it into `profile_path`. The default profile_path is `/tmp/profile`. and write it into `profile_path`. The default profile_path is `/tmp/profile`.
tracer_option (str) : tracer_option can be one of ['Default', 'OpDetail', 'AllOpDetail'], it tracer_option (str, optional) : tracer_option can be one of ['Default', 'OpDetail', 'AllOpDetail'], it
can control the profile level and print the different level profile result. Default option print can control the profile level and print the different level profile result. `Default` option print
the different Op type profiling result and the OpDetail option print the detail profiling the different Op type profiling result and the `OpDetail` option print the detail profiling
result of different op types such as compute and data transform, AllOpDetail option result of different op types such as compute and data transform, `AllOpDetail` option
print the detail profiling result of different op name same as OpDetail. print the detail profiling result of different op name same as `OpDetail`.
Raises: Raises:
ValueError: If `state` is not in ['CPU', 'GPU', 'All']. If `sorted_key` is ValueError: If `state` is not in ['CPU', 'GPU', 'All']. If `sorted_key` is
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册