# Copyright The PyTorch Lightning team.## Licensed under the Apache License, Version 2.0 (the "License");# you may not use this file except in compliance with the License.# You may obtain a copy of the License at## http://www.apache.org/licenses/LICENSE-2.0## Unless required by applicable law or agreed to in writing, software# distributed under the License is distributed on an "AS IS" BASIS,# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.# See the License for the specific language governing permissions and# limitations under the License."""Profiler to check if there are any bottlenecks in your code."""fromabcimportABC,abstractmethodfromtypingimportAnyfrompytorch_lightning.profiler.profilerimportProfilerfrompytorch_lightning.utilities.rank_zeroimportrank_zero_deprecationclassAbstractProfiler(ABC):"""Specification of a profiler. See deprecation warning below .. deprecated:: v1.6 `AbstractProfiler` was deprecated in v1.6 and will be removed in v1.8. Please use `Profiler` instead. """@abstractmethoddefstart(self,action_name:str)->None:"""Defines how to start recording an action."""@abstractmethoddefstop(self,action_name:str)->None:"""Defines how to record the duration once an action is complete."""@abstractmethoddefsummary(self)->str:"""Create profiler summary in text format."""@abstractmethoddefsetup(self,**kwargs:Any)->None:"""Execute arbitrary pre-profiling set-up steps as defined by subclass."""@abstractmethoddefteardown(self,**kwargs:Any)->None:"""Execute arbitrary post-profiling tear-down steps as defined by subclass."""classBaseProfiler(Profiler):""" .. deprecated:: v1.6 `BaseProfiler` was deprecated in v1.6 and will be removed in v1.8. Please use `Profiler` instead. """def__init__(self,*args,**kwargs):rank_zero_deprecation("`BaseProfiler` was deprecated in v1.6 and will be removed in v1.8. Please use `Profiler` instead.")super().__init__(*args,**kwargs)
[docs]classPassThroughProfiler(Profiler):"""This class should be used when you don't want the (small) overhead of profiling. The Trainer uses this class by default. """
To analyze traffic and optimize your experience, we serve cookies on this site. By clicking or navigating, you agree to allow our usage of cookies. Read PyTorch Lightning's Privacy Policy.