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

Polishing API + wording in function description #Rstat

Browse Source
This commit is contained in:
pommedeterresautee
2015-11-30 10:22:14 +01:00
parent 5e9f4dc973
commit 84ab71dd7e
8 changed files with 41 additions and 77 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
R-package/man/xgb.plot.deepness.Rd
View File

@@ -4,11 +4,9 @@
\alias{xgb.plot.deepness}
\title{Plot model trees deepness}
\usage{
xgb.plot.deepness(filename_dump = NULL, model = NULL)
xgb.plot.deepness(model = NULL)
}
\arguments{
\item{filename_dump}{the path to the text file storing the model. Model dump must include the gain per feature and per tree (parameter \code{with.stats = T} in function \code{xgb.dump}).}
\item{model}{dump generated by the \code{xgb.train} function. Avoid the creation of a dump file.}
}
\value{
@@ -20,7 +18,7 @@ Generate a graph to plot the distribution of deepness among trees.
\details{
Display both the number of \code{leaf} and the distribution of \code{weighted observations}
by tree deepness level.
The purpose of this function is to help the user to find the best trad-off to set
The purpose of this function is to help the user to find the best trade-off to set
the \code{max.depth} and \code{min_child_weight} parameters according to the bias / variance trade-off.
See \link{xgb.train} for more information about these parameters.
@@ -32,7 +30,7 @@ The graph is made of two parts:
\item Weighted cover: noramlized weighted cover per Leaf (weighted number of instances).
}
This function is very inspired from this blog post \url{http://aysent.github.io/2015/11/08/random-forest-leaf-visualization.html}
This function is inspired by this blog post \url{http://aysent.github.io/2015/11/08/random-forest-leaf-visualization.html}
}
\examples{
data(agaricus.train, package='xgboost')