ml.dmlc.xgboost4j.java

类 DMatrix

java.lang.Object

ml.dmlc.xgboost4j.java.DMatrix

public class DMatrix
extends Object

xgboost 的 DMatrix。

作者

hzx

嵌套类摘要

嵌套类

修饰符和类型	类和描述
类	DMatrix.QuantileCut 用于保存分位数信息的类
静态类	DMatrix.SparseType 稀疏矩阵类型（CSR 或 CSC）

字段摘要

字段

修饰符和类型	字段和说明
受保护的 long	handle

构造器摘要

构造器

修饰符	构造器和说明
	DMatrix(BigDenseMatrix matrix) 从 BigDenseMatrix 创建 DMatrix
	DMatrix(BigDenseMatrix matrix, float missing) 从密集矩阵创建 DMatrix
	DMatrix(ColumnBatch columnBatch, float missing, int nthread) 从列数组接口创建普通 DMatrix
	DMatrix(float[] data, int nrow, int ncol) 已弃用。 请使用 DMatrix(float[], int, int, float) 明确指定缺失值
	DMatrix(float[] data, int nrow, int ncol, float missing) 从密集矩阵创建 DMatrix
	DMatrix(Iterator<LabeledPoint> iter, String cacheInfo) 从迭代器创建 DMatrix。
	DMatrix(Iterator<LabeledPoint> iter, String cacheInfo, float missing) 从迭代器创建 DMatrix。
protected	DMatrix(long handle) 用于 DMatrix 切片
	DMatrix(long[] headers, int[] indices, float[] data, DMatrix.SparseType st) 已弃用。
	DMatrix(long[] headers, int[] indices, float[] data, DMatrix.SparseType st, int shapeParam) 从 CSR/CSC 格式的稀疏矩阵创建 DMatrix。
	DMatrix(long[] headers, int[] indices, float[] data, DMatrix.SparseType st, int shapeParam, float missing, int nthread)
	DMatrix(String dataPath) 通过从 dataPath 加载 libsvm 文件创建 DMatrix

方法摘要

修饰符和类型	方法和说明
void	dispose()
受保护的 void	finalize()
float[]	getBaseMargin() 获取 DMatrix 的基本边距。
String[]	getFeatureNames() 获取特征名称
String[]	getFeatureTypes() 获取特征类型
int[]	getGroup() 获取 DMatrix 的组大小
long	getHandle() 获取句柄
float[]	getLabel() 获取标签值
DMatrix.QuantileCut	getQuantileCut() 获取分位数切点。
float[]	getWeight() 获取 DMatrix 的权重
long	nonMissingNum() 获取 DMatrix 的非缺失值数量。
long	rowNum() 获取 DMatrix 的行数
void	saveBinary(String filePath) 将 DMatrix 保存到 filePath
void	setBaseMargin(Column column) 从数组接口设置 DMatrix 的基本边距
void	setBaseMargin(float[] baseMargin) 设置基本边距（初始预测）。
void	setBaseMargin(float[][] baseMargin) 设置基本边距（初始预测）。
void	setFeatureNames(String[] values) 设置特征名称
void	setFeatureTypes(String[] values) 设置特征类型
void	setGroup(int[] group) 设置 DMatrix 的组大小（用于排名）
void	setLabel(Column column) 从数组接口设置 DMatrix 的标签
void	setLabel(float[] labels) 设置 DMatrix 的标签
void	setQueryId(Column column) 从数组接口设置 DMatrix 的查询 ID
void	setQueryId(int[] qid) 设置查询 ID（用于排名）
void	setWeight(Column column) 从数组接口设置 DMatrix 的权重
void	setWeight(float[] weights) 设置每个实例的权重
DMatrix	slice(int[] rowIndex) 切片 DMatrix 并返回只包含 `rowIndex` 的新 DMatrix。

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

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

字段详细信息

handle

protected long handle

构造器详细信息

DMatrix

