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的助推器，这是一个支持交互式构建XGBoost模型的模型API

另请参见

序列化形式

嵌套类摘要

嵌套类

修饰符和类型	类和描述
静态类	Booster.FeatureImportanceType 支持的特征重要性类型： WEIGHT = 特征用于决定拆分的节点数 GAIN = 特征每次拆分的平均信息增益 COVER = 特征每次拆分的平均覆盖 TOTAL_GAIN = 特征所有拆分的总信息增益 TOTAL_COVER = 特征所有拆分的总覆盖
静态类	Booster.PredictionType 此枚举定义了要进行的预测类型，并用于就地预测。

字段摘要

字段

修饰符和类型	字段和说明
static String	DEFAULT_FORMAT

方法摘要

修饰符和类型	方法和说明
void	boost(DMatrix dtrain, float[] grad, float[] hess) 已弃用。
void	boost(DMatrix dtrain, int iter, float[] grad, float[] hess) 使用给定的梯度和Hessian更新
void	dispose()
String	evalSet(DMatrix[] evalMatrixs, String[] evalNames, IEvaluation eval) 使用自定义评估类评估Booster模型
String	evalSet(DMatrix[] evalMatrixs, String[] evalNames, IEvaluation eval, float[] metricsOut)
String	evalSet(DMatrix[] evalMatrixs, String[] evalNames, int iter) 使用给定的DMatrix评估Booster模型。
String	evalSet(DMatrix[] evalMatrixs, String[] evalNames, int iter, float[] metricsOut) 使用给定的DMatrix评估Booster模型。
protected void	finalize()
String	getAttr(String key) 根据提供的键从Booster中获取属性值。
Map<String,String>	getAttrs() 获取存储在Booster中的属性，以Map形式返回。
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) 使用DMatrix格式的测试数据进行预测。
float[][]	predict(DMatrix data, boolean outputMargin) 使用DMatrix格式的测试数据和输出边距进行预测。
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) 更新助推器一次迭代。
void	update(DMatrix dtrain, int iter, IObjective 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 - 参数键值对映射

抛出

XGBoostError - 原生错误

getAttrs

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

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

返回

包含属性对的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 - 属性键值对映射

抛出

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

更新助推器一次迭代。

参数

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

使用自定义对象函数进行更新

参数

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

使用给定的梯度和Hessian更新

参数

dtrain - 训练数据

iter - 当前训练迭代。

grad - 梯度一阶导数

hess - 梯度二阶导数

抛出

XGBoostError - 原生错误

evalSet

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

使用给定的DMatrix评估Booster模型。

参数

evalMatrixs - 用于评估的 DMatrix

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

iter - 当前评估迭代

返回

包含评估结果的评估信息

抛出

XGBoostError - 原生错误

evalSet

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

使用给定的DMatrix评估Booster模型。

参数

evalMatrixs - 用于评估的 DMatrix

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

iter - 当前评估迭代

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

返回

包含评估结果的评估信息

抛出

XGBoostError - 原生错误

evalSet

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

使用自定义评估类评估Booster模型

参数

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

使用DMatrix格式的测试数据进行预测。

参数

data - 存储要进行预测的测试输入的 DMatrix

返回

预测 预测结果，每行对应一个预测。

抛出

XGBoostError - 原生错误

predict

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

使用DMatrix格式的测试数据和输出边距进行预测。

参数

data - 存储要进行预测的测试输入的 DMatrix

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

将模型转储为字符串数组

参数

featureMap - 包含特征映射路径的字符串。

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

返回

转储的模型信息

抛出

XGBoostError - 原生错误

getModelDump

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

以指定特征图、统计信息和指定格式获取模型的转储（字符串数组形式）。

参数

featureMap - 包含特征映射路径的字符串。

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

format - 模型转储的格式（text, json, ubj）。

返回

转储的模型信息

抛出

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

以指定特征图、统计信息和指定格式获取模型的转储（字符串数组形式）。

参数

featureNames - 包含特征名称的字符串数组。

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

format - 模型转储的格式（text, json, ubj）。

返回

转储的模型信息

抛出

XGBoostError

getFeatureScore

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

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

返回

featureScoreMap 键：特征名称，值：特征重要性得分，可为 null。

抛出

XGBoostError - 原生错误

getFeatureScore

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

获取每个特征的重要性

返回

featureScoreMap 键：特征索引，值：特征重要性得分，可为 null

抛出

XGBoostError - 原生错误

getScore

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

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

返回

featureImportanceMap 键：特征索引，值：基于增益或覆盖的特征重要性得分

抛出

XGBoostError - 原生错误

getScore

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

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

返回

featureImportanceMap 键：特征名称，值：基于增益或覆盖的特征重要性得分

抛出

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

覆盖

finalize 在类 Object中

抛出

Throwable

dispose

public void dispose()

write

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

指定者：

write 在接口 com.esotericsoftware.kryo.KryoSerializable中

read

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

指定者：

read 在接口 com.esotericsoftware.kryo.KryoSerializable中