From 6de67977cf2447710795e81b98c37675179633d4 Mon Sep 17 00:00:00 2001 From: wangyue01 Date: Sat, 30 May 2020 11:10:33 +0800 Subject: [PATCH] fix Profiler api comment format bug --- mindinsight/profiler/README.md | 2 +- mindinsight/profiler/profiling.py | 18 +++++++++--------- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/mindinsight/profiler/README.md b/mindinsight/profiler/README.md index 4943f2f..5a9ce56 100644 --- a/mindinsight/profiler/README.md +++ b/mindinsight/profiler/README.md @@ -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： diff --git a/mindinsight/profiler/profiling.py b/mindinsight/profiler/profiling.py index 83abb2d..73d3cd3 100644 --- a/mindinsight/profiler/profiling.py +++ b/mindinsight/profiler/profiling.py @@ -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) -- GitLab