public DMatrix(Iterator<LabeledPoint> iter,
               String cacheInfo)
        throws XGBoostError

从迭代器创建 DMatrix。

参数

iter - 提供数据的迷你批次数据迭代器。

cacheInfo - 缓存路径信息，用于外部内存设置，可为空。

抛出

XGBoostError

DMatrix

public DMatrix(Iterator<LabeledPoint> iter,
               String cacheInfo,
               float missing)
        throws XGBoostError

从迭代器创建 DMatrix。

参数

iter - 提供数据的迷你批次数据迭代器。

cacheInfo - 缓存路径信息，用于外部内存设置，可为空。

missing - 缺失值

抛出

XGBoostError

DMatrix

public DMatrix(String dataPath)
        throws XGBoostError

通过从 dataPath 加载 libsvm 文件创建 DMatrix

参数

dataPath - 数据路径。

抛出

XGBoostError

DMatrix

@Deprecated
public DMatrix(long[] headers,
                           int[] indices,
                           float[] data,
                           DMatrix.SparseType st)
                    throws XGBoostError

已弃用。

从 CSR/CSC 格式的稀疏矩阵创建 DMatrix。

参数

headers - 矩阵的行索引。

indices - 表示条目的索引。

data - 数据内容。

st - 稀疏类型。

抛出

XGBoostError

DMatrix

public DMatrix(long[] headers,
               int[] indices,
               float[] data,
               DMatrix.SparseType st,
               int shapeParam)
        throws XGBoostError

从 CSR/CSC 格式的稀疏矩阵创建 DMatrix。

参数

headers - 矩阵的行索引。

indices - 表示条目的索引。

data - 数据内容。

st - 稀疏类型。

shapeParam - 当 st 为 CSR 时，它指定列数，否则它被视为行数

抛出

XGBoostError

DMatrix

public DMatrix(long[] headers,
               int[] indices,
               float[] data,
               DMatrix.SparseType st,
               int shapeParam,
               float missing,
               int nthread)
        throws XGBoostError

抛出

XGBoostError

DMatrix

@Deprecated
public DMatrix(float[] data,
                           int nrow,
                           int ncol)
                    throws XGBoostError

已弃用。 请使用 DMatrix(float[], int, int, float) 明确指定缺失值

从密集矩阵创建 DMatrix

参数

data - 数据值

nrow - 行数

ncol - 列数

抛出

XGBoostError - 原生错误

DMatrix

public DMatrix(BigDenseMatrix matrix)
        throws XGBoostError

从 BigDenseMatrix 创建 DMatrix

参数

matrix - BigDenseMatrix 的实例

抛出

XGBoostError - 原生错误

DMatrix

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

从密集矩阵创建 DMatrix

参数

data - 数据值

nrow - 行数

ncol - 列数

missing - 表示缺失值的指定值

抛出

XGBoostError

DMatrix

public DMatrix(BigDenseMatrix matrix,
               float missing)
        throws XGBoostError

从密集矩阵创建 DMatrix

参数

matrix - BigDenseMatrix 的实例

missing - 表示缺失值的指定值

抛出

XGBoostError

DMatrix

protected DMatrix(long handle)

用于 DMatrix 切片

DMatrix

public DMatrix(ColumnBatch columnBatch,
               float missing,
               int nthread)
        throws XGBoostError

从列数组接口创建普通 DMatrix

参数

columnBatch - 提供特征列数组接口的 XGBoost ColumnBatch

missing - 缺失值

nthread - 线程数

抛出

XGBoostError

方法详细信息

setQueryId

public void setQueryId(Column column)
                throws XGBoostError

从数组接口设置 DMatrix 的查询 ID

参数

column - 提供查询 ID 列数组接口的 XGBoost Column

抛出

XGBoostError - 原生错误

getFeatureNames

public String[] getFeatureNames()
                         throws XGBoostError

获取特征名称

返回

要返回的特征名称数组

抛出

XGBoostError

setFeatureNames

