Hendrik/xgboost
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

small documentation change

Browse Source
This commit is contained in:
El Potaeto 2015-01-01 14:57:48 +01:00
parent 5e5500d6d3
commit 34aaeff3d9
2 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
R-package/R/xgb.importance.R
View File

@ -2,7 +2,6 @@
#' #'
#' Read a xgboost model text dump. #' Read a xgboost model text dump.
#' Can be tree or linear model (text dump of linear model are only supported in dev version of \code{Xgboost} for now). #' Can be tree or linear model (text dump of linear model are only supported in dev version of \code{Xgboost} for now).
#' Return a data.table of the features used in the model with their average gain (and their weight for boosted tree model) in the model.
#' #'
#' @importFrom data.table data.table #' @importFrom data.table data.table
#' @importFrom magrittr %>% #' @importFrom magrittr %>%
@ -11,6 +10,8 @@
#' @param feature_names names of each feature as a character vector. Can be extracted from a sparse matrix (see example). If model dump already contains feature names, this argument should be \code{NULL}. #' @param feature_names names of each feature as a character vector. Can be extracted from a sparse matrix (see example). If model dump already contains feature names, this argument should be \code{NULL}.
#' @param filename_dump the path to the text file storing the model. Model dump must include the gain per feature and per tree (\code{with.stats = T} in function \code{xgb.dump}). #' @param filename_dump the path to the text file storing the model. Model dump must include the gain per feature and per tree (\code{with.stats = T} in function \code{xgb.dump}).
#' #'
#' @return A \code{data.table} of the features used in the model with their average gain (and their weight for boosted tree model) in the model.
#'
#' @details #' @details
#' This is the function to understand the model trained (and through your model, your data). #' This is the function to understand the model trained (and through your model, your data).
#' #'

4
R-package/man/xgb.importance.Rd
View File

@ -11,10 +11,12 @@ xgb.importance(feature_names = NULL, filename_dump = NULL)
\item{filename_dump}{the path to the text file storing the model. Model dump must include the gain per feature and per tree (\code{with.stats = T} in function \code{xgb.dump}).} \item{filename_dump}{the path to the text file storing the model. Model dump must include the gain per feature and per tree (\code{with.stats = T} in function \code{xgb.dump}).}
} }
\value{
A \code{data.table} of the features used in the model with their average gain (and their weight for boosted tree model) in the model.
}
\description{ \description{
Read a xgboost model text dump. Read a xgboost model text dump.
Can be tree or linear model (text dump of linear model are only supported in dev version of \code{Xgboost} for now). Can be tree or linear model (text dump of linear model are only supported in dev version of \code{Xgboost} for now).
Return a data.table of the features used in the model with their average gain (and their weight for boosted tree model) in the model.
} }
\details{ \details{
This is the function to understand the model trained (and through your model, your data). This is the function to understand the model trained (and through your model, your data).