mindspore 2.5.0__cp311-cp311-win_amd64.whl → 2.6.0rc1__cp311-cp311-win_amd64.whl

mindspore/profiler/profiler.py

@@ -15,7 +15,7 @@
 """Profiling api file."""
 import os
 import json
-from typing import Optional, Dict
+from typing import Optional, Dict, Callable, Any
 from sys import getsizeof
 from concurrent.futures import ProcessPoolExecutor, as_completed
 
@@ -24,24 +24,36 @@ from mindspore.profiler.common.constant import ProfilerStepNameConstant, DeviceT
 from mindspore.profiler.common.profiler_context import ProfilerContext
 from mindspore.profiler.platform.npu_profiler import NPUProfilerAnalysis
 from mindspore.profiler.profiler_action_controller import ProfilerActionController
+from mindspore.profiler.experimental_config import _ExperimentalConfig
 from mindspore.profiler.profiler_interface import ProfilerInterface
-from mindspore.profiler.schedule import _default_schedule_fn, ProfilerAction
+from mindspore.profiler.schedule import _default_schedule_fn, ProfilerAction, Schedule
 from mindspore.profiler.common.record_function import RecordFunction
 from mindspore.profiler.common.path_manager import PathManager
-from mindspore.profiler.common.file_manager import FileManager
 from mindspore.profiler.common.profiler_path_manager import ProfilerPathManager
+from mindspore.profiler.common.profiler_meta_data import ProfilerMetaData
 
 
-def tensor_board_trace_handler():
+def tensorboard_trace_handler(dir_name: str = None, worker_name: str = None,
+                              analyse_flag: bool = True, async_mode: bool = False):
     """
     For each step in dynamic graph mode, call this method for online analyse.
 
+    Args:
+        dir_name (str, optional): Specifies the directory path to save the analysis results. The default is ``None``.
+            The default save path is ``"./data"``.
+        worker_name (str, optional): Specifies the system version name. The default is ``None``. The default project
+            thread name is ``"Name of the current operating system + process ID"``.
+        analyse_flag (bool, optional): Whether to enable online analysis. The default value is ``True``.
+            Indicates online analysis.
+        async_mode (bool, optional): Whether to use asynchronous parsing mode. The default value is ``False``. Indicates
+            the use of synchronous parsing mode.
+
     Examples:
         >>> import numpy as np
-        >>> import mindspore as ms
+        >>> import mindspore
         >>> import mindspore.dataset as ds
-        >>> from mindspore import context, nn, Profiler
-        >>> from mindspore.profiler import schedule, tensor_board_trace_handler
+        >>> from mindspore import context, nn
+        >>> from mindspore.profiler import ProfilerLevel, AicoreMetrics, ExportType, ProfilerActivity
         >>>
         >>> class Net(nn.Cell):
         ...     def __init__(self):
@@ -59,32 +71,55 @@ def tensor_board_trace_handler():
         ...     optimizer = nn.Momentum(test_net.trainable_params(), 1, 0.9)
         ...     loss = nn.SoftmaxCrossEntropyWithLogits(sparse=True)
         ...     data = ds.GeneratorDataset(generator_net(), ["data", "label"])
-        ...     model = ms.train.Model(test_net, loss, optimizer)
+        ...     model = mindspore.train.Model(test_net, loss, optimizer)
         ...     model.train(1, data)
         >>>
         >>> if __name__ == '__main__':
-        ...     context.set_context(mode=ms.PYNATIVE_MODE, device_target="Ascend")
+        ...     # If the device_target is GPU, set the device_target to "GPU"
+        ...     context.set_context(mode=mindspore.GRAPH_MODE)
+        ...     mindspore.set_device("Ascend")
         ...
+        ...     # Init Profiler
+        ...     experimental_config = mindspore.profiler._ExperimentalConfig(
+        ...                                 profiler_level=ProfilerLevel.Level0,
+        ...                                 aic_metrics=AicoreMetrics.AiCoreNone,
+        ...                                 l2_cache=False,
+        ...                                 mstx=False,
+        ...                                 data_simplification=False,
+        ...                                 export_type=[ExportType.Text])
+        ...     steps = 10
         ...     net = Net()
-        ...     STEP_NUM = 15
+        ...     # Note that the Profiler should be initialized before model.train
+        ...     with mindspore.profiler.profile(activities=[ProfilerActivity.CPU, ProfilerActivity.NPU],
+        ...                                     schedule=mindspore.profiler.schedule(wait=1, warmup=1, active=2,
+        ...                                           repeat=1, skip_first=2),
+        ...                                     on_trace_ready=mindspore.profiler.tensorboard_trace_handler("./data"),
+        ...                                     profile_memory=False,
+        ...                                     experimental_config=experimental_config) as prof:
         ...
-        ...     with Profiler(schedule=schedule(wait=1, warmup=1, active=2, repeat=1, skip_first=2),
-        ...                   on_trace_ready=tensor_board_trace_handler) as prof:
-        ...         for i in range(STEP_NUM):
+        ...         # Train Model
+        ...         for step in range(steps):
         ...             train(net)
         ...             prof.step()
     """
