TraceHandler

class composer.profiler.TraceHandler(*args, **kwargs)

Base class for Composer Profiler trace handlers.

Subclasses should implement process_duration_event(), process_instant_event(), process_counter_event(), and process_chrome_json_trace_file() to record trace events.

Since TraceHandler subclasses Callback, a trace handler can run on any Event (such as on Event.INIT to open files or on Event.BATCH_END to periodically dump data to files) and use Callback.close() to perform any cleanup.

process_chrome_json_trace_file(filepath)

Invoked when there are events in Chrome JSON format to record.

See this document for more information.

Parameters

filepath (Path) – The filepath to a Chrome JSON trace file.

process_counter_event(name, categories, timestamp, wall_clock_time_ns, values)

Invoked whenever there is an counter event to record.

Parameters

• name (str) – The name of the event.

• categories (list[str] | tuple[str, ...]) – The categories for the event.

• timestamp (Timestamp) – The timestamp.

• wall_clock_time_ns (int) – The time.time_ns() corresponding to the event.

• values (dict[str, int | float]) – The values corresponding to this counter event.

process_duration_event(name, categories, is_start, timestamp, wall_clock_time_ns)

Invoked whenever there is a duration event to record.

This method is called twice for each duration event – once with is_start = True, and then again with is_start = False. Interleaving events are not permitted. Specifically, for each event (identified by the name), a call with is_start = True will be followed by a call with is_start = False before another call with is_start = True.

Parameters

• name (str) – The name of the event.

• categories (Union[list[str], tuple[str, ...]]) – The categories for the event.

• is_start (bool) – Whether the event is a start event or end event.

• timestamp (Timestamp) – Snapshot of the training time.

• wall_clock_time_ns (int) – The time.time_ns() corresponding to the event.

process_instant_event(name, categories, timestamp, wall_clock_time_ns)

Invoked whenever there is an instant event to record.

Parameters

• name (str) – The name of the event.

• categories (list[str] | tuple[str, ...]) – The categories for the event.

• timestamp (Timestamp) – Snapshot of current training time.

• wall_clock_time_ns (int) – The time.time_ns() corresponding to the event.