Missed TensorFlow Dev Summit? Check out the video playlist. Watch recordings

tf.profiler.experimental.Trace

View source on GitHub

Context manager that generates a trace event in the profiler.

tf.profiler.experimental.Trace(
    name, **kwargs
)

A trace event will start when entering the context, and stop and save the result to the profiler when exiting the context. Open TensorBoard Profile tab and choose trace viewer to view the trace event in the timeline.

Trace events are created only when the profiler is enabled. More information on how to use the profiler can be found at tensorflow.org/guide/profiler

Example usage:

tf.profiler.experimental.start('logdir')
for step in range(num_steps):
  # Creates a trace event for each training step with the step number.
  with tf.profiler.experimental.Trace("Train", step_num=step):
    train_fn()
tf.profiler.experimental.stop()

Args:

  • name: The name of the trace event.
  • **kwargs: Keyword arguments added to the trace event.

Methods

__enter__

View source

__enter__()

__exit__

View source

__exit__(
    exc_type, exc_val, exc_tb
)