ml.dmlc.xgboost4j.java

类 Booster

java.lang.Object

ml.dmlc.xgboost4j.java.Booster

所有实现的接口

com.esotericsoftware.kryo.KryoSerializable, Serializable

public class Booster
extends Object
implements Serializable, com.esotericsoftware.kryo.KryoSerializable

xgboost 的 Booster，这是一个支持交互式构建 XGBoost 模型的模型 API

另请参阅

序列化形式

嵌套类摘要

嵌套类

修饰符和类型	类和描述
静态类	Booster.FeatureImportanceType 支持的特征重要性类型 WEIGHT = 特征用于决定分割的节点数量 GAIN = 特征每次分割的平均信息增益 COVER = 特征每次分割的平均覆盖度 TOTAL_GAIN = 特征所有分割的总信息增益 TOTAL_COVER = 特征所有分割的总覆盖度
静态类	Booster.PredictionType 预测类型，用于 inplace_predict。

字段摘要

字段

修饰符和类型	字段和描述
静态 String	DEFAULT_FORMAT

方法摘要

修饰符和类型	方法和描述
void	boost(DMatrix dtrain, float[] grad, float[] hess) 已弃用。
void	boost(DMatrix dtrain, int iter, float[] grad, float[] hess) 使用给定的 grad 和 hess 进行更新
void	dispose()
String	evalSet(DMatrix[] evalMatrixs, String[] evalNames, IEvaluation eval) 使用给定的自定义 Evaluation 类进行评估
String	evalSet(DMatrix[] evalMatrixs, String[] evalNames, IEvaluation eval, float[] metricsOut)
String	evalSet(DMatrix[] evalMatrixs, String[] evalNames, int iter) 使用给定的 dmatrixs 进行评估。
String	evalSet(DMatrix[] evalMatrixs, String[] evalNames, int iter, float[] metricsOut) 使用给定的 dmatrixs 进行评估。
protected void	finalize()
String	getAttr(String key) 从 Booster 获取属性。
Map<String,String>	getAttrs() 以 Map 形式获取存储在 Booster 中的属性。
String[]	getFeatureNames() 从 Booster 获取特征名称。
Map<String,Integer>	getFeatureScore(String featureMap) 获取每个特征的重要性
Map<String,Integer>	getFeatureScore(String[] featureNames) 获取具有指定特征名称的每个特征的重要性。
String[]	getFeatureTypes() 从 Booster 获取特征类型。
String[]	getModelDump(String[] featureNames, boolean withStats) 以字符串数组形式获取模型的转储，带有指定的特征名称。
String[]	getModelDump(String[] featureNames, boolean withStats, String format)
String[]	getModelDump(String featureMap, boolean withStats) 以字符串数组形式获取模型的转储
String[]	getModelDump(String featureMap, boolean withStats, String format)
int	getNumBoostedRound()
long	getNumFeature() 获取模型特征数量。
Map<String,Double>	getScore(String[] featureNames, String importanceType) 获取基于增益或覆盖（平均或总计）的特征重要性
Map<String,Double>	getScore(String featureMap, String importanceType) 获取基于增益或覆盖（平均或总计）的特征重要性，带有特征名称
float[][]	inplace_predict(float[] data, int nrow, int ncol, float missing) 执行线程安全的预测。
float[][]	inplace_predict(float[] data, int nrow, int ncol, float missing, int[] iteration_range) 执行线程安全的预测。
float[][]	inplace_predict(float[] data, int nrow, int ncol, float missing, int[] iteration_range, Booster.PredictionType predict_type, float[] base_margin) 执行线程安全的预测。
float[][]	predict(DMatrix data) 使用数据进行预测
float[][]	predict(DMatrix data, boolean outputMargin) 使用数据进行预测
float[][]	predict(DMatrix data, boolean outputMargin, int treeLimit) 具有所有选项的高级预测函数。
float[][]	predictContrib(DMatrix data, int treeLimit) 输出给定数据预测的特征贡献
float[][]	predictLeaf(DMatrix data, int treeLimit) 预测给定数据的叶子索引
void	read(com.esotericsoftware.kryo.Kryo kryo, com.esotericsoftware.kryo.io.Input input)
void	saveModel(OutputStream out) 将模型保存到作为输出流打开的文件。
void	saveModel(OutputStream out, String format) 将模型保存到作为输出流打开的文件。
void	saveModel(String modelPath) 将模型保存到 modelPath
void	setAttr(String key, String value) 为 Booster 设置属性。
void	setAttrs(Map<String,String> attrs) 为 Booster 设置属性。
void	setFeatureNames(String[] featureNames) 为 Booster 设置特征名称。
void	setFeatureTypes(String[] featureTypes) 为 Booster 设置特征类型。
void	setParam(String key, Object value) 为 Booster 设置参数。
void	setParams(Map<String,Object> params) 为 Booster 设置参数。
byte[]	toByteArray() 以 UBJSON ("ubj") 格式将模型保存到原始字节数组。
byte[]	toByteArray(String format) 将模型保存到原始字节数组。
void	update(DMatrix dtrain, int iter) 更新 Booster 进行一次迭代。
void	update(DMatrix dtrain, int iter, IObjective obj) 使用自定义 obj 函数进行更新
void	update(DMatrix dtrain, IObjective obj) 已弃用。
void	write(com.esotericsoftware.kryo.Kryo kryo, com.esotericsoftware.kryo.io.Output output)

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

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

