X-Git-Url: https://git.auder.net/?a=blobdiff_plain;f=man%2FModel.Rd;h=0e52101802461a2cd991eb7b9cd30623901bd993;hb=a7ec4f8a3987ee66daef8471ed1a7a609a987914;hp=32f3ca2ed4ac4f22554a2fc1e8a7422c31e44657;hpb=d9a139b51ee2e71e13d67cb9d530834b15058617;p=agghoo.git diff --git a/man/Model.Rd b/man/Model.Rd index 32f3ca2..0e52101 100644 --- a/man/Model.Rd +++ b/man/Model.Rd @@ -7,7 +7,7 @@ "Model" class, containing a (generic) learning function, which from data + target [+ params] returns a prediction function X --> y. Parameters for cross-validation are either provided or estimated. -Model family can be chosen among "rf", "tree", "ppr" and "knn" for now. +Model family can be chosen among "tree", "ppr" and "knn" for now. } \section{Public fields}{ \if{html}{\out{
}} @@ -21,6 +21,7 @@ Model family can be chosen among "rf", "tree", "ppr" and "knn" for now. \itemize{ \item \href{#method-new}{\code{Model$new()}} \item \href{#method-get}{\code{Model$get()}} +\item \href{#method-getParam}{\code{Model$getParam()}} \item \href{#method-clone}{\code{Model$clone()}} } } @@ -55,7 +56,6 @@ automatically given data and target nature if not provided.} \if{latex}{\out{\hypertarget{method-get}{}}} \subsection{Method \code{get()}}{ Returns the model at index "index", trained on dataHO/targetHO. -index is between 1 and self$nmodels. \subsection{Usage}{ \if{html}{\out{
}}\preformatted{Model$get(dataHO, targetHO, index)}\if{html}{\out{
}} } @@ -67,6 +67,23 @@ index is between 1 and self$nmodels. \item{\code{targetHO}}{Vector of targets (generally numeric or factor)} +\item{\code{index}}{Index of the model in 1...nmodels} +} +\if{html}{\out{
}} +} +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-getParam}{}}} +\subsection{Method \code{getParam()}}{ +Returns the parameter at index "index". +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{Model$getParam(index)}\if{html}{\out{
}} +} + +\subsection{Arguments}{ +\if{html}{\out{
}} +\describe{ \item{\code{index}}{Index of the model in 1...nmodels} } \if{html}{\out{
}}