Browse Source

!213 Modify profiler api comments for the docs

Merge pull request !213 from wangyue/r0.3_profiler_api_doc
pull/213/MERGE
mindspore-ci-bot Gitee 5 years ago
parent
commit
64154380ec
2 changed files with 6 additions and 6 deletions
  1. +1
    -1
      mindinsight/profiler/__init__.py
  2. +5
    -5
      mindinsight/profiler/profiling.py

+ 1
- 1
mindinsight/profiler/__init__.py View File

@@ -13,7 +13,7 @@
# limitations under the License. # limitations under the License.
# ============================================================================ # ============================================================================
""" """
Profiler Module Introduction
Profiler Module Introduction.


This module provides Python APIs to enable the profiling of MindSpore neural networks. 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, Users can import the mindinsight.profiler.Profiler, initialize the Profiler object to start profiling,


+ 5
- 5
mindinsight/profiler/profiling.py View File

@@ -37,16 +37,16 @@ class Profiler:
""" """
Performance profiling API. Performance profiling API.


Enable MindSpore users to profile the neural network.
Enable MindSpore users to profile the performance of neural network.


Args: 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_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. is_show_op_path (bool): Whether to save the full path for each op instance.
output_path (str): Output data path. 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: Examples:
>>> from mindinsight.profiler import Profiler >>> from mindinsight.profiler import Profiler


Loading…
Cancel
Save