字段详细信息

DEFAULT_FORMAT

public static final String DEFAULT_FORMAT

另请参阅

常量字段值

方法详细信息

setParam

public final void setParam(String key,
                           Object value)
                    throws XGBoostError

为 Booster 设置参数。

参数

key - 参数名称

value - 参数值

抛出

XGBoostError - 原生错误

setParams

public void setParams(Map<String,Object> params)
               throws XGBoostError

为 Booster 设置参数。

参数

params - 参数键值对 map

抛出

XGBoostError - 原生错误

getAttrs

public final Map<String,String> getAttrs()
                                  throws XGBoostError

以 Map 形式获取存储在 Booster 中的属性。

返回

包含属性对的 map。

抛出

XGBoostError - 原生错误

getAttr

public final String getAttr(String key)
                     throws XGBoostError

从 Booster 获取属性。

参数

key - 属性键

返回

属性值

抛出

XGBoostError - 原生错误

setAttr

public final void setAttr(String key,
                          String value)
                   throws XGBoostError

为 Booster 设置属性。

参数

key - 属性键

value - 属性值

抛出

XGBoostError - 原生错误

setAttrs

public void setAttrs(Map<String,String> attrs)
              throws XGBoostError

为 Booster 设置属性。

参数

attrs - 属性键值对 map

抛出

XGBoostError - 原生错误

getFeatureNames

public final String[] getFeatureNames()
                               throws XGBoostError

从 Booster 获取特征名称。

返回

抛出

XGBoostError

setFeatureNames

public void setFeatureNames(String[] featureNames)
                     throws XGBoostError

为 Booster 设置特征名称。

参数

featureNames -

抛出

XGBoostError

getFeatureTypes

public final String[] getFeatureTypes()
                               throws XGBoostError

从 Booster 获取特征类型。

返回

抛出

XGBoostError

setFeatureTypes

public void setFeatureTypes(String[] featureTypes)
                     throws XGBoostError

为 Booster 设置特征类型。

参数

featureTypes -

抛出

XGBoostError

update

public void update(DMatrix dtrain,
                   int iter)
            throws XGBoostError

更新 Booster 进行一次迭代。

参数

dtrain - 训练数据

iter - 当前迭代次数

抛出

XGBoostError - 原生错误

update

@Deprecated
public void update(DMatrix dtrain,
                               IObjective obj)
                        throws XGBoostError

已弃用。

抛出

XGBoostError

update

public void update(DMatrix dtrain,
                   int iter,
                   IObjective obj)
            throws XGBoostError

使用自定义 obj 函数进行更新

参数

dtrain - 训练数据

iter - 当前训练迭代次数。

obj - 自定义目标类

抛出

XGBoostError - 原生错误

boost

@Deprecated
public void boost(DMatrix dtrain,
                              float[] grad,
                              float[] hess)
                       throws XGBoostError

已弃用。

抛出

XGBoostError

boost

public void boost(DMatrix dtrain,
                  int iter,
                  float[] grad,
                  float[] hess)
           throws XGBoostError

使用给定的 grad 和 hess 进行更新

参数

dtrain - 训练数据

iter - 当前训练迭代次数。

grad - 一阶梯度

hess - 二阶梯度

抛出

XGBoostError - 原生错误

evalSet

public String evalSet(DMatrix[] evalMatrixs,
                      String[] evalNames,
                      int iter)
               throws XGBoostError

使用给定的 dmatrixs 进行评估。

参数

evalMatrixs - 用于评估的 dmatrixs

evalNames - 评估 dmatrixs 的名称，用于检查结果

iter - 当前评估迭代

