GPROFVIEW
From Jacket Wiki
Back to Jacket Function List, Jacket Basics
Visual representation of profiling data
Supported Syntax
gprofview
GFOR Compatibility?
Yes. See GPROFILE.
Description
GPROFVIEW provides a GUI interface to the data collected by GPROFILE. It provides time plots and graphical breakdowns of execution time to assist users with identifying which sections of their code are consuming the most time. See the GPROFILE page for a detailed description of how the profiling works underneath.
There are three screen types:
- Overview Screen: This is the first screen of data displayed by GPROFVIEW for a piece of profiled code. It provides per-file and per-function CPU and GPU execution times across your entire script. From here you can click on a file to view it in detail or click on a function to see a list of the files in which it appears.
- Function Screen: When a function is clicked on the overview screen you are presented with the list of files in which the function appears. This also displays the CPU and GPU execution times for the function in each specific file.
- File Screen: This is probably the most useful area to explore in GPROFVIEW. From here you can see an execution-time sorted list of the functions appearing in a file, MLint results, and the file contents with several enhancements:
- Clicking on a line number will open the specified code in your MATLAB Editor.
- Clicking on a hyperlinked function will send you to the Function Screen where you can see what other files that function appears in.
- CPU and GPU times are displayed to the left of each line number and particularly time intensive lines are highlighted appropriately.
- Clicking on a line of profiled code (these are highlighted in light gray) provides a table of the first 5 specific invocations of that function. If a function was called more than 5 times in the file a scatterplot of input sizes to time is provided.
From any of these screens you can execute new code by typing your script or code into the text box at the top of the GPROFVIEW interface and clicking "Start Profiler". This will refresh GPROFVIEW when the code completes.
All of the html files and images generated for GPROFVIEW get saved to your hard drive. The absolute path to these files can be seen at the top of the GPROFVIEW interface. To prevent consuming too much hard drive spaces GPROFVIEW cleans up reports older than 24 hours.
Syntax Descriptions
- gprofile on; run_my_function; gprofview: Running GPROFVIEW in the middle of a GPROFILE session like this will open the GUI interface with the data collected by the existing session loaded up for inspection.
- gprofview: When run alone you are presented with the default GPROFVIEW interface. You can then run code from the interface that gets wrapped in a GPROFILE session and displayed when execution completes.