/usr/share/doc/mlpack-doc/guide/timer.hpp is in mlpack-doc 2.1.1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 | /*! @page timer mlpack Timers
@section timerintro Introduction
mlpack provides a simple timer interface for the timing of machine learning
methods. The results of any timers used during the program are displayed at
output by the mlpack::CLI object, when --verbose is given:
@code
$ mlpack_knn -r dataset.csv -n neighbors_out.csv -d distances_out.csv -k 5 -v
<...>
[INFO ] Program timers:
[INFO ] computing_neighbors: 0.010650s
[INFO ] loading_data: 0.002567s
[INFO ] saving_data: 0.001115s
[INFO ] total_time: 0.149816s
[INFO ] tree_building: 0.000534s
@endcode
@section usingtimer Timer API
The mlpack::Timer class provides three simple methods:
@code
void Timer::Start(const char* name);
void Timer::Stop(const char* name);
timeval Timer::Get(const char* name);
@endcode
Each timer is given a name, and is referenced by that name. You can call \c
Timer::Start() and \c Timer::Stop() multiple times for a particular timer name,
and the result will be the sum of the runs of the timer. Note that \c
Timer::Stop() must be called before \c Timer::Start() is called again,
otherwise a std::runtime_error exception will be thrown.
A "total_time" timer is run by default for each mlpack program.
@section example Timer Example
Below is a very simple example of timer usage in code.
@code
#include <mlpack/core.hpp>
using namespace mlpack;
int main(int argc, char** argv)
{
CLI::ParseCommandLine(argc, argv);
// Start a timer.
Timer::Start("some_timer");
// Do some things.
DoSomeStuff();
// Stop the timer.
Timer::Stop("some_timer");
}
@endcode
If the --verbose flag was given to this executable, the resultant time that
"some_timer" ran for would be shown.
*/
|