返回

评估信息

抛出

XGBoostError - 原生错误

evalSet

public String evalSet(DMatrix[] evalMatrixs,
                      String[] evalNames,
                      int iter,
                      float[] metricsOut)
               throws XGBoostError

使用给定的 dmatrixs 进行评估。

参数

evalMatrixs - 用于评估的 dmatrixs

evalNames - 评估 dmatrixs 的名称，用于检查结果

iter - 当前评估迭代

metricsOut - 输出数组，包含每个 evalMatrix 的评估指标

返回

评估信息

抛出

XGBoostError - 原生错误

evalSet

public String evalSet(DMatrix[] evalMatrixs,
                      String[] evalNames,
                      IEvaluation eval)
               throws XGBoostError

使用给定的自定义 Evaluation 类进行评估

参数

evalMatrixs - 评估矩阵

evalNames - 评估名称

eval - 自定义评估器

返回

评估信息

抛出

XGBoostError - 原生错误

evalSet

public String evalSet(DMatrix[] evalMatrixs,
                      String[] evalNames,
                      IEvaluation eval,
                      float[] metricsOut)
               throws XGBoostError

抛出

XGBoostError

inplace_predict

public float[][] inplace_predict(float[] data,
                                 int nrow,
                                 int ncol,
                                 float missing)
                          throws XGBoostError

执行线程安全的预测。

参数

data - 用于预测的特征的扁平化输入矩阵

nrow - 要进行的预测数量（输入矩阵行数）

ncol - 模型中的特征数量（输入矩阵列数）

missing - 指示 data 输入矩阵中缺失元素的值

返回

预测结果矩阵

抛出

XGBoostError

inplace_predict

public float[][] inplace_predict(float[] data,
                                 int nrow,
                                 int ncol,
                                 float missing,
                                 int[] iteration_range)
                          throws XGBoostError

执行线程安全的预测。

参数

data - 用于预测的特征的扁平化输入矩阵

nrow - 要进行的预测数量（输入矩阵行数）

ncol - 模型中的特征数量（输入矩阵列数）

missing - 指示 data 输入矩阵中缺失元素的值

iteration_range - 指定预测中使用哪一层级的树。例如，如果一个随机森林训练了 100 轮。指定 `iteration_range=[10, 20)`，则本次预测中仅使用在 [10, 20)（左闭右开区间）轮次中构建的森林。

返回

预测结果矩阵

抛出

XGBoostError

inplace_predict

public float[][] inplace_predict(float[] data,
                                 int nrow,
                                 int ncol,
                                 float missing,
                                 int[] iteration_range,
                                 Booster.PredictionType predict_type,
                                 float[] base_margin)
                          throws XGBoostError

执行线程安全的预测。

参数

data - 用于预测的特征的扁平化输入矩阵

nrow - 要进行的预测数量（输入矩阵行数）

ncol - 模型中的特征数量（输入矩阵列数）

missing - 指示 data 输入矩阵中缺失元素的值

iteration_range - 指定预测中使用哪一层级的树。例如，如果一个随机森林训练了 100 轮。指定 `iteration_range=[10, 20)`，则本次预测中仅使用在 [10, 20)（左闭右开区间）轮次中构建的森林。

predict_type - 要运行的预测类型。

返回

预测结果矩阵

抛出

XGBoostError

predictLeaf

public float[][] predictLeaf(DMatrix data,
                             int treeLimit)
                      throws XGBoostError

预测给定数据的叶子索引

参数

data - 输入数据。

treeLimit - 要包含的树数量，0 表示所有树。

返回

实例的叶子索引。

抛出

XGBoostError

predictContrib

public float[][] predictContrib(DMatrix data,
                                int treeLimit)
                         throws XGBoostError

输出给定数据预测的特征贡献

参数

data - 输入数据。

treeLimit - 要包含的树数量，0 表示所有树。

返回

特征贡献和偏差。

抛出

XGBoostError

predict

public float[][] predict(DMatrix data)
                  throws XGBoostError

使用数据进行预测

参数

data - 存储输入的 dmatrix

返回

预测结果

抛出

XGBoostError - 原生错误

predict

public float[][] predict(DMatrix data,
                         boolean outputMargin)
                  throws XGBoostError

使用数据进行预测

参数

data - 数据

outputMargin - 输出边际

返回

预测结果

抛出

XGBoostError

predict

public float[][] predict(DMatrix data,
                         boolean outputMargin,
                         int treeLimit)
                  throws XGBoostError

具有所有选项的高级预测函数。

