/
LoggerTime.Rd
65 lines (55 loc) · 1.44 KB
/
LoggerTime.Rd
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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/RcppExports.R
\name{LoggerTime}
\alias{LoggerTime}
\title{Logger class to log the elapsed time}
\format{
\code{\link{S4}} object.
}
\description{
This class just logs the elapsed time. This should be very handy if one
wants to run the algorithm for just 2 hours and see how far he comes within
that time. There are three time units available for logging:
\itemize{
\item minutes
\item seconds
\item microseconds
}
}
\section{Usage}{
\preformatted{
LoggerTime$new(logger_id, use_as_stopper, max_time, time_unit)
}
}
\section{Arguments}{
\describe{
\item{\code{logger_id} [\code{character(1)}]}{
Unique identifier of the logger.
}
\item{\code{use_as_stopper} [\code{logical(1)}]}{
Boolean to indicate if the logger should also be used as stopper.
}
\item{\code{max_time} [\code{integer(1)}]}{
If the logger is used as stopper this argument contains the maximal time
which are available to train the model.
}
\item{\code{time_unit} [\code{character(1)}]}{
Character to specify the time unit. Possible choices are \code{minutes},
\code{seconds} or \code{microseconds}
}
}
}
\section{Fields}{
This class doesn't contain public fields.
}
\section{Methods}{
\describe{
\item{\code{summarizeLogger()}}{Summarize the logger object.}
}
}
\examples{
# Define logger:
log_time = LoggerTime$new("time_minutes", FALSE, 20, "minutes")
# Summarize logger:
log_time$summarizeLogger()
}