Use the tools available with the Profiler to track the performance of your TensorFlow models. See how your model performs on the host (CPU), the device (GPU), or on a combination of both the host and device(s).
Profiling helps you understand the hardware resource consumption (time and memory) of the various TensorFlow operations (ops) in your model and resolve performance bottlenecks and ultimately, make the model execute faster.
This guide will walk you through how to install the Profiler, the various tools available, the different modes of how the Profiler collects performance data, and some recommended best practices to optimize model performance.
If you want to profile your model performance on Cloud TPUs, refer to the Cloud TPU guide.
Install the Profiler and GPU prerequisites
To profile on the GPU, you must:
- Meet the NVIDIA® GPU drivers and CUDA® Toolkit requirements listed on TensorFlow GPU support software requirements.
Ensure CUPTI exists on the path:
/sbin/ldconfig -N -v $(sed 's/:/ /g' <<< $LD_LIBRARY_PATH) | \ grep libcupti
If you don't have CUPTI on the path, prepend its installation directory to the
$LD_LIBRARY_PATH environment variable by running:
ldconfig command above again to verify that the CUPTI library is
Resolve privilege issues
When you run profiling with CUDA® Toolkit in a Docker environment or on Linux,
you may encounter issues related to insufficient CUPTI privileges
CUPTI_ERROR_INSUFFICIENT_PRIVILEGES). See the
NVIDIA Developer Docs
to learn more about how you can resolve these issues on Linux.
To resolve CUPTI privilege issues in a Docker environment, run
docker run option '--privileged=true'
Access the Profiler from the Profile tab in TensorBoard which appears only after you have captured some model data.
The Profiler has a selection of tools to help with performance analysis:
- Overview page
- Input pipeline analyzer
- TensorFlow stats
- Trace viewer
- GPU kernel stats
- Memory profile tool
- Pod viewer
The overview page provides a top level view of how your model performed during a profile run. The page shows you an aggregated overview page for your host and all devices, and some recommendations to improve your model training performance. You can also select individual hosts in the Host dropdown.
The overview page displays data as follows:
Performance summary - Displays a high-level summary of your model performance. The performance summary has two parts:
Step-time breakdown - Breaks down the average step time into multiple categories of where time is spent:
- Compilation - Time spent compiling kernels
- Input - Time spent reading input data
- Output - Time spent reading output data
- Kernel launch - Time spent by the host to launch kernels
- Host compute time
- Device-to-device communication time
- On-device compute time
- All others, including Python overhead
Device compute precisions - Reports the percentage of device compute time that uses 16 and 32-bit computations
Step-time graph - Displays a graph of device step time (in milliseconds) over all the steps sampled. Each step is broken into the multiple categories (with different colors) of where time is spent. The red area corresponds to the portion of the step time the devices were sitting idle waiting for input data from the host. The green area shows how much of time the device was actually working
Top 10 TensorFlow operations on device - Displays the on-device ops that ran the longest.
Each row displays an op's self time (as the percentage of time taken by all ops), cumulative time, category, and name.
Run environment - Displays a high-level summary of the model run environment including:
- Number of hosts used
- Device type (GPU/TPU)
- Number of device cores
Recommendation for next steps - Reports when a model is input bound and recommends tools you can use to locate and resolve model performance bottlenecks
Input pipeline analyzer
When a TensorFlow program reads data from a file it begins at the top of the TensorFlow graph in a pipelined manner. The read process is divided into multiple data processing stages connected in series, where the output of one stage is the input to the next one. This system of reading data is called the input pipeline.
A typical pipeline for reading records from files has the following stages:
- File reading
- File preprocessing (optional)
- File transfer from the host to the device
An inefficient input pipeline can severely slow down your application. An application is considered input bound when it spends a significant portion of time in input pipeline. Use the insights obtained from the input pipeline analyzer to understand where the input pipeline is inefficient.
The input pipeline analyzer tells you immediately whether your program is input bound and walks you through device- and host-side analysis to debug performance bottlenecks at any stage in the input pipeline.
See the guidance on input pipeline performance for recommended best practices to optimize your data input pipelines.
Input pipeline dashboard
To open the input pipeline analyzer, select Profile, then select input_pipeline_analyzer from the Tools dropdown.
The dashboard contains three sections:
- Summary - Summarizes the overall input pipeline with information on whether your application is input bound and, if so, by how much
- Device-side analysis - Displays detailed, device-side analysis results, including the device step-time and the range of device time spent waiting for input data across cores at each step
- Host-side analysis - Shows a detailed analysis on the host side, including a breakdown of input processing time on the host
Input pipeline summary
The Summary reports if your program is input bound by presenting the percentage of device time spent on waiting for input from the host. If you are using a standard input pipeline that has been instrumented, the tool reports where most of the input processing time is spent.
The device-side analysis provides insights on time spent on the device versus on the host and how much device time was spent waiting for input data from the host.
- Step time plotted against step number - Displays a graph of device step time (in milliseconds) over all the steps sampled. Each step is broken into the multiple categories (with different colors) of where time is spent. The red area corresponds to the portion of the step time the devices were sitting idle waiting for input data from the host. The green area shows how much of time the device was actually working
- Step time statistics - Reports the average, standard deviation, and range ([minimum, maximum]) of the device step time
The host-side analysis reports a breakdown of the input processing time (the
time spent on
tf.data API ops) on the host into several categories:
- Reading data from files on demand - Time spent on reading data from files without caching, prefetching, and interleaving
- Reading data from files in advance - Time spent reading files, including caching, prefetching, and interleaving
- Data preprocessing - Time spent on preprocessing ops, such as image decompression
- Enqueuing data to be transferred to device - Time spent putting data into an infeed queue before transferring the data to the device
Expand the Input Op Statistics to see the statistics for individual input ops and their categories broken down by execution time.
A source data table appears with each entry containing the following information:
- Input Op - Shows the TensorFlow op name of the input op
- Count - Shows the total number of instances of op execution during the profiling period
- Total Time (in ms) - Shows the cumulative sum of time spent on each of those instances
- Total Time % - Shows the total time spent on an op as a fraction of the total time spent in input processing
- Total Self Time (in ms) - Shows the cumulative sum of the self time spent on each of those instances. The self time here measures the time spent inside the function body, excluding the time spent in the function it calls.
- Total Self Time %. Shows the total self time as a fraction of the total time spent on input processing
- Category. Shows the processing category of the input op
The TensorFlow Stats tool displays the performance of every TensorFlow op (op) that is executed on the host or device during a profiling session.
The tool displays performance information in two panes:
The upper pane displays upto four pie charts:
- The distribution of self-execution time of each op on the host
- The distribution of self-execution time of each op type on the host
- The distribution of self-execution time of each op on the device
- The distribution of self-execution time of each op type on the device
The lower pane shows a table that reports data about TensorFlow ops with one row for each op and one column for each type of data (sort columns by clicking the heading of the column). Click the Export as CSV button on the right side of the upper pane to export the data from this table as a CSV file.
If any ops have child ops:
The total "accumulated" time of an op includes the time spent inside the child ops
The total "self" time of an op does not include the time spent inside the child ops
If an op executes on the host:
- The percentage of the total self-time on device incurred by the op on will be 0
- The cumulative percentage of the total self-time on device upto and including this op will be 0
If an op executes on the device:
- The percentage of the total self-time on host incurred by this op will be 0
- The cumulative percentage of the total self-time on host upto and including this op will be 0
You can choose to include or exclude Idle time in the pie charts and table.
The trace viewer displays a timeline that shows:
- Durations for the ops that were executed by your TensorFlow model
- Which part of the system (host or device) executed an op. Typically, the host executes input operations, preprocesses training data and transfers it to the device, while the device executes the actual model training
The trace viewer allows you to identify performance problems in your model, then take steps to resolve them. For example, at a high level, you can identify whether input or model training is taking the majority of the time. Drilling down, you can identify which ops take the longest to execute. Note that the trace viewer is limited to 1 million events per device.
Trace viewer interface
When you open the trace viewer, it appears displaying your most recent run:
This screen contains the following main elements:
- Timeline pane - Shows ops that the device and the host executed over time
- Details pane - Shows additional information for ops selected in the Timeline pane
The Timeline pane contains the following elements:
- Top bar - Contains various auxiliary controls
- Time axis - Shows time relative to the beginning of the trace
- Section and track labels - Each section contains multiple tracks and has a triangle on the left that you can click to expand and collapse the section. There is one section for every processing element in the system
- Tool selector - Contains various tools for interacting with the trace viewer such as Zoom, Pan, Select, and Timing. Use the Timing tool to mark a time interval.
- Events - These show the time during which an op was executed or the duration of meta-events, such as training steps
Sections and tracks
The trace viewer contains the following sections:
- One section for each device node, labeled with the number of the device
chip and the device node within the chip (for example,
/device:GPU:0 (pid 0)). Each device node section contains the following tracks:
- Step - Shows the duration of the training steps that were running on the device
- TensorFlow Ops -. Shows the ops executed on the device
- XLA Ops - Shows XLA operations (ops) that ran on the device if XLA is the compiler used (each TensorFlow op is translated into one or several XLA ops. The XLA compiler translates the XLA ops into code that runs on the device).
- One section for threads running on the host machine's CPU, labeled "Host Threads". The section contains one track for each CPU thread. Note that you can ignore the information displayed alongside the section labels.
Events within the timeline are displayed in different colors; the colors themselves have no specific meaning.
The trace viewer can also display traces of Python function calls in your
TensorFlow program. If you use the
tf.profiler.experimental.start() API, you
can enable Python tracing by using the
ProfilerOptions namedtuple when
starting profiling. Alternatively, if you use the sampling mode for profiling,
you can select the level of tracing by using the dropdown options in the
Capture Profile dialog.
GPU kernel stats
This tool shows performance statistics and the originating op for every GPU accelerated kernel.
The tool displays information in two panes:
The upper pane displays a pie chart which shows the CUDA kernels that have the highest total time elapsed
The lower pane displays a table with the following data for each unique kernel-op pair:
- A rank in descending order of total elapsed GPU duration grouped by kernel-op pair
- The name of the launched kernel
- The number of GPU registers used by the kernel
- The total size of shared (static + dynamic shared) memory used in bytes
- The block dimension expressed as
blockDim.x, blockDim.y, blockDim.z
- The grid dimensions expressed as
gridDim.x, gridDim.y, gridDim.z
- Whether the op is eligible to use TensorCores
- Whether the kernel contains TensorCore instructions
- The name of the op that launched this kernel
- The number of occurrences of this kernel-op pair
- The total elapsed GPU time in microseconds
- The average elapsed GPU time in microseconds
- The minimum elapsed GPU time in microseconds
- The maximum elapsed GPU time in microseconds
Memory profile tool
The Memory Profile tool monitors the memory usage of your device during the profiling interval. You can use this tool to:
- Debug out of memory (OOM) issues by pinpointing peak memory usage and the corresponding memory allocation to TensorFlow ops. You can also debug OOM issues that may arise when you run multi-tenancy inference
- Debug memory fragmentation issues
The memory profile tool displays data in three sections:
- Memory Profile Summary
- Memory Timeline Graph
- Memory Breakdown Table
Memory profile summary
This section displays a high-level summary of the memory profile of your TensorFlow program as shown below:
The memory profile summary has six fields:
- Memory ID - Dropdown which lists all available device memory systems. Select the memory system you want to view from the dropdown
- #Allocation - The number of memory allocations made during the profiling interval
- #Deallocation - The number of memory deallocations in the profiling interval
- Memory Capacity - The total capacity (in GiBs) of the memory system that you select
- Peak Heap Usage - The peak memory usage (in GiBs) since the model started running
- Peak Memory Usage - The peak memory usage (in GiBs) in the profiling
interval. This field contains the following sub-fields:
- Timestamp - The timestamp of when the peak memory usage occurred on the Timeline Graph
- Stack Reservation - Amount of memory reserved on the stack (in GiBs)
- Heap Allocation - Amount of memory allocated on the heap (in GiBs)
- Free Memory - Amount of free memory (in GiBs). The Memory Capacity is the sum total of the Stack Reservation, Heap Allocation, and Free Memory
- Fragmentation - The percentage of fragmentation (lower is better). It is calculated as a percentage of (1 - Size of the largest chunk of free memory / Total free memory)
Memory timeline graph
This section displays a plot of the memory usage (in GiBs) and the percentage of fragmentation versus time (in ms).
The X-axis represents the timeline (in ms) of the profiling interval. The Y-axis on the left represents the memory usage (in GiBs) and the Y-axis on the right represents the percentage of fragmentation. At each point in time on the X-axis, the total memory is broken down into three categories: stack (in red), heap (in orange), and free (in green). Hover over a specific timestamp to view the details about the memory allocation/deallocation events at that point like below:
The pop-up window displays the following information:
- timestamp(ms) - The location of the selected event on the timeline
- event - The type of event (allocation or deallocation)
- requested_size(GiBs) - The amount of memory requested. This will be a negative number for deallocation events
- allocation_size(GiBs) - The actual amount of memory allocated. This will be a negative number for deallocation events
- tf_op - The TensorFlow Op that requests the allocation/deallocation
- step_id - The training step in which this event occurred
- region_type - The data entity type that this allocated memory is for.
Possible values are
outputfor activations and gradients, and
dynamicfor weights and constants
- data_type - The tensor element type (e.g., uint8 for 8-bit unsigned integer)
- tensor_shape - The shape of the tensor being allocated/deallocated
- memory_in_use(GiBs) - The total memory that is in use at this point of time
Memory breakdown table
This table shows the active memory allocations at the point of peak memory usage in the profiling interval.
There is one row for each TensorFlow Op and each row has the following columns:
- Op Name - The name of the TensorFlow op
- Allocation Size (GiBs) - The total amount of memory allocated to this op
- Requested Size (GiBs) - The total amount of memory requested for this op
- Occurrences - The number of allocations for this op
- Region type - The data entity type that this allocated memory is for.
Possible values are
outputfor activations and gradients, and
dynamicfor weights and constants
- Data type - The tensor element type
- Shape - The shape of the allocated tensors
The Pod Viewer tool shows the breakdown of a training step across all workers.
- The upper pane has slider for selecting the step number.
- The lower pane displays a stacked column chart. This is a high level view of broken down step-time categories placed atop one another. Each stacked column represents a unique worker.
- When you hover over a stacked column, the card on the left-hand side shows more details about the step breakdown.
tf.data bottleneck analysis
tf.data bottleneck analysis automatically detects bottlenecks in tf.data input pipelines in your program and provides recommendations on how to fix them. It works with any program using tf.data regardless of the platform (CPU/GPU/TPU) or the framework (TensorFlow/JAX). Its analysis and recommendations are based on this guide.
It detects a bottleneck by following these steps:
- Find the most input bound host.
- Find the slowest execution of tf.data input pipeline.
- Reconstruct the input pipeline graph from the profiler trace.
- Find the critical path in the input pipeline graph.
- Identify the slowest transformation on the critical path as a bottleneck.
The UI is divided into three sections: Performance Analysis Summary, Summary of All Input Pipelines and Input Pipeline Graph.
Performance analysis summary
This section provides the summary of the analysis. It tells whether a slow tf.data input pipeline is detected in the profile. If so, it shows the most input bound host and its slowest input pipeline with the max latency. And most importantly, it tells which part of the input pipeline is the bottleneck and how to fix it. The bottleneck information is provided with the iterator type and its long name.
How to read tf.data iterator's long name
A long name is formatted as
Iterator::<Dataset_1>::...::<Dataset_n>. In the
<Dataset_n> matches the iterator type and the other datasets in the
long name represent downstream transformations.
For example, consider the following input pipeline dataset:
dataset = tf.data.Dataset.range(10).map(lambda x: x).repeat(2).batch(5)
The long names for the iterators from the above dataset will be:
|Iterator Type||Long Name|
Summary of All Input Pipelines
This section provides the summary of all input pipelines across all hosts. Typically there is one input pipeline. When using the distribution strategy, there are one host input pipeline running the program's tf.data code and multiple device input pipelines retrieving data from the host input pipeline and transferring it to the devices.
For each input pipeline, it shows the statistics of its execution time. A call is counted as slow if it takes longer than 50 μs.
Input Pipeline Graph
This section shows the input pipeline graph with the execution time information. You can use "Host" and "Input Pipeline" to choose which host and input pipeline to see. Executions of the input pipeline are sorted by the execution time in descending order which you can use "Rank" to choose.
The nodes on the critical path have bold outlines. The bottleneck node, which is the node with the longest self time on the critical path, has a red outline. The other non-critical nodes have gray dashed outlines.
In each node, "Start Time" indicates the start time of the execution. The same node may be executed multiple times, for example, if there is Batch in the input pipeline. If it is executed multiple times, it is the start time of the first execution.
"Total Duration" is the wall time of the execution. If it is executed multiple times, it is the sum of the wall times of all executions.
"Self Time" is "Total Time" without the overlapped time with its immediate child nodes.
"# Calls" is the number of times the input pipeline is executed.
Collect performance data
The TensorFlow Profiler collects host activities and GPU traces of your TensorFlow model. You can configure the Profiler to collect performance data through either the programmatic mode or the sampling mode.
You can use the following APIs to perform profiling.
Programmatic mode using the TensorBoard Keras Callback (
# Profile from batches 10 to 15 tb_callback = tf.keras.callbacks.TensorBoard(log_dir=log_dir, profile_batch='10, 15') # Train the model and use the TensorBoard Keras callback to collect # performance profiling data model.fit(train_data, steps_per_epoch=20, epochs=5, callbacks=[tb_callback])
Programmatic mode using the
tf.profiler.experimental.start('logdir') # Train the model here tf.profiler.experimental.stop()
Programmatic mode using the context manager
with tf.profiler.experimental.Profile('logdir'): # Train the model here pass
Sampling mode - Perform on-demand profiling by using
tf.profiler.experimental.server.start()to start a gRPC server with your TensorFlow model run. After starting the gRPC server and running your model, you can capture a profile through the Capture Profile button in the TensorBoard profile plugin. Use the script in the Install profiler section above to launch a TensorBoard instance if it is not already running.
As an example,
# Start a profiler server before your model runs. tf.profiler.experimental.server.start(6009) # (Model code goes here). # Send a request to the profiler server to collect a trace of your model. tf.profiler.experimental.client.trace('grpc://localhost:6009', 'gs://your_tb_logdir', 2000)
An example for profiling multiple workers:
# E.g. your worker IP addresses are 10.0.0.2, 10.0.0.3, 10.0.0.4, and you # would like to profile for a duration of 2 seconds. tf.profiler.experimental.client.trace( 'grpc://10.0.0.2:8466,grpc://10.0.0.3:8466,grpc://10.0.0.4:8466', 'gs://your_tb_logdir', 2000)
Use the Capture Profile dialog to specify:
- A comma delimited list of profile service URLs or TPU name.
- A profiling duration.
- The level of device, host, and Python function call tracing.
- How many times you want the Profiler to retry capturing profiles if unsuccessful at first.
Profiling custom training loops
To profile custom training loops in your TensorFlow code, instrument the
training loop with the
tf.profiler.experimental.Trace API to mark the step
boundaries for the Profiler. The
name argument is used as a prefix for the
step names, the
step_num keyword argument is appended in the step names, and
_r keyword argument makes this trace event get processed as a step event
by the Profiler.
As an example,
for step in range(NUM_STEPS): with tf.profiler.experimental.Trace('train', step_num=step, _r=1): train_data = next(dataset) train_step(train_data)
This will enable the Profiler's step-based performance analysis and cause the step events to show up in the trace viewer.
Ensure that you include the dataset iterator within the
tf.profiler.experimental.Trace context for accurate analysis of the input
The code snippet below is an anti-pattern:
for step, train_data in enumerate(dataset): with tf.profiler.experimental.Trace('train', step_num=step, _r=1): train_step(train_data)
Profiling use cases
The profiler covers a number of use cases along four different axes. Some of the combinations are currently supported and others will be added in the future. Some of the use cases are:
- Local vs. Remote profiling: These are two common ways of setting up your profiling environment. In local profiling, the profiling API is called on the same machine your model is executing, for example, a local workstation with GPUs. In remote profiling, the profiling API is called on a different machine from where your model is executing, for example, on a Cloud TPU.
- Profiling multiple workers: You can profile multiple machines when using the distributed training capabilities of TensorFlow.
- Hardware platform: Profile CPUs, GPUs, and TPUs.
The table below is a quick overview of which of the above use cases are supported by the various profiling APIs in TensorFlow:
|Profiling API||Local||Remote||Multiple workers||Hardware Platforms|
|TensorBoard Keras Callback||Supported||Not Supported||Not Supported||CPU, GPU|
||Supported||Not Supported||Not Supported||CPU, GPU|
||Supported||Supported||Supported||CPU, GPU, TPU|
|Context manager API||Supported||Not supported||Not Supported||CPU, GPU|
Best practices for optimal model performance
Use the following recommendations as applicable for your TensorFlow models to achieve optimal performance.
In general, perform all transformations on the device and ensure that you use the latest compatible version of libraries like cuDNN and Intel MKL for your platform.
Optimize the input data pipeline
An efficient data input pipeline can drastically improve the speed of your model execution by reducing device idle time. Consider incorporating the following best practices as detailed here to make your data input pipeline more efficient:
- Prefetch data
- Parallelize data extraction
- Parallelize data transformation
- Cache data in memory
- Vectorize user-defined functions
- Reduce memory usage when applying transformations
Additionally, try running your model with synthetic data to check if the input pipeline is a performance bottleneck.
Improve device performance
- Increase training mini-batch size (number of training samples used per device in one iteration of the training loop)
- Use TF Stats to find out how efficiently on-device ops run
tf.functionto perform computations and optionally, enable the
- Minimize host Python operations between steps and reduce callbacks. Calculate metrics every few steps instead of at every step
- Keep the device compute units busy
- Send data to multiple devices in parallel
- Optimize data layout to prefer channels first (e.g. NCHW over NHWC). Certain GPUs like the NVIDIA® V100 perform better with a NHWC data layout.
- Consider using 16-bit numerical representations such as
fp16, the half-precision floating point format specified by IEEE or the Brain floating-point bfloat16 format
- Consider using the Keras mixed precision API
- When training on GPUs, make use of the TensorCore. GPU kernels use the TensorCore when the precision is fp16 and input/output dimensions are divisible by 8 or 16 (for int8)
- See the end-to-end TensorBoard profiler tutorial to implement the advice in this guide.
- Watch the Performance profiling in TF 2 talk from the TensorFlow Dev Summit 2020.
Profiling multiple GPUs on TensorFlow 2.2 and TensorFlow 2.3
TensorFlow 2.2 and 2.3 support multiple GPU profiling for single host systems
only; multiple GPU profiling for multi-host systems is not supported. To profile
multi-worker GPU configurations, each worker has to be profiled independently.
On TensorFlow 2.4, multiple workers can be profiled using the
CUDA® Toolkit 10.2 or later is required to profile multiple GPUs. As TensorFlow
2.2 and 2.3 support CUDA® Toolkit versions only up to 10.1 , create symbolic
sudo ln -s /usr/local/cuda/lib64/libcudart.so.10.2 /usr/local/cuda/lib64/libcudart.so.10.1 sudo ln -s /usr/local/cuda/extras/CUPTI/lib64/libcupti.so.10.2 /usr/local/cuda/extras/CUPTI/lib64/libcupti.so.10.1