xgboost
公共成员函数 | 静态公共成员函数 | 保护属性 | 所有成员列表
xgboost::Predictor 类参考抽象

对 GBTree 的单个训练实例或批量实例执行预测。所有预测函数都将 GBTreeModel 和 DMatrix 作为输入,并输出预测向量。预测器不修改模型本身的任何状态。更多...

#include <predictor.h>

xgboost::Predictor 的协作图
Collaboration graph

公共成员函数

 Predictor (Context const *ctx)
 
virtual ~Predictor ()=default
 
virtual void Configure (Args const &)
 配置并注册预测缓存中的输入矩阵。 更多...
 
virtual void InitOutPredictions (const MetaInfo &info, HostDeviceVector< float > *out_predt, const gbm::GBTreeModel &model) const
 初始化输出预测。 更多...
 
virtual void PredictBatch (DMatrix *dmat, PredictionCacheEntry *out_preds, gbm::GBTreeModel const &model, bst_tree_t tree_begin, bst_tree_t tree_end=0) const =0
 为给定的特征矩阵生成批量预测。如果可用,可以使用缓存的预测而不是从头开始计算。 更多...
 
virtual bool InplacePredict (std::shared_ptr< DMatrix > p_fmat, const gbm::GBTreeModel &model, float missing, PredictionCacheEntry *out_preds, bst_tree_t tree_begin=0, bst_tree_t tree_end=0) const =0
 就地预测。 更多...
 
virtual void PredictLeaf (DMatrix *dmat, HostDeviceVector< float > *out_preds, gbm::GBTreeModel const &model, bst_tree_t tree_end=0) const =0
 预测每棵树的叶子索引,输出将是 nsample * ntree 向量,这仅在 gbtree 预测器中有效。 更多...
 
virtual void PredictContribution (DMatrix *dmat, HostDeviceVector< float > *out_contribs, gbm::GBTreeModel const &model, bst_tree_t tree_end=0, std::vector< float > const *tree_weights=nullptr, bool approximate=false, int condition=0, unsigned condition_feature=0) const =0
 对单个预测的特征贡献;输出将是一个长度为 (nfeats + 1) * num_output_group * nsample 的向量,按此顺序排列。 更多...
 
virtual void PredictInteractionContributions (DMatrix *dmat, HostDeviceVector< float > *out_contribs, gbm::GBTreeModel const &model, bst_tree_t tree_end=0, std::vector< float > const *tree_weights=nullptr, bool approximate=false) const =0
 

静态公共成员函数

static PredictorCreate (std::string const &name, Context const *ctx)
 创建一个新的 Predictor*。 更多...
 

保护属性

Context const * ctx_
 

详细描述

对 GBTree 的单个训练实例或实例批次执行预测。预测函数都将 GBTreeModel 和 DMatrix 作为输入,并输出预测向量。预测器不会修改模型本身的任何状态。

构造函数和析构函数文档

◆ Predictor()

xgboost::Predictor::Predictor ( Context const *  ctx)
内联显式

◆ ~Predictor()

virtual xgboost::Predictor::~Predictor ( )
virtualdefault

成员函数文档

◆ Configure()

virtual void xgboost::Predictor::Configure ( Args const &  )
virtual

配置并注册预测缓存中的输入矩阵。

参数
cfg配置。

◆ Create()

static Predictor* xgboost::Predictor::Create ( std::string const &  name,
Context const *  ctx 
)
static

创建一个新的 Predictor*。

参数
name预测器的名称。
ctx指向运行时参数的指针。

◆ InitOutPredictions()

virtual void xgboost::Predictor::InitOutPredictions ( const MetaInfo info,
HostDeviceVector< float > *  out_predt,
const gbm::GBTreeModel &  model 
) const
virtual

初始化输出预测。

参数
info用于预测的 DMatrix 对象的元信息。
out_predt要初始化的预测向量。
model用于预测的树模型。

◆ InplacePredict()

virtual bool xgboost::Predictor::InplacePredict ( std::shared_ptr< DMatrix p_fmat,
const gbm::GBTreeModel &  model,
float  missing,
PredictionCacheEntry out_preds,
bst_tree_t  tree_begin = 0,
bst_tree_t  tree_end = 0 
) const
纯虚函数

原地预测。

参数
p_fmat一个代理 DMatrix,包含数据和相关的元信息。
model用于预测的模型。
missing数据中的缺失值。
[in,out]out_preds输出预测。
tree_begin(可选)用于预测的增强树的开始。
tree_end(可选)增强树的结束。0 表示不限制树。
返回
如果数据可以由当前预测器处理,则为 True,否则为 false。

◆ PredictBatch()

virtual void xgboost::Predictor::PredictBatch ( DMatrix dmat,
PredictionCacheEntry out_preds,
gbm::GBTreeModel const &  model,
bst_tree_t  tree_begin,
bst_tree_t  tree_end = 0 
) const
纯虚函数

为给定的特征矩阵生成批量预测。如果可用,可以使用缓存的预测而不是从头开始计算。

参数
[in,out]dmat特征矩阵。
[in,out]out_preds输出预测。
model用于预测的模型。
tree_begin树开始索引。
tree_end树结束索引。

◆ PredictContribution()

virtual void xgboost::Predictor::PredictContribution ( DMatrix dmat,
HostDeviceVector< float > *  out_contribs,
gbm::GBTreeModel const &  model,
bst_tree_t  tree_end = 0,
std::vector< float > const *  tree_weights = nullptr,
bool  approximate = false,
int  condition = 0,
unsigned  condition_feature = 0 
) const
纯虚函数

对单个预测的特征贡献;输出将是一个长度为 (nfeats + 1) * num_output_group * nsample 的向量,按此顺序排列。

参数
[in,out]dmat输入特征矩阵。
[in,out]out_contribs输出特征贡献。
model用于进行预测的模型。
tree_end树结束索引。
tree_weights(可选)每个树要乘以的权重。
approximate使用快速近似算法。
condition根据 condition_feature 进行条件(0=否,-1=条件关闭,1=条件开启)。
condition_feature计算过程中要进行条件(即固定)的特征。

◆ PredictInteractionContributions()

virtual void xgboost::Predictor::PredictInteractionContributions ( DMatrix dmat,
HostDeviceVector< float > *  out_contribs,
gbm::GBTreeModel const &  model,
bst_tree_t  tree_end = 0,
std::vector< float > const *  tree_weights = nullptr,
bool  approximate = false 
) const
纯虚函数

◆ PredictLeaf()

virtual void xgboost::Predictor::PredictLeaf ( DMatrix dmat,
HostDeviceVector< float > *  out_preds,
gbm::GBTreeModel const &  model,
bst_tree_t  tree_end = 0 
) const
纯虚函数

预测每棵树的叶子索引,输出将是 nsample * ntree 向量,这仅在 gbtree 预测器中有效。

参数
[in,out]dmat输入特征矩阵。
[in,out]out_preds输出预测。
model用于进行预测的模型。
tree_end(可选)树结束索引。

成员数据文档

◆ ctx_

Context const* xgboost::Predictor::ctx_
protected

此类的文档由以下文件生成