torch.autograd.profiler.EventList Class Reference

Inheritance diagram for torch.autograd.profiler.EventList:

Public Member Functions
def	__init__ (self, args, kwargs)
def	__str__ (self)
def	table (self, sort_by=None)
def	export_chrome_trace (self, path)
def	key_averages (self)
def	total_average (self)

Detailed Description

A list of Events (for pretty printing)

Definition at line 24 of file profiler.py.

Member Function Documentation

def torch.autograd.profiler.EventList.export_chrome_trace	(		self,
			path
	)

Exports an EventList as a Chrome tracing tools file.

The checkpoint can be later loaded and inspected under ``chrome://tracing`` URL.

Arguments:
    path (str): Path where the trace will be written.

Definition at line 46 of file profiler.py.

def torch.autograd.profiler.EventList.key_averages

(

self

)

Averages all function events over their keys.

Returns:
    An EventList containing FunctionEventAvg objects.

Definition at line 104 of file profiler.py.

def torch.autograd.profiler.EventList.table	(		self,
			sort_by = None
	)

Prints an EventList as a nicely formatted table.

Arguments:
    sort_by (str, optional): Attribute used to sort entries. By default
they are printed in the same order as they were registered.
Valid keys include: ``cpu_time``, ``cuda_time``, ``cpu_time_total``,
``cuda_time_total``, ``count``.

Returns:
    A string containing the table.

Definition at line 32 of file profiler.py.

def torch.autograd.profiler.EventList.total_average

(

self

)

Averages all events.

Returns:
    A FunctionEventAvg object.

Definition at line 115 of file profiler.py.

---

The documentation for this class was generated from the following file:

• torch/autograd/profiler.py