Join us at TensorFlow World, Oct 28-31. Use code TF20 for 20% off select passes. Register now

tf.compat.v2.summary.trace_on

View source on GitHub

Starts a trace to record computation graphs and profiling information.

tf.compat.v2.summary.trace_on(
    graph=True,
    profiler=False
)

Must be invoked in eager mode.

When enabled, TensorFlow runtime will collection information that can later be exported and consumed by TensorBoard. The trace is activated across the entire TensorFlow runtime and affects all threads of execution.

To stop the trace and export the collected information, use tf.summary.trace_export. To stop the trace without exporting, use tf.summary.trace_off.

Args:

  • graph: If True, enables collection of executed graphs. It includes ones from tf.function invocation and ones from the legacy graph mode. The default is True.
  • profiler: If True, enables the advanced profiler. Enabling profiler implicitly enables the graph collection. The profiler may incur a high memory overhead. The default is False.