+    ProfilerPathManager().init(worker_name, dir_name)
+    if not isinstance(analyse_flag, bool):
+        logger.warning("analyse_flag is not bool, set by default.")
+        analyse_flag = True
+    if not isinstance(async_mode, bool):
+        logger.warning("async_mode is not bool, set by default.")
+        async_mode = False
 
-    try:
-        NPUProfilerAnalysis.online_analyse()
-        if ProfilerContext().data_simplification:
-            ProfilerPathManager().simplify_data()
-    except Exception as e:  # pylint: disable=W0703
-        logger.error("Call tensorboard_trace_handler failed. Exception: %s", str(e))
+    def handler_fn() -> None:
+        if analyse_flag:
+            NPUProfilerAnalysis.online_analyse(async_mode=async_mode)
+
+    return handler_fn
 
 
 class Profiler:
     r"""
+    The current interface is deprecated, please use: :class:`mindspore.profiler.profile` instead.
     This class to enable the profiling of MindSpore neural networks.
     MindSpore users can import the mindspore.Profiler, initialize the Profiler object to start profiling,
     and use Profiler.analyse() to stop profiling and analyse the results.
@@ -100,6 +135,8 @@ class Profiler:
         profiler_level (ProfilerLevel, optional): (Ascend only) The level of profiling.
             Default: ``ProfilerLevel.Level0``.
 
+            - ProfilerLevel.LevelNone: This setting takes effect only when mstx is enabled, indicating that no operator
+              data is collected on the device side.
             - ProfilerLevel.Level0: Leanest level of profiling data collection, collects information about the elapsed
               time of the computational operators on the NPU and communication large operator information.
             - ProfilerLevel.Level1: Collect more CANN layer AscendCL data and AICore performance metrics and
@@ -112,18 +149,23 @@ class Profiler:
             - ProfilerActivity.NPU: Collect CANN software stack and NPU data.
             - ProfilerActivity.GPU: Collect GPU data.
         schedule (schedule, optional): Sets the action strategy for the capture, defined by the schedule class,
-            to be used with the step interface. Default: ``None``.
+            to be used with the step interface. Default: ``None``. Performance data of all steps is collected.
+            For details, see :class:`mindspore.profiler.schedule` .
         on_trace_ready (Callable, optional): Sets the callback function to be executed when the performance data
-            is collected. Default: ``None``.
+            is collected. Default: ``None``. It indicates that only performance data is collected, but not resolved.
+            For details, see :func:`mindspore.profiler.tensorboard_trace_handler` .
         profile_memory (bool, optional): (Ascend only) Whether to collect tensor memory data, collect when ``True`` .
             When using this parameter, `activities` must set to ``[ProfilerActivity.CPU, ProfilerActivity.NPU]``.
             Collecting operator memory data when the graph compilation level is O2 requires collecting from the
             first step. Default: ``False`` . The operator name currently collected by this parameter is incomplete.
             This issue will be resolved in later versions. It is recommended to use the environment variable
             ``MS_ALLOC_CONF`` instead.
-        aicore_metrics (AicoreMetrics, optional): (Ascend only) Types of AICORE performance data collected,
+        aic_metrics (AicoreMetrics, optional): (Ascend only) Types of AICORE performance data collected,
             when using this parameter, `activities` must include ``ProfilerActivity.NPU`` , and the value
-            must be a member of AicoreMetrics. Default: ``AicoreMetrics.AiCoreNone`` .
+            must be a member of AicoreMetrics. When `profiler_level` is ``ProfilerLevel.Level0``, the default value is
+            ``AicoreMetrics.AiCoreNone``; when `profiler_level` is ``ProfilerLevel.Level1`` or ``ProfilerLevel.Level2``,
+            the default value is ``AicoreMetrics.PipeUtilization``.
+
             The data items contained in each metric are as follows:
 
             - AicoreMetrics.AiCoreNone: Does not collect AICORE data.
@@ -140,15 +182,18 @@ class Profiler:
               ub\_/write_bw_scalar etc.
             - AicoreMetrics.L2Cache: L2Cache contains write_cache_hit, write_cache_miss_allocate, r0_read_cache_hit,
               r1_read_cache_hit etc. This function only support Atlas A2 training series products.
-        with_stack (bool, optional): (Ascend) Whether to collect frame host call stack data on the Python side. This
+            - AicoreMetrics.MemoryAccess: Statistics on storage access bandwidth and storage capacity of main
+              storage and l2 cache etc.
+        with_stack (bool, optional): (Ascend only) Whether to collect frame host call stack data
+            on the Python side. This
             data is presented in the form of a flame graph in the timeline. When using this parameter, `activities` must
             include ``ProfilerActivity.CPU``. Default value: ``False`` .
         data_simplification (bool, optional): (Ascend only) Whether to remove FRAMEWORK data and other redundant data.
-            If set to True, only the delivery of profiler and the original performance data in the PROF_XXX
-            directory are retained to save disk space.
-            Default value: ``True`` .
+            If set to True, only the profiler deliverables and raw performance data under the PROF_XXX directory are
+            kept to save space. Default value: ``True`` .
         l2_cache (bool, optional): (Ascend only) Whether to collect l2 cache data, collect when True.
-            Default: ``False`` .
+            Default: ``False`` . The l2_cache.csv file is generated in the ASCEND_PROFILER_OUTPUT folder.In O2 mode,
+            only wait and skip_first parameters in schedule configuration can be set to 0.
         hbm_ddr (bool, optional): (Ascend only) Whether to collect On-Chip Memory/DDR read and write rate data,
             collect when True. Default: ``False`` .
         pcie (bool, optional): (Ascend only) Whether to collect PCIe bandwidth data, collect when True.
@@ -206,7 +251,7 @@ class Profiler:
         ...     # Note that the Profiler should be initialized before model.train
         ...     profiler = Profiler(profiler_level=ProfilerLevel.Level0,
         ...                         activities=[ProfilerActivity.CPU, ProfilerActivity.NPU],
-        ...                         aicore_metrics=AicoreMetrics.AiCoreNone)
+        ...                         aic_metrics=AicoreMetrics.AiCoreNone)
         ...
         ...     # Train Model
         ...     net = Net()
@@ -325,7 +370,7 @@ class Profiler:
             self.action_controller.transit_action(self.current_action, None)
         else:
             ProfilerInterface.stop()
-        self._dump_metadata()
+            ProfilerMetaData.dump_metadata()
 
     def analyse(self, offline_path=None, pretty=False, step_list=None, mode="sync") -> None:
         """
