composer.profiler#

Modules

`composer.profiler.dataloader_profiler`	Profiler to measure the time it takes the data loader to return a batch.
`composer.profiler.json_trace_handler`	Outputs profiling data in JSON trace format.
`composer.profiler.json_trace_merger`	Merge trace files together.
`composer.profiler.marker`	Profiler Marker.
`composer.profiler.profiler`	Composer Profiler.
`composer.profiler.profiler_action`	composer.profiler.profiler_action
`composer.profiler.profiler_hparams`	Hyperparameter classes for the `profiler`.
`composer.profiler.profiler_schedule`	Profiler Schedules.
`composer.profiler.system_profiler`	Profiler to record system level metrics.
`composer.profiler.torch_profiler`	Profiler to collect `torch` performance metrics during training.
`composer.profiler.trace_handler`	Profiler Trace Handler.

Performance profiling tools.

The profiler gathers performance metrics during a training run that can be used to diagnose bottlenecks and facilitate model development.

The metrics gathered include:

Duration of each Event during training
Time taken by the data loader to return a batch
Host metrics such as CPU, system memory, disk and network utilization over time
Execution order, latency and attributes of PyTorch operators and GPU kernels (see torch.profiler)

See the Profiling Guide for additional information.

Functions

Profiler schedule function for a cyclic profiling window.

Classes

`DataLoaderProfiler`	Profile a DataLoader.
`JSONTraceHandler`	Records trace events in JSON trace format.
`Marker`	Profiler Marker.
`Profiler`	Composer Profiler.
`ProfilerAction`	Action states for the `Profiler` that define whether or not events are being recorded to the trace file.
`SystemProfiler`	The SystemProfiler records system level metrics.
`TorchProfiler`	Profile the execution using the `PyTorch Profiler`.
`TraceHandler`	Base class for Composer Profiler trace handlers.

Hparams

These classes are used with yahp for YAML-based configuration.

`CyclicProfilerScheduleHparams`	Hyperparameters for the `cyclic_schedule()`.
`JSONTraceHparams`	Hyperparameters for the `JSONTraceHandler`.
`ProfileScheduleHparams`	Base class for Composer Profiler schedule hparams.
`TraceHandlerHparams`	Base class for the `TraceHandler` hparams.