提交 0bfe7d08 编写于 作者: M mindspore-ci-bot 提交者: Gitee

!226 Fix Profiler api comment format bug

Merge pull request !226 from wangyue/profiler_api_comment
......@@ -20,7 +20,7 @@ To enable profiling on MindSpore, the MindInsight Profiler apis should be added
Example:
context.set_context(mode=context.GRAPH_MODE, device_target="Ascend", device_id=int(os.environ["DEVICE_ID"]))
profiler = Profiler(output_path="./data", is_detail=True, is_show_op_path=False, subgraph='All')
profiler = Profiler(output_path="./data", is_detail=True, is_show_op_path=False, subgraph='all')
net = Net()
Parameters of Profiler including:
......
......@@ -40,17 +40,17 @@ class Profiler:
Enable MindSpore users to profile the performance of neural network.
Args:
subgraph (str): Define which subgraph to monitor and analyse, can be 'all', 'Default', 'Gradients'.
is_detail (bool): Whether to show profiling data for op_instance level, only show optype level if False.
is_show_op_path (bool): Whether to save the full path for each op instance.
output_path (str): Output data path.
optypes_to_deal (list[str]): Op type names, the data of which optype should be collected and analysed,
will deal with all op if null.
optypes_not_deal (list[str]): Op type names, the data of which optype will not be collected and analysed.
subgraph (str): Define which subgraph to monitor and analyse, can be 'all', 'Default', 'Gradients'.
is_detail (bool): Whether to show profiling data for op_instance level, only show optype level if False.
is_show_op_path (bool): Whether to save the full path for each op instance.
output_path (str): Output data path.
optypes_to_deal (list[str]): Op type names, the data of which optype should be collected and analysed,
will deal with all op if null.
optypes_not_deal (list[str]): Op type names, the data of which optype will not be collected and analysed.
Examples:
>>> from mindinsight.profiler import Profiler
>>> context.set_context(mode=context.GRAPH_MODE, device_target=“Ascend”,
>>> context.set_context(mode=context.GRAPH_MODE, device_target="Ascend",
>>> device_id=int(os.environ["DEVICE_ID"]))
>>> profiler = Profiler(subgraph='all', is_detail=True, is_show_op_path=False, output_path='./data')
>>> model = Model(train_network)
......@@ -128,7 +128,7 @@ class Profiler:
Examples:
>>> from mindinsight.profiler import Profiler
>>> context.set_context(mode=context.GRAPH_MODE, device_target=“Ascend”,
>>> context.set_context(mode=context.GRAPH_MODE, device_target="Ascend",
>>> device_id=int(os.environ["DEVICE_ID"]))
>>> profiler = Profiler(subgraph='all', is_detail=True, is_show_op_path=False, output_path='./data')
>>> model = Model(train_network)
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册