@@ -395,7 +440,7 @@ class Profiler:
         Analyze training performance data offline, which is invoked after performance data collection is completed.
 
         Args:
-            path (str): The profiling data path which need to be analyzed offline.
+            path (str): The profiling data path which needs to be analyzed offline.
                 There needs to be a profiler directory in this path.
             pretty (bool, optional): Whether to pretty json files. Default: ``False``.
             step_list (list, optional): A list of steps that need to be analyzed, the steps must be
@@ -431,7 +476,7 @@ class Profiler:
             for future in as_completed(futures):
                 try:
                     future.result()
-                except Exception as e: # pylint: disable=W0703
+                except Exception as e:  # pylint: disable=W0703
                     logger.error("offline analysis failed: %s", str(e))
 
     def step(self) -> None:
@@ -447,7 +492,8 @@ class Profiler:
             >>> import mindspore as ms
             >>> import mindspore.dataset as ds
             >>> from mindspore import context, nn, Profiler
-            >>> from mindspore.profiler import schedule, tensor_board_trace_handler
+            >>> from mindspore.profiler import schedule, tensorboard_trace_handler, ProfilerLevel, AicoreMetrics,
+            >>> ExportType, ProfilerActivity
             >>>
             >>> class Net(nn.Cell):
             ...     def __init__(self):
@@ -475,8 +521,8 @@ class Profiler:
             ...     STEP_NUM = 15
             ...
             ...     with Profiler(schedule=schedule(wait=1, warmup=1, active=2, repeat=1, skip_first=2),
-            ...                   on_trace_ready=tensor_board_trace_handler) as prof:
-            ...         for i in range(STEP_NUM):
+            ...                   on_trace_ready=tensorboard_trace_handler) as prof:
+            ...         for _ in range(STEP_NUM):
             ...             train(net)
             ...             prof.step()
         """
@@ -511,7 +557,7 @@ class Profiler:
             >>> # Call Profiler add_metadata
             >>> profiler.add_metadata("test_key", "test_value")
             >>> # Profiler end
-            >>> profiler.analyse()
+            >>> profiler.stop()
         """
         if not isinstance(key, str) or not isinstance(value, str):
             logger.warning("The key and value of metadata must be string. Skip this metadata.")
