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

doc

Browse Source
This commit is contained in:
El Potaeto 2015-01-28 21:42:58 +01:00
parent e35a9f4822
commit 170dcc49be
18 changed files with 44 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
R-package/NAMESPACE
View File

@ -1,4 +1,4 @@
# Generated by roxygen2 (4.0.1): do not edit by hand # Generated by roxygen2 (4.1.0): do not edit by hand
export(getinfo) export(getinfo)
export(setinfo) export(setinfo)

3
R-package/man/agaricus.test.Rd
View File

@ -1,4 +1,5 @@
% Generated by roxygen2 (4.0.1): do not edit by hand % Generated by roxygen2 (4.1.0): do not edit by hand
% Please edit documentation in R/xgboost.R
\docType{data} \docType{data}
\name{agaricus.test} \name{agaricus.test}
\alias{agaricus.test} \alias{agaricus.test}

3
R-package/man/agaricus.train.Rd
View File

@ -1,4 +1,5 @@
% Generated by roxygen2 (4.0.1): do not edit by hand % Generated by roxygen2 (4.1.0): do not edit by hand
% Please edit documentation in R/xgboost.R
\docType{data} \docType{data}
\name{agaricus.train} \name{agaricus.train}
\alias{agaricus.train} \alias{agaricus.train}

7
R-package/man/getinfo.Rd
View File

