WOLFRAM

Wolfram Language & System Documentation Center

Profile Tutorial

The functions in the Instrumentation` context provide support for profiling WL code.

ProfileInstrument[inputDir,outputDir]instrument WL code for profiling
ProfileEvaluate[expr]evaluate expr to be profiled
ProfileProcess[profilingData]process profiling data
ProfileReport[reportData]generate a report

Profiling WL code.

First we must load the Instrumentation` package
Wolfram Language code: Needs["Instrumentation`"]
Next we must instrument the code to be profiled.
Wolfram Language code: Quiet[DeleteDirectory[FileNameJoin[{$TemporaryDirectory, "Collatz-example"}], DeleteContents -> True], {DeleteDirectory::nodir}]; tmp = CreateDirectory[FileNameJoin[{$TemporaryDirectory, "Collatz-example"}]];
Wolfram Language code: paclet = PacletFind["Instrumentation"][[1]];
Wolfram Language code: file = File[paclet["AssetLocation", "Collatz"]];
Copy the original files to a temporary location.
Wolfram Language code: CreateDirectory[FileNameJoin[{tmp, "Collatz-orig", "Collatz"}], CreateIntermediateDirectories -> True]; CopyFile[file, FileNameJoin[{tmp, "Collatz-orig", "Collatz", "Collatz.m"}]]
Wolfram Language code: ProfileInstrument[FileNameJoin[{tmp, "Collatz-orig", "Collatz"}], FileNameJoin[{FileNameJoin[{tmp, "Collatz-profile", "Collatz"}]}]]
Verify that instrumented code is found
Wolfram Language code: PrependTo[$Path, FileNameJoin[{tmp, "Collatz-profile", "Collatz"}]];
Wolfram Language code: FindFile["Collatz`"]
Load the instrumented code
Wolfram Language code: Needs["Collatz`"]
Evaluate an expression to be profiled
Wolfram Language code: {res, profileData} = ProfileEvaluate[Collatz[27]];
See the result
Wolfram Language code: res
Verify the profiling data is present
Wolfram Language code: profileData
Process the profiling data
Wolfram Language code: reportData = ProfileProcess[profileData];
Generate a report in a separate notebook
Wolfram Language code: ProfileReport[reportData]