public void setFeatureNames(String[] values)
                     throws XGBoostError

设置特征名称

参数

values - 要设置的特征名称

抛出

XGBoostError

getFeatureTypes

public String[] getFeatureTypes()
                         throws XGBoostError

获取特征类型

返回

要返回的特征类型数组

抛出

XGBoostError

setFeatureTypes

public void setFeatureTypes(String[] values)
                     throws XGBoostError

设置特征类型

参数

values - 要设置的特征类型

抛出

XGBoostError

getGroup

public int[] getGroup()
               throws XGBoostError

获取 DMatrix 的组大小

返回

以数组形式表示的组大小

抛出

XGBoostError - 原生错误

setGroup

public void setGroup(int[] group)
              throws XGBoostError

设置 DMatrix 的组大小（用于排名）

参数

group - 以数组形式表示的组大小

抛出

XGBoostError - 原生错误

setQueryId

public void setQueryId(int[] qid)
                throws XGBoostError

设置查询 ID（用于排名）

参数

qid - 查询 ID

抛出

XGBoostError - 原生错误

getLabel

public float[] getLabel()
                 throws XGBoostError

获取标签值

返回

label

抛出

XGBoostError - 原生错误

setLabel

public void setLabel(Column column)
              throws XGBoostError

从数组接口设置 DMatrix 的标签

参数

column - 提供标签列数组接口的 XGBoost Column

抛出

XGBoostError - 原生错误

setLabel

public void setLabel(float[] labels)
              throws XGBoostError

设置 DMatrix 的标签

参数

labels - 标签

抛出

XGBoostError - 原生错误

getWeight

public float[] getWeight()
                  throws XGBoostError

获取 DMatrix 的权重

返回

weights

抛出

XGBoostError - 原生错误

setWeight

public void setWeight(Column column)
               throws XGBoostError

从数组接口设置 DMatrix 的权重

参数

column - 提供权重列数组接口的 XGBoost Column

抛出

XGBoostError - 原生错误

setWeight

public void setWeight(float[] weights)
               throws XGBoostError

设置每个实例的权重

参数

weights - 权重

抛出

XGBoostError - 原生错误

getBaseMargin

public float[] getBaseMargin()
                      throws XGBoostError

获取 DMatrix 的基本边距。

抛出

XGBoostError

setBaseMargin

public void setBaseMargin(Column column)
                   throws XGBoostError

从数组接口设置 DMatrix 的基本边距

参数

column - 提供基本边距列数组接口的 XGBoost Column

抛出

XGBoostError - 原生错误

setBaseMargin

public void setBaseMargin(float[] baseMargin)
                   throws XGBoostError

设置基本边距（初始预测）。

边距必须与此矩阵的行数具有相同数量的元素。

抛出

XGBoostError

setBaseMargin

public void setBaseMargin(float[][] baseMargin)
                   throws XGBoostError

设置基本边距（初始预测）。

抛出

XGBoostError

slice

public DMatrix slice(int[] rowIndex)
              throws XGBoostError

切片 DMatrix 并返回只包含 `rowIndex` 的新 DMatrix。

参数

rowIndex - 行索引

返回

切片后的新 DMatrix

抛出

XGBoostError - 原生错误

rowNum

public long rowNum()
            throws XGBoostError

获取 DMatrix 的行数

返回

行数

抛出

XGBoostError - 原生错误

nonMissingNum

public long nonMissingNum()
                   throws XGBoostError

获取 DMatrix 的非缺失值数量。

返回

非缺失值的数量

抛出

XGBoostError - 原生错误

saveBinary

public void saveBinary(String filePath)

将 DMatrix 保存到 filePath

getHandle

public long getHandle()

获取句柄

finalize

protected void finalize()

覆盖

finalize 在类 Object 中

dispose

public void dispose()

getQuantileCut

public DMatrix.QuantileCut getQuantileCut()
                                   throws XGBoostError

获取分位数切点。

返回

QuantileCut

抛出

XGBoostError