Profiler

class lightning.pytorch.profilers.Profiler(dirpath=None, filename=None)

Bases: ABC

If you wish to write a custom profiler, you should inherit from this class.

describe()

Logs a profile report after the conclusion of run.

Return type:

None

profile(action_name)

Yields a context manager to encapsulate the scope of a profiled action.

Example:

with self.profile('load training data'):
    # load training data code

The profiler will start once you’ve entered the context and will automatically stop once you exit the code block.

Return type:

Generator

setup(stage, local_rank=None, log_dir=None)

Execute arbitrary pre-profiling set-up steps.

Return type:

None

abstract start(action_name)

Defines how to start recording an action.

Return type:

None

abstract stop(action_name)

Defines how to record the duration once an action is complete.

Return type:

None

teardown(stage)

Execute arbitrary post-profiling tear-down steps.

Closes the currently open file and stream.

Return type:

None