[doc] Clarify the effect of enable_categorical (#9877)

This commit is contained in:
david-cortes
2023-12-13 01:39:41 +01:00
committed by GitHub
parent d530d37707
commit 42173d7bc3
3 changed files with 36 additions and 6 deletions

View File

@@ -58,8 +58,18 @@ frame and matrix.}
\item{feature_weights}{Set feature weights for column sampling.}
\item{enable_categorical}{Experimental support of specializing for
categorical features. JSON/UBJSON serialization format is required.}
\item{enable_categorical}{Experimental support of specializing for categorical features.
If passing 'TRUE' and 'data' is a data frame,
columns of categorical types will automatically
be set to be of categorical type (feature_type='c') in the resulting DMatrix.
If passing 'FALSE' and 'data' is a data frame with categorical columns,
it will result in an error being thrown.
If 'data' is not a data frame, this argument is ignored.
JSON/UBJSON serialization format is required for this.}
}
\description{
Construct xgb.DMatrix object from either a dense matrix, a sparse matrix, or a local file.