pytorch-lightning

1
# Copyright The Lightning AI team.
2
#
3
# Licensed under the Apache License, Version 2.0 (the "License");
4
# you may not use this file except in compliance with the License.
5
# You may obtain a copy of the License at
6
#
7
#     http://www.apache.org/licenses/LICENSE-2.0
8
#
9
# Unless required by applicable law or agreed to in writing, software
10
# distributed under the License is distributed on an "AS IS" BASIS,
11
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
# See the License for the specific language governing permissions and
13
# limitations under the License.
14
"""Profiler to check if there are any bottlenecks in your code."""
15

16
from typing_extensions import override
17

18
from lightning.pytorch.profilers.profiler import Profiler
19

20

21
class PassThroughProfiler(Profiler):
22
    """This class should be used when you don't want the (small) overhead of profiling.
23

24
    The Trainer uses this class by default.
25

26
    """
27

28
    @override
29
    def start(self, action_name: str) -> None:
30
        pass
31

32
    @override
33
    def stop(self, action_name: str) -> None:
34
        pass
35