Method start

python/paddle/profiler/profiler.py:594–642

r''' Start profiler and enter the first profiler step(0). State transformed from CLOSED to self.current_state and trigger corresponding action. Examples: .. code-block:: pycon :name: code-example4 >>> # doctest: +REQUIRES(env:GPU)

(self)

        self.stop()

    def start(self) -> None:
        r'''
        Start profiler and enter the first profiler step(0).
        State transformed from CLOSED to self.current_state and trigger corresponding action.

        Examples:
            .. code-block:: pycon
                :name: code-example4

                >>> # doctest: +REQUIRES(env:GPU)
                >>> import paddle.profiler as profiler
                >>> import paddle
                >>> paddle.device.set_device('gpu')
                >>> prof = profiler.Profiler(
                ...     targets=[profiler.ProfilerTarget.CPU, profiler.ProfilerTarget.GPU],
                ...     scheduler=(1, 9),
                ...     on_trace_ready=profiler.export_chrome_tracing('./log'),
                ... )
                >>> prof.start()
                >>> for iter in range(10):
                ...     # train()
                ...     prof.step()
                >>> prof.stop()

        '''
        # Timing only without profiling.
        benchmark().begin()
        if not self.timer_only or self.emit_nvtx:
            utils._is_profiler_used = True
        if self.timer_only:
            return
        if self.record_shapes or self.with_flops:
            enable_op_info_recorder()
        if self.profile_memory:
            enable_memory_recorder()
        # CLOSED -> self.current_state
        if self.current_state == ProfilerState.READY:
            self.profiler.prepare()
        elif self.current_state == ProfilerState.RECORD:
            self.profiler.prepare()
            self.profiler.start()
        elif self.current_state == ProfilerState.RECORD_AND_RETURN:
            self.profiler.prepare()
            self.profiler.start()
        self.record_event = RecordEvent(
            name=f"ProfileStep#{self.step_num}",
            event_type=TracerEventType.ProfileStep,
        )
        self.record_event.begin()

    def stop(self) -> None:
        r'''