@ -1,4 +1,5 @@
% Generated by roxygen2 (4.0.1): do not edit by hand % Generated by roxygen2 (4.1.0): do not edit by hand
% Please edit documentation in R/getinfo.xgb.DMatrix.R
\docType{methods} \docType{methods}
\name{getinfo} \name{getinfo}
\alias{getinfo} \alias{getinfo}
@ -12,9 +13,9 @@ getinfo(object, ...)
\arguments{ \arguments{
\item{object}{Object of class "xgb.DMatrix"} \item{object}{Object of class "xgb.DMatrix"}
\item{name}{the name of the field to get}
\item{...}{other parameters} \item{...}{other parameters}
\item{name}{the name of the field to get}
} }
\description{ \description{
Get information of an xgb.DMatrix object Get information of an xgb.DMatrix object

3
R-package/man/predict-xgb.Booster-method.Rd
View File

@ -1,4 +1,5 @@
% Generated by roxygen2 (4.0.1): do not edit by hand % Generated by roxygen2 (4.1.0): do not edit by hand
% Please edit documentation in R/predict.xgb.Booster.R
\docType{methods} \docType{methods}
\name{predict,xgb.Booster-method} \name{predict,xgb.Booster-method}
\alias{predict,xgb.Booster-method} \alias{predict,xgb.Booster-method}

7
R-package/man/setinfo.Rd
View File

@ -1,4 +1,5 @@
% Generated by roxygen2 (4.0.1): do not edit by hand % Generated by roxygen2 (4.1.0): do not edit by hand
% Please edit documentation in R/setinfo.xgb.DMatrix.R
\docType{methods} \docType{methods}
\name{setinfo} \name{setinfo}
\alias{setinfo} \alias{setinfo}
@ -12,11 +13,11 @@ setinfo(object, ...)
\arguments{ \arguments{
\item{object}{Object of class "xgb.DMatrix"} \item{object}{Object of class "xgb.DMatrix"}
\item{...}{other parameters}
\item{name}{the name of the field to get} \item{name}{the name of the field to get}
\item{info}{the specific field of information to set} \item{info}{the specific field of information to set}
\item{...}{other parameters}
} }
\description{ \description{
Set information of an xgb.DMatrix object Set information of an xgb.DMatrix object

7
R-package/man/slice.Rd
View File

@ -1,4 +1,5 @@
% Generated by roxygen2 (4.0.1): do not edit by hand % Generated by roxygen2 (4.1.0): do not edit by hand
% Please edit documentation in R/slice.xgb.DMatrix.R
\docType{methods} \docType{methods}
\name{slice} \name{slice}
\alias{slice} \alias{slice}
@ -13,9 +14,9 @@ slice(object, ...)
\arguments{ \arguments{
\item{object}{Object of class "xgb.DMatrix"} \item{object}{Object of class "xgb.DMatrix"}
\item{idxset}{a integer vector of indices of rows needed}
\item{...}{other parameters} \item{...}{other parameters}
\item{idxset}{a integer vector of indices of rows needed}
} }
\description{ \description{
Get a new DMatrix containing the specified rows of Get a new DMatrix containing the specified rows of

3
R-package/man/xgb.DMatrix.Rd
View File

@ -1,4 +1,5 @@
% Generated by roxygen2 (4.0.1): do not edit by hand % Generated by roxygen2 (4.1.0): do not edit by hand
% Please edit documentation in R/xgb.DMatrix.R
\name{xgb.DMatrix} \name{xgb.DMatrix}
\alias{xgb.DMatrix} \alias{xgb.DMatrix}
\title{Contruct xgb.DMatrix object} \title{Contruct xgb.DMatrix object}

3
R-package/man/xgb.DMatrix.save.Rd
View File

@ -1,4 +1,5 @@
% Generated by roxygen2 (4.0.1): do not edit by hand % Generated by roxygen2 (4.1.0): do not edit by hand
% Please edit documentation in R/xgb.DMatrix.save.R
\name{xgb.DMatrix.save} \name{xgb.DMatrix.save}
\alias{xgb.DMatrix.save} \alias{xgb.DMatrix.save}
\title{Save xgb.DMatrix object to binary file} \title{Save xgb.DMatrix object to binary file}

3
R-package/man/xgb.cv.Rd
View File

@ -1,4 +1,5 @@
% Generated by roxygen2 (4.0.1): do not edit by hand % Generated by roxygen2 (4.1.0): do not edit by hand
% Please edit documentation in R/xgb.cv.R
\name{xgb.cv} \name{xgb.cv}
\alias{xgb.cv} \alias{xgb.cv}
\title{Cross Validation} \title{Cross Validation}

3
R-package/man/xgb.dump.Rd
View File

@ -1,4 +1,5 @@
% Generated by roxygen2 (4.0.1): do not edit by hand % Generated by roxygen2 (4.1.0): do not edit by hand
% Please edit documentation in R/xgb.dump.R
\name{xgb.dump} \name{xgb.dump}
\alias{xgb.dump} \alias{xgb.dump}
\title{Save xgboost model to text file} \title{Save xgboost model to text file}

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

@ -1,4 +1,5 @@
% Generated by roxygen2 (4.0.1): do not edit by hand % Generated by roxygen2 (4.1.0): do not edit by hand
% Please edit documentation in R/xgb.importance.R
\name{xgb.importance} \name{xgb.importance}
\alias{xgb.importance} \alias{xgb.importance}
\title{Show importance of features in a model} \title{Show importance of features in a model}

3
R-package/man/xgb.load.Rd
View File

@ -1,4 +1,5 @@
% Generated by roxygen2 (4.0.1): do not edit by hand % Generated by roxygen2 (4.1.0): do not edit by hand
% Please edit documentation in R/xgb.load.R
\name{xgb.load} \name{xgb.load}
\alias{xgb.load} \alias{xgb.load}
\title{Load xgboost model from binary file} \title{Load xgboost model from binary file}

3
R-package/man/xgb.model.dt.tree.Rd
View File

@ -1,4 +1,5 @@
% Generated by roxygen2 (4.0.1): do not edit by hand % Generated by roxygen2 (4.1.0): do not edit by hand
% Please edit documentation in R/xgb.model.dt.tree.R
\name{xgb.model.dt.tree} \name{xgb.model.dt.tree}
\alias{xgb.model.dt.tree} \alias{xgb.model.dt.tree}
\title{Convert tree model dump to data.table} \title{Convert tree model dump to data.table}

3
R-package/man/xgb.plot.tree.Rd
View File

@ -1,4 +1,5 @@
% Generated by roxygen2 (4.0.1): do not edit by hand % Generated by roxygen2 (4.1.0): do not edit by hand
% Please edit documentation in R/xgb.plot.tree.R
\name{xgb.plot.tree} \name{xgb.plot.tree}
\alias{xgb.plot.tree} \alias{xgb.plot.tree}
\title{Plot a boosted tree model} \title{Plot a boosted tree model}

3
R-package/man/xgb.save.Rd
View File

@ -1,4 +1,5 @@
% Generated by roxygen2 (4.0.1): do not edit by hand % Generated by roxygen2 (4.1.0): do not edit by hand
% Please edit documentation in R/xgb.save.R
\name{xgb.save} \name{xgb.save}
\alias{xgb.save} \alias{xgb.save}
\title{Save xgboost model to binary file} \title{Save xgboost model to binary file}

3
R-package/man/xgb.train.Rd
View File

@ -1,4 +1,5 @@
% Generated by roxygen2 (4.0.1): do not edit by hand % Generated by roxygen2 (4.1.0): do not edit by hand
% Please edit documentation in R/xgb.train.R
\name{xgb.train} \name{xgb.train}
\alias{xgb.train} \alias{xgb.train}
\title{eXtreme Gradient Boosting Training} \title{eXtreme Gradient Boosting Training}

9
R-package/man/xgboost.Rd
View File

@ -1,4 +1,5 @@
% Generated by roxygen2 (4.0.1): do not edit by hand % Generated by roxygen2 (4.1.0): do not edit by hand
% Please edit documentation in R/xgboost.R
\name{xgboost} \name{xgboost}
\alias{xgboost} \alias{xgboost}
\title{eXtreme Gradient Boosting (Tree) library} \title{eXtreme Gradient Boosting (Tree) library}
@ -13,6 +14,9 @@ xgboost(data = NULL, label = NULL, missing = NULL, params = list(),
\item{label}{the response variable. User should not set this field, \item{label}{the response variable. User should not set this field,
if data is local data file or \code{xgb.DMatrix}.} if data is local data file or \code{xgb.DMatrix}.}
\item{missing}{Missing is only used when input is dense matrix, pick a float
value that represents missing value. Sometime a data use 0 or other extreme value to represents missing values.}
\item{params}{the list of parameters. Commonly used ones are: \item{params}{the list of parameters. Commonly used ones are:
\itemize{ \itemize{
\item \code{objective} objective function, common ones are \item \code{objective} objective function, common ones are
@ -34,9 +38,6 @@ if data is local data file or \code{xgb.DMatrix}.}
information of performance. If 2, xgboost will print information of both information of performance. If 2, xgboost will print information of both
performance and construction progress information} performance and construction progress information}
\item{missing}{Missing is only used when input is dense matrix, pick a float
value that represents missing value. Sometime a data use 0 or other extreme value to represents missing values.}
\item{...}{other parameters to pass to \code{params}.} \item{...}{other parameters to pass to \code{params}.}
} }
\description{ \description{