参数

data - 数据

outputMargin - 输出边际

treeLimit - 限制树数量，0 表示所有树。

返回

预测结果

抛出

XGBoostError

saveModel

public void saveModel(String modelPath)
               throws XGBoostError

将模型保存到 modelPath

参数

modelPath - 模型路径

抛出

XGBoostError

saveModel

public void saveModel(OutputStream out)
               throws XGBoostError,
                      IOException

将模型保存到作为输出流打开的文件。模型格式与其他 xgboost 绑定兼容。输出流只能保存一个 xgboost 模型。此函数保存后将关闭 OutputStream。

参数

out - 输出流

抛出

XGBoostError

IOException

saveModel

public void saveModel(OutputStream out,
                      String format)
               throws XGBoostError,
                      IOException

将模型保存到作为输出流打开的文件。模型格式与其他 xgboost 绑定兼容。输出流只能保存一个 xgboost 模型。此函数保存后将关闭 OutputStream。

参数

out - 输出流

format - 模型格式 (ubj, json, deprecated)

抛出

XGBoostError

IOException

getModelDump

public String[] getModelDump(String featureMap,
                             boolean withStats)
                      throws XGBoostError

以字符串数组形式获取模型的转储

参数

withStats - 控制是否输出分割统计信息。

返回

模型转储信息

抛出

XGBoostError - 原生错误

getModelDump

public String[] getModelDump(String featureMap,
                             boolean withStats,
                             String format)
                      throws XGBoostError

抛出

XGBoostError

getModelDump

public String[] getModelDump(String[] featureNames,
                             boolean withStats)
                      throws XGBoostError

以字符串数组形式获取模型的转储，带有指定的特征名称。

参数

featureNames - 特征名称。

返回

模型转储信息

抛出

XGBoostError

getModelDump

public String[] getModelDump(String[] featureNames,
                             boolean withStats,
                             String format)
                      throws XGBoostError

抛出

XGBoostError

getFeatureScore

public Map<String,Integer> getFeatureScore(String[] featureNames)
                                    throws XGBoostError

获取具有指定特征名称的每个特征的重要性。

返回

featureScoreMap key：特征名称，value：特征重要性分数，可以为 null。

抛出

XGBoostError - 原生错误

getFeatureScore

public Map<String,Integer> getFeatureScore(String featureMap)
                                    throws XGBoostError

获取每个特征的重要性

返回

featureScoreMap key：特征索引，value：特征重要性分数，可以为 null

抛出

XGBoostError - 原生错误

getScore

public Map<String,Double> getScore(String[] featureNames,
                                   String importanceType)
                            throws XGBoostError

获取基于增益或覆盖（平均或总计）的特征重要性

返回

featureImportanceMap key：特征索引，values：基于增益或覆盖的特征重要性分数

抛出

XGBoostError - 原生错误

getScore

public Map<String,Double> getScore(String featureMap,
                                   String importanceType)
                            throws XGBoostError

获取基于增益或覆盖（平均或总计）的特征重要性，带有特征名称

返回

featureImportanceMap key：特征名称，values：基于增益或覆盖的特征重要性分数

抛出

XGBoostError - 原生错误

toByteArray

public byte[] toByteArray()
                   throws XGBoostError

以 UBJSON ("ubj") 格式将模型保存到原始字节数组。

返回

保存的字节数组

抛出

XGBoostError - 原生错误

toByteArray

public byte[] toByteArray(String format)
                   throws XGBoostError

将模型保存到原始字节数组。

参数

format - 输出格式。可用选项包括 "json", "ubj" 和 "deprecated"。

返回

保存的字节数组

抛出

XGBoostError - 原生错误

getNumFeature

public long getNumFeature()
                   throws XGBoostError

获取模型特征数量。

返回

特征数量。

抛出

XGBoostError

getNumBoostedRound

public int getNumBoostedRound()
                       throws XGBoostError

抛出

XGBoostError

finalize

protected void finalize()
                 throws Throwable

覆盖

在类 Object 中覆盖了 finalize

抛出

Throwable

dispose

public void dispose()

write

public void write(com.esotericsoftware.kryo.Kryo kryo,
                  com.esotericsoftware.kryo.io.Output output)

指定者

在接口 com.esotericsoftware.kryo.KryoSerializable 中指定了 write

read

public void read(com.esotericsoftware.kryo.Kryo kryo,
                 com.esotericsoftware.kryo.io.Input input)

指定者

在接口 com.esotericsoftware.kryo.KryoSerializable 中指定了 read