ml.dmlc.xgboost4j.java

类 XGBoost

java.lang.Object

ml.dmlc.xgboost4j.java.XGBoost

public class XGBoost
extends Object

xgboost 训练器

作者

hzx

字段摘要

字段

修饰符与类型	字段与描述
static String[]	MAXIMIZ_METRICES

构造器摘要

构造器

构造器与描述
XGBoost()

方法摘要

修饰符与类型	方法与描述
static String[]	crossValidation(DMatrix data, Map<String,Object> params, int round, int nfold, String[] metrics, IObjective obj, IEvaluation eval) 使用给定参数进行交叉验证。
static boolean	isMaximizeEvaluation(String evalInfo, String[] evalNames, Map<String,Object> params)
static Booster	loadModel(byte[] buffer) 从字节数组缓冲区加载新的 Booster 模型。
static Booster	loadModel(InputStream in) 从作为输入流打开的文件加载新的 Booster 模型。
static Booster	loadModel(String modelPath) 从 modelPath 加载模型
static Booster	train(DMatrix dtrain, Map<String,Object> params, int round, Map<String,DMatrix> watches, float[][] metrics, IObjective obj, IEvaluation eval, int earlyStoppingRound) 使用给定参数训练 Booster。
static Booster	train(DMatrix dtrain, Map<String,Object> params, int round, Map<String,DMatrix> watches, float[][] metrics, IObjective obj, IEvaluation eval, int earlyStoppingRounds, Booster booster) 使用给定参数训练 Booster。
static Booster	train(DMatrix dtrain, Map<String,Object> params, int round, Map<String,DMatrix> watches, IObjective obj, IEvaluation eval) 使用给定参数训练 Booster。
static Booster	trainAndSaveCheckpoint(DMatrix dtrain, Map<String,Object> params, int numRounds, Map<String,DMatrix> watches, float[][] metrics, IObjective obj, IEvaluation eval, int earlyStoppingRounds, Booster booster, int checkpointInterval, String checkpointPath, org.apache.hadoop.fs.FileSystem fs)

从类 java.lang.Object 继承的方法

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细信息

MAXIMIZ_METRICES

public static final String[] MAXIMIZ_METRICES

构造器详细信息

XGBoost

public XGBoost()

方法详细信息

loadModel

public static Booster loadModel(String modelPath)
                         throws XGBoostError

从 modelPath 加载模型

参数

modelPath - Booster 的模型路径（由 booster.saveModel 生成的模型）

抛出

XGBoostError - 本地错误

loadModel

public static Booster loadModel(InputStream in)
                         throws XGBoostError,
                                IOException

从作为输入流打开的文件加载新的 Booster 模型。假设输入流只包含一个 XGBoost 模型。这可用于加载由其他 xgboost 绑定保存的现有 Booster 模型。

参数

in - 文件的输入流，在此函数调用后将关闭。

返回值

创建的 Booster

抛出

XGBoostError

IOException

loadModel

public static Booster loadModel(byte[] buffer)
                         throws XGBoostError,
                                IOException

从字节数组缓冲区加载新的 Booster 模型。假设数组只包含一个 XGBoost 模型。这可用于加载由其他 xgboost 绑定保存的现有 Booster 模型。

参数

buffer - Booster 的字节内容。

返回值

创建的 Booster

抛出

XGBoostError

IOException

train

public static Booster train(DMatrix dtrain,
                            Map<String,Object> params,
                            int round,
                            Map<String,DMatrix> watches,
                            IObjective obj,
                            IEvaluation eval)
                     throws XGBoostError

使用给定参数训练 Booster。

参数

dtrain - 要训练的数据。

params - 参数。

round - 提升迭代次数。

watches - 在训练期间要评估的一组项，这允许用户查看验证集上的性能。

obj - 自定义目标函数

eval - 自定义评估函数

返回值

训练好的 Booster。

抛出

XGBoostError

train

public static Booster train(DMatrix dtrain,
                            Map<String,Object> params,
                            int round,
                            Map<String,DMatrix> watches,
                            float[][] metrics,
                            IObjective obj,
                            IEvaluation eval,
                            int earlyStoppingRound)
                     throws XGBoostError

使用给定参数训练 Booster。

参数

dtrain - 要训练的数据。

params - 参数。

round - 提升迭代次数。

watches - 在训练期间要评估的一组项，这允许用户查看验证集上的性能。

metrics - 包含 watches 中每个矩阵在每次迭代的评估指标的数组

earlyStoppingRound - 如果非零，则在任何评估指标连续指定次数增加后停止训练。

obj - 自定义目标函数

eval - 自定义评估函数

返回值

训练好的 Booster。

抛出

XGBoostError

trainAndSaveCheckpoint

public static Booster trainAndSaveCheckpoint(DMatrix dtrain,
                                             Map<String,Object> params,
                                             int numRounds,
                                             Map<String,DMatrix> watches,
                                             float[][] metrics,
                                             IObjective obj,
                                             IEvaluation eval,
                                             int earlyStoppingRounds,
                                             Booster booster,
                                             int checkpointInterval,
                                             String checkpointPath,
                                             org.apache.hadoop.fs.FileSystem fs)
                                      throws XGBoostError,
                                             IOException

抛出

XGBoostError

IOException

train

public static Booster train(DMatrix dtrain,
                            Map<String,Object> params,
                            int round,
                            Map<String,DMatrix> watches,
                            float[][] metrics,
                            IObjective obj,
                            IEvaluation eval,
                            int earlyStoppingRounds,
                            Booster booster)
                     throws XGBoostError

使用给定参数训练 Booster。

参数

dtrain - 要训练的数据。

params - 参数。

round - 提升迭代次数。

watches - 在训练期间要评估的一组项，这允许用户查看验证集上的性能。

metrics - 包含 watches 中每个矩阵在每次迭代的评估指标的数组

earlyStoppingRounds - 如果非零，则在任何评估指标连续指定次数走向非预期方向后停止训练。

obj - 自定义目标函数

eval - 自定义评估函数

booster - 如果设置为 null 则从头开始训练；如果非 null 则从现有 Booster 开始训练。

返回值

训练好的 Booster。

抛出

XGBoostError

isMaximizeEvaluation

public static boolean isMaximizeEvaluation(String evalInfo,
                                           String[] evalNames,
                                           Map<String,Object> params)

crossValidation

public static String[] crossValidation(DMatrix data,
                                       Map<String,Object> params,
                                       int round,
                                       int nfold,
                                       String[] metrics,
                                       IObjective obj,
                                       IEvaluation eval)
                                throws XGBoostError

使用给定参数进行交叉验证。

参数

data - 要训练的数据。

params - Booster 参数。

round - 提升迭代次数。

nfold - CV 中的折叠数。

metrics - 在 CV 中要查看的评估指标。

obj - 自定义目标函数（不使用时设置为 null）

eval - 自定义评估函数（不使用时设置为 null）

返回值

评估历史

抛出

XGBoostError - 本地错误