diff options
| author | Isabella Gottardi <isabella.gottardi@arm.com> | 2021-04-07 17:15:31 +0100 |
|---|---|---|
| committer | Alexander Efremov <alexander.efremov@arm.com> | 2021-04-12 14:00:49 +0000 |
| commit | 8df12f37531d57a10cba2f8b2e8b6a9065202dd5 (patch) | |
| tree | ba833d15649c3b0f885d57b40d3916970b3fd2c8 /docs/sections/customizing.md | |
| parent | 37ce22ebc9cf3e8529d9914c0eed0f718243d961 (diff) | |
| download | ml-embedded-evaluation-kit-8df12f37531d57a10cba2f8b2e8b6a9065202dd5.tar.gz | |
MLECO-1870: Cherry pick profiling changes from dev to open source repo
* Documentation update
Change-Id: If85e7ebc44498840b291c408f14e66a5a5faa424
Signed-off-by: Isabella Gottardi <isabella.gottardi@arm.com>
Diffstat (limited to 'docs/sections/customizing.md')
| -rw-r--r-- | docs/sections/customizing.md | 19 |
1 files changed, 10 insertions, 9 deletions
diff --git a/docs/sections/customizing.md b/docs/sections/customizing.md index e92c327..346a34c 100644 --- a/docs/sections/customizing.md +++ b/docs/sections/customizing.md @@ -243,12 +243,14 @@ Profiler is a helper class assisting in collection of timings and Ethos-U55 cycle counts for operations. It uses platform timer to get system timing information. -| Method name | Description | -|----------------------|-----------------------------------------------------------| -| StartProfiling | Starts profiling and records the starting timing data. | -| StopProfiling | Stops profiling and records the ending timing data. | -| Reset | Resets the profiler and clears all collected data. | -| GetResultsAndReset | Gets the results as string and resets the profiler. | +| Method name | Description | +|-------------------------|----------------------------------------------------------------| +| StartProfiling | Starts profiling and records the starting timing data. | +| StopProfiling | Stops profiling and records the ending timing data. | +| StopProfilingAndReset | Stops the profiling and internally resets the platform timers. | +| Reset | Resets the profiler and clears all collected data. | +| GetAllResultsAndReset | Gets the results as string and resets the profiler. | +| SetName | Set the profiler name. | Usage example: @@ -259,7 +261,7 @@ profiler.StartProfiling(); // Code running inference to profile profiler.StopProfiling(); -info("%s\n", profiler.GetResultsAndReset().c_str()); +profiler.PrintProfilingResult(); ``` ## NN Model API @@ -571,9 +573,8 @@ Profiler profiler{&platform, "Inference"}; profiler.StartProfiling(); model.RunInference(); profiler.StopProfiling(); -std::string profileResults = profiler.GetResultsAndReset(); -info("%s\n", profileResults.c_str()); +profiler.PrintProfilingResult(); ``` ## Printing to console |