From 4218da33d00ff0aac14877d96670e3ab4ec4bbd7 Mon Sep 17 00:00:00 2001 From: wangyue01 Date: Fri, 29 May 2020 11:49:58 +0800 Subject: [PATCH] Fix profiler api comments for the docs --- mindinsight/profiler/__init__.py | 2 +- mindinsight/profiler/profiling.py | 10 +++++----- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/mindinsight/profiler/__init__.py b/mindinsight/profiler/__init__.py index e7b3674..b7ec016 100644 --- a/mindinsight/profiler/__init__.py +++ b/mindinsight/profiler/__init__.py @@ -13,7 +13,7 @@ # limitations under the License. # ============================================================================ """ -Profiler Module Introduction +Profiler Module Introduction. This module provides Python APIs to enable the profiling of MindSpore neural networks. Users can import the mindinsight.profiler.Profiler, initialize the Profiler object to start profiling, diff --git a/mindinsight/profiler/profiling.py b/mindinsight/profiler/profiling.py index 5bf1b10..a0fc18f 100644 --- a/mindinsight/profiler/profiling.py +++ b/mindinsight/profiler/profiling.py @@ -37,16 +37,16 @@ class Profiler: """ Performance profiling API. - Enable MindSpore users to profile the neural network. + Enable MindSpore users to profile the performance of neural network. Args: - subgraph (str): Defines which subgraph to monitor and analyse, can be 'all', 'Default', 'Gradients'. + 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): Op type names, the data of which optype should be collected and analysed, - will deal with all op if null. - optypes_not_deal (list): Op type names, the data of which optype will not be collected and analysed. + 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 -- GitLab