@@ -522,6 +568,7 @@ class Profiler:
             if key in self._metadata:
                 logger.warning(f"{key} is already saved as metadata, override it.")
             self._metadata[key] = value
+            ProfilerMetaData.set_metadata(self._metadata)
         else:
             logger.warning("Too many metadata added. Skip this metadata")
 
@@ -541,7 +588,7 @@ class Profiler:
             >>> # Call Profiler add_metadata_json
             >>> profiler.add_metadata_json("test_key", json.dumps({"key1": 1, "key2": 2}))
             >>> # Profiler end, metadata will be saved in profiler_metadata.json
-            >>> profiler.analyse()
+            >>> profiler.stop()
         """
         if not isinstance(key, str) or not isinstance(value, str):
             logger.warning("The key and value of metadata must be string. Skip this metadata.")
@@ -553,6 +600,7 @@ class Profiler:
                 if key in self._metadata:
                     logger.warning(f"{key} is already saved as metadata, override it.")
                 self._metadata[key] = json.loads(value)
+                ProfilerMetaData.set_metadata(self._metadata)
             except ValueError:
                 logger.warning("The metadata value must be json format string. Skip this metadata")
         else:
@@ -617,14 +665,6 @@ class Profiler:
         op_info = parser.parse()
         return op_info
 
-    def _dump_metadata(self):
-        """Dump metadata to file."""
-        if not self._metadata:
-            return
-        save_path = os.path.join(self._prof_context.ascend_ms_dir, "profiler_metadata.json")
-        FileManager.create_json_file(save_path, self._metadata, indent=4)
-        self._metadata.clear()
-
     def __enter__(self) -> 'Profiler':
         if not self._has_started:
             self.start()
@@ -638,3 +678,459 @@ class Profiler:
         if self._has_started:
             self.stop()
             logger.warning("Profiler is stopped at the end of the program.")
+
+
+class Profile:
+    r"""
+    This class to enable the profiling of MindSpore neural networks.
+    MindSpore users can import the mindspore.profiler.profile, initialize the profile object to start profiling,
+    Use profile.start() to start the analysis, and use profile.stop() to stop collecting and analyzing the results.
+    Users can visualize the results using the `MindStudio Insight
+    <https://www.hiascend.com/developer/download/community/result?module=pt+sto+cann>`_ tool.
+    Now, profile supports AICORE operator, AICPU operator, HostCPU operator, memory,
+    correspondence, cluster, etc data analysis.
+
+    Args:
+        start_profile (bool, optional): The start_profile parameter controls whether to enable or disable performance
+            data collection based on conditions. Default: ``True`` .
+        activities (list, optional): The activities to collect.
+            Default: ``[ProfilerActivity.CPU, ProfilerActivity.NPU]``.
+
+            - ProfilerActivity.CPU: Collect MindSpore framework data.
+            - ProfilerActivity.NPU: Collect CANN software stack and NPU data.
+            - ProfilerActivity.GPU: Collect GPU data.
+        schedule (schedule, optional): Sets the action strategy for the capture, defined by the schedule class,
+            to be used with the step interface. Default: ``None``. Performance data of all steps is collected.
+            For details, see :class:`mindspore.profiler.schedule` .
+        on_trace_ready (Callable, optional): Sets the callback function to be executed when the performance data
+            is collected. Default: ``None``. It indicates that only performance data is collected, but not resolved.
+            For details, see :func:`mindspore.profiler.tensorboard_trace_handler` .
+        profile_memory (bool, optional): (Ascend only) Whether to collect tensor memory data, collect when ``True`` .
+            When using this parameter, `activities` must set to ``[ProfilerActivity.CPU, ProfilerActivity.NPU]``.
+            Collecting operator memory data when the graph compilation level is O2 requires collecting from the
+            first step. Default: ``False`` . The operator name currently collected by this parameter is incomplete.
+            This issue will be resolved in later versions. It is recommended to use the environment variable
+            ``MS_ALLOC_CONF`` instead.
+        with_stack (bool, optional): (Ascend only) Whether to collect frame host call stack data
+            on the Python side. This
+            data is presented in the form of a flame graph in the timeline. When using this parameter, `activities` must
+            include ``ProfilerActivity.CPU``. Default value: ``False`` .
+        hbm_ddr (bool, optional): (Ascend only) Whether to collect On-Chip Memory/DDR read and write rate data,
+            collect when True. Default: ``False`` .
+        pcie (bool, optional): (Ascend only) Whether to collect PCIe bandwidth data, collect when True.
+            Default: ``False`` .
+        data_process (bool, optional): (Ascend/GPU) Whether to collect data to prepare performance data.
+            Default value: ``False`` .
+        parallel_strategy (bool, optional): (Ascend only) Whether to collect parallel policy performance data.
+            Default value: ``False`` .
+        sync_enable (bool, optional): (GPU only) Whether the profiler collects operators in a synchronous way.
+            Default: ``True`` .
+
+            - True: The synchronous way. Before sending the operator to the GPU, the CPU records the start timestamp.
+              Then the operator is returned to the CPU after execution, and the end timestamp is recorded,
+              The duration of the operator is the difference between the two timestamps.
+            - False: The asynchronous way. The duration of the operator is that of sending from the CPU to the GPU.
+              This method can reduce the impact of adding profiler on overall training time.
+        experimental_config (_ExperimentalConfig, optional): expandable parameters can be configured in this
+              configuration item. For details, see :class:`mindspore.profiler._ExperimentalConfig` .
+    Raises:
+        RuntimeError: When the version of CANN does not match the version of MindSpore,
+            MindSpore cannot parse the generated ascend_job_id directory structure.
+
+    Supported Platforms:
+        ``Ascend`` ``GPU``
+
+    Examples:
+        >>> import numpy as np
+        >>> import mindspore
+        >>> from mindspore import nn, context
+        >>> import mindspore.dataset as ds
+        >>> from mindspore.profiler import ProfilerLevel, ProfilerActivity, AicoreMetrics, ExportType
+        >>>
+        >>> class Net(nn.Cell):
+        ...     def __init__(self):
+        ...         super(Net, self).__init__()
+        ...         self.fc = nn.Dense(2,2)
+        ...     def construct(self, x):
+        ...         return self.fc(x)
+        >>>
+        >>> def generator():
+        ...     for i in range(2):
+        ...         yield np.ones([2, 2]).astype(np.float32), np.ones([2]).astype(np.int32)
+        >>>
+        >>> def train(net):
+        ...     optimizer = nn.Momentum(net.trainable_params(), 1, 0.9)
+        ...     loss = nn.SoftmaxCrossEntropyWithLogits(sparse=True)
+        ...     data = ds.GeneratorDataset(generator, ["data", "label"])
+        ...     model = mindspore.train.Model(net, loss, optimizer)
+        ...     model.train(1, data)
+        >>>
+        >>> if __name__ == '__main__':
+        ...     # If the device_target is GPU, set the device_target to "GPU"
+        ...     context.set_context(mode=mindspore.GRAPH_MODE)
+        ...     mindspore.set_device("Ascend")
+        ...
+        ...     # Init Profiler
+        ...     experimental_config = mindspore.profiler._ExperimentalConfig(
+        ...                                 profiler_level=ProfilerLevel.Level0,
+        ...                                 aic_metrics=AicoreMetrics.AiCoreNone,
+        ...                                 l2_cache=False,
+        ...                                 mstx=False,
+        ...                                 data_simplification=False,
+        ...                                 export_type=[ExportType.Text])
+        ...     steps = 10
+        ...     net = Net()
+        ...     # Note that the Profiler should be initialized before model.train
+        ...     with mindspore.profiler.profile(activities=[ProfilerActivity.CPU, ProfilerActivity.NPU],
+        ...                                     schedule=mindspore.profiler.schedule(wait=1, warmup=1, active=2,
+        ...                                           repeat=1, skip_first=2),
+        ...                                     on_trace_ready=mindspore.profiler.
+        ...                                           tensorboard_trace_handler("./data"),
+        ...                                     profile_memory=False,
+        ...                                     experimental_config=experimental_config) as prof:
+        ...
+        ...         # Train Model
+        ...         for step in range(steps):
+        ...             train(net)
+        ...             prof.step()
+    """
+
+    def __init__(
+            self,
+            activities: list = None,
+            with_stack: bool = False,
+            profile_memory: bool = False,
+            data_process: bool = False,
+            parallel_strategy: bool = False,
+            start_profile: bool = True,
+            hbm_ddr: bool = False,
+            pcie: bool = False,
+            sync_enable: bool = True,
+            schedule: Schedule = None,
+            on_trace_ready: Optional[Callable[..., Any]] = None,
+            experimental_config: Optional[_ExperimentalConfig] = None,
+    ):
+        self._activities = activities
+        self._with_stack = with_stack
+        self._profile_memory = profile_memory
+        self._data_process = data_process
+        self._parallel_strategy = parallel_strategy
+        self._start_profile = start_profile
+        self._hbm_ddr = hbm_ddr
+        self._pcie = pcie
+        self._sync_enable = sync_enable
+        self._schedule = schedule
+        self._on_trace_ready = on_trace_ready
+        self._experimental_config = experimental_config or _ExperimentalConfig()
+        self._profiler = Profiler(
+            profiler_level=self._experimental_config.profiler_level,
+            activities=self._activities,
+            aic_metrics=self._experimental_config.aic_metrics,
+            with_stack=self._with_stack,
+            profile_memory=self._profile_memory,
+            data_process=self._data_process,
+            parallel_strategy=self._parallel_strategy,
+            start_profile=self._start_profile,
+            l2_cache=self._experimental_config.l2_cache,
+            hbm_ddr=self._hbm_ddr,
+            pcie=self._pcie,
+            sync_enable=self._sync_enable,
+            data_simplification=self._experimental_config.data_simplification,
+            mstx=self._experimental_config.mstx,
+            export_type=self._experimental_config.export_type,
+            schedule=self._schedule,
+            on_trace_ready=self._on_trace_ready,
+        )
+
+    def __enter__(self) -> 'Profile':
+        self._profiler.__enter__()
+        return self
+
+    def __exit__(self, exe_type, exe_val, exc_tb):
+        self._profiler.__exit__(exe_type, exe_val, exc_tb)
+
+    def __del__(self):
+        self._profiler.__del__()
+
+    def start(self) -> None:
+        """
+        Turn on profile data collection. profile can be turned on by condition.
+
+        Raises:
+            RuntimeError: If the profile has already started.
+            RuntimeError: If the `start_profile` parameter is not set or is set to ``True``.
+
+        Examples:
+            >>> import numpy as np
+            >>> import mindspore
+            >>> from mindspore import nn, context
+            >>> import mindspore.dataset as ds
+            >>> from mindspore.profiler import ProfilerLevel, ProfilerActivity, AicoreMetrics, ExportType
+            >>>
+            >>> class Net(nn.Cell):
+            ...     def __init__(self):
+            ...         super(Net, self).__init__()
+            ...         self.fc = nn.Dense(2,2)
+            ...     def construct(self, x):
+            ...         return self.fc(x)
+            >>>
+            >>> def generator():
+            ...     for i in range(2):
+            ...         yield np.ones([2, 2]).astype(np.float32), np.ones([2]).astype(np.int32)
+            >>>
+            >>> def train(net):
+            ...     optimizer = nn.Momentum(net.trainable_params(), 1, 0.9)
+            ...     loss = nn.SoftmaxCrossEntropyWithLogits(sparse=True)
+            ...     data = ds.GeneratorDataset(generator, ["data", "label"])
+            ...     model = mindspore.train.Model(net, loss, optimizer)
+            ...     model.train(1, data)
+            >>>
+            >>> if __name__ == '__main__':
+            ...     # If the device_target is GPU, set the device_target to "GPU"
+            ...     context.set_context(mode=mindspore.GRAPH_MODE)
+            ...     mindspore.set_device("Ascend")
+            ...
+            ...     # Init Profiler
+            ...     experimental_config = mindspore.profiler._ExperimentalConfig(
+            ...                                 profiler_level=ProfilerLevel.Level0,
+            ...                                 aic_metrics=AicoreMetrics.AiCoreNone,
+            ...                                 l2_cache=False,
+            ...                                 mstx=False,
+            ...                                 data_simplification=False,
+            ...                                 export_type=[ExportType.Text])
+            ...     steps = 10
+            ...     net = Net()
+            ...     # Note that the Profiler should be initialized before model.train
+            ...     prof = mindspore.profiler.profile(activities=[ProfilerActivity.CPU, ProfilerActivity.NPU],
+            ...                                       schedule=mindspore.profiler.schedule(wait=1, warmup=1, active=2,
+            ...                                           repeat=1, skip_first=2),
+            ...                                       on_trace_ready=mindspore.profiler.
+            ...                                           tensorboard_trace_handler("./data"),
+            ...                                       profile_memory=False,
+            ...                                       experimental_config=experimental_config)
+            ...     prof.start()
+            ...     # Train Model
+            ...     for step in range(steps):
+            ...         train(net)
+            ...         prof.step()
+            ...     prof.stop()
+        """
+        self._profiler.start()
+
+    def stop(self) -> None:
+        """
+        Turn off profile data collection. profile can be turned off by condition.
+
+        Raises:
+            RuntimeError: If the profile has not started, this function is disabled.
+
+        Examples:
+            >>> import numpy as np
+            >>> import mindspore
+            >>> from mindspore import nn, context
+            >>> import mindspore.dataset as ds
+            >>> from mindspore.profiler import ProfilerLevel, ProfilerActivity, AicoreMetrics, ExportType
+            >>>
+            >>> class Net(nn.Cell):
+            ...     def __init__(self):
+            ...         super(Net, self).__init__()
+            ...         self.fc = nn.Dense(2,2)
+            ...     def construct(self, x):
+            ...         return self.fc(x)
+            >>>
+            >>> def generator():
+            ...     for i in range(2):
+            ...         yield np.ones([2, 2]).astype(np.float32), np.ones([2]).astype(np.int32)
+            >>>
+            >>> def train(net):
+            ...     optimizer = nn.Momentum(net.trainable_params(), 1, 0.9)
+            ...     loss = nn.SoftmaxCrossEntropyWithLogits(sparse=True)
+            ...     data = ds.GeneratorDataset(generator, ["data", "label"])
+            ...     model = mindspore.train.Model(net, loss, optimizer)
+            ...     model.train(1, data)
+            >>>
+            >>> if __name__ == '__main__':
+            ...     # If the device_target is GPU, set the device_target to "GPU"
+            ...     context.set_context(mode=mindspore.GRAPH_MODE)
+            ...     mindspore.set_device("Ascend")
+            ...
+            ...     # Init Profiler
+            ...     experimental_config = mindspore.profiler._ExperimentalConfig(
+            ...                                 profiler_level=ProfilerLevel.Level0,
+            ...                                 aic_metrics=AicoreMetrics.AiCoreNone,
+            ...                                 l2_cache=False,
+            ...                                 mstx=False,
+            ...                                 data_simplification=False,
+            ...                                 export_type=[ExportType.Text])
+            ...     steps = 10
+            ...     net = Net()
+            ...     # Note that the Profiler should be initialized before model.train
+            ...     prof = mindspore.profiler.profile(activities=[ProfilerActivity.CPU, ProfilerActivity.NPU],
+            ...                                       schedule=mindspore.profiler.schedule(wait=1, warmup=1, active=2,
+            ...                                           repeat=1, skip_first=2),
+            ...                                       on_trace_ready=mindspore.profiler.
+            ...                                           tensorboard_trace_handler("./data"),
+            ...                                       profile_memory=False,
+            ...                                       experimental_config=experimental_config)
+            ...     prof.start()
+            ...     # Train Model
+            ...     for step in range(steps):
+            ...         train(net)
+            ...         prof.step()
+            ...     prof.stop()
+        """
+        self._profiler.stop()
+
+    def step(self) -> None:
+        """
+        Used for Ascend, distinguish step collection and parsing performance data through schedule and on_trace_ready.
+
+        Raises:
+            RuntimeError: If the `start_profile` parameter is not set or the Profiler is not started.
+            RuntimeError: If the `schedule` parameter is not set.
+
+        Examples:
+        >>> import numpy as np
+        >>> import mindspore
+        >>> from mindspore import nn, context
+        >>> import mindspore.dataset as ds
+        >>> from mindspore.profiler import ProfilerLevel, ProfilerActivity, AicoreMetrics, ExportType
+        >>>
+        >>> class Net(nn.Cell):
+        ...     def __init__(self):
+        ...         super(Net, self).__init__()
+        ...         self.fc = nn.Dense(2,2)
+        ...     def construct(self, x):
+        ...         return self.fc(x)
+        >>>
+        >>> def generator():
+        ...     for i in range(2):
+        ...         yield np.ones([2, 2]).astype(np.float32), np.ones([2]).astype(np.int32)
+        >>>
+        >>> def train(net):
+        ...     optimizer = nn.Momentum(net.trainable_params(), 1, 0.9)
+        ...     loss = nn.SoftmaxCrossEntropyWithLogits(sparse=True)
+        ...     data = ds.GeneratorDataset(generator, ["data", "label"])
+        ...     model = mindspore.train.Model(net, loss, optimizer)
+        ...     model.train(1, data)
+        >>>
+        >>> if __name__ == '__main__':
+        ...     # If the device_target is GPU, set the device_target to "GPU"
+        ...     context.set_context(mode=mindspore.GRAPH_MODE)
+        ...     mindspore.set_device("Ascend")
+        ...
+        ...     # Init Profiler
+        ...     experimental_config = mindspore.profiler._ExperimentalConfig(
+        ...                                 profiler_level=ProfilerLevel.Level0,
+        ...                                 aic_metrics=AicoreMetrics.AiCoreNone,
+        ...                                 l2_cache=False,
+        ...                                 mstx=False,
+        ...                                 data_simplification=False,
+        ...                                 export_type=[ExportType.Text])
+        ...     steps = 10
+        ...     net = Net()
+        ...     # Note that the Profiler should be initialized before model.train
+        ...     with mindspore.profiler.profile(activities=[ProfilerActivity.CPU, ProfilerActivity.NPU],
+        ...                                     schedule=mindspore.profiler.schedule(wait=1, warmup=1, active=2,
+        ...                                           repeat=1, skip_first=2),
+        ...                                     on_trace_ready=mindspore.profiler.tensorboard_trace_handler("./data"),
+        ...                                     profile_memory=False,
+        ...                                     experimental_config=experimental_config) as prof:
+        ...
+        ...         # Train Model
+        ...         for step in range(steps):
+        ...             train(net)
+        ...             prof.step()
+        """
+        self._profiler.step()
+
+    def add_metadata(self, key: str, value: str):
+        """
+        Report custom metadata key-value pair data.
+
+        Args:
+            key (str): The key to the metadata.
+            value (str): The value to the metadata.
+
+        Examples:
+            >>> import mindspore
+            >>> # Profiler init.
+            >>> with mindspore.profiler.profile() as prof:
+            ...     # Call Profiler add_metadata
+            ...     prof.add_metadata("test_key", "test_value")
+        """
+
+        self._profiler.add_metadata(key, value)
+
+    def add_metadata_json(self, key: str, value: str):
+        """
+        Report custom metadata key-value pair data with the value as a JSON string data.
+
+        Args:
+            key (str): The key to the metadata.
+            value (str): The json str format value to the metadata.
+
+        Examples:
+            >>> import json
+            >>> import mindspore
+            >>> # Profiler init.
+            >>> with mindspore.profiler.profile() as prof:
+            ...     # Call Profiler add_metadata_json
+            ...     prof.add_metadata_json("test_key", json.dumps({"key1": 1, "key2": 2}))
+        """
+        self._profiler.add_metadata_json(key, value)
+
+
+def analyse(profiler_path: str, max_process_number: int = os.cpu_count() // 2, pretty=False, step_list=None,
+            data_simplification=True):
+    """
+    Analyze training performance data offline, which is invoked after performance data collection is completed.
+
+    Args:
+        profiler_path (str): The path to profiling data that needs to be analyzed offline,
+            specified to the upper directory ``*_ascend_ms``.
+        max_process_number (int, optional): Maximum number of processes.
+            The default value is ``os.cpu_count() // 2``.
+        pretty (bool, optional): Format the JSON file. Default: ``False``,
+            indicating that the formatting is not performed.
+        step_list (list, optional): Only the performance data of the specified step is parsed. The specified step must
+            be a consecutive integer. It supports CallBack collection only in GRAPH mode, and can only slice the CANN
+            layer and the following information. Default value: ``None``, that is, full resolution.
+        data_simplification (bool, optional): Whether to enable data simplification. Default: ``True``,
+            indicating the data simplification is enabled.
+
+    Examples:
+        >>> from mindspore.profiler.profiler import analyse
+        >>> analyse(profiler_path="./profiling_path")
+    """
+    if not isinstance(max_process_number, int) or isinstance(max_process_number, bool) or max_process_number <= 0:
+        logger.warning(f"Parameter 'max_process_number' should be of type int, but got "
+                       f"{type(max_process_number).__name__}. reset to int {os.cpu_count() // 2}.")
+        max_process_number = os.cpu_count() // 2
+
+    real_path = PathManager.get_real_path(profiler_path)
+    PathManager.check_input_directory_path(real_path)
+    ascend_ms_path_list = PathManager.get_ascend_ms_path_list(real_path)
+
+    if not ascend_ms_path_list:
+        msg = (f"Invalid path: {real_path}. Expected a *_ascend_ms_* directory "
+               "or a parent directory of multiple *_ascend_ms_*")
+        logger.error(msg)
+        return
+
+    with ProcessPoolExecutor(max_workers=max_process_number) as executor:
+        futures = [
+            executor.submit(
+                NPUProfilerAnalysis.offline_analyse,
+                ascend_ms_path,
+                pretty,
+                step_list,
+                data_simplification
+            ) for ascend_ms_path in ascend_ms_path_list
+        ]
+        # Wait for all tasks to complete
+        for future in as_completed(futures):
+            try:
+                future.result()
+            except Exception as e:  # pylint: disable=W0703
+                logger.error("offline analysis failed: %s", str(e))