xgboost
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
xgboost::MetaInfo Class Reference

Meta information about dataset, always sit in memory. More...

#include <data.h>

Collaboration diagram for xgboost::MetaInfo:
Collaboration graph

Public Member Functions

 MetaInfo ()=default
 default constructor More...
 
bst_float GetWeight (size_t i) const
 Get weight of each instances. More...
 
unsigned GetRoot (size_t i) const
 Get the root index of i-th instance. More...
 
const std::vector< size_t > & LabelAbsSort () const
 get sorted indexes (argsort) of labels by absolute value (used by cox loss) More...
 
void Clear ()
 clear all the information More...
 
void LoadBinary (dmlc::Stream *fi)
 Load the Meta info from binary stream. More...
 
void SaveBinary (dmlc::Stream *fo) const
 Save the Meta info to binary stream. More...
 
void SetInfo (const char *key, const void *dptr, DataType dtype, size_t num)
 Set information in the meta info. More...
 

Public Attributes

uint64_t num_row_ {0}
 number of rows in the data More...
 
uint64_t num_col_ {0}
 number of columns in the data More...
 
uint64_t num_nonzero_ {0}
 number of nonzero entries in the data More...
 
HostDeviceVector< bst_floatlabels_
 label of each instance More...
 
std::vector< bst_uintroot_index_
 specified root index of each instance, can be used for multi task setting More...
 
std::vector< bst_uintgroup_ptr_
 the index of begin and end of a group needed when the learning task is ranking. More...
 
HostDeviceVector< bst_floatweights_
 weights of each instance, optional More...
 
std::vector< uint64_t > qids_
 session-id of each instance, optional More...
 
HostDeviceVector< bst_floatbase_margin_
 initialized margins, if specified, xgboost will start from this init margin can be used to specify initial prediction to boost from. More...
 

Static Public Attributes

static const int kVersion = 2
 version flag, used to check version of this info More...
 
static const int kVersionQidAdded = 2
 version that introduced qid field More...
 

Detailed Description

Meta information about dataset, always sit in memory.

Constructor & Destructor Documentation

◆ MetaInfo()

xgboost::MetaInfo::MetaInfo ( )
default

default constructor

Member Function Documentation

◆ Clear()

void xgboost::MetaInfo::Clear ( )

clear all the information

◆ GetRoot()

unsigned xgboost::MetaInfo::GetRoot ( size_t  i) const
inline

Get the root index of i-th instance.

Parameters
iInstance index.
Returns
The pre-defined root index of i-th instance.

◆ GetWeight()

bst_float xgboost::MetaInfo::GetWeight ( size_t  i) const
inline

Get weight of each instances.

Parameters
iInstance index.
Returns
The weight.

◆ LabelAbsSort()

const std::vector<size_t>& xgboost::MetaInfo::LabelAbsSort ( ) const
inline

get sorted indexes (argsort) of labels by absolute value (used by cox loss)

◆ LoadBinary()

void xgboost::MetaInfo::LoadBinary ( dmlc::Stream *  fi)

Load the Meta info from binary stream.

Parameters
fiThe input stream

◆ SaveBinary()

void xgboost::MetaInfo::SaveBinary ( dmlc::Stream *  fo) const

Save the Meta info to binary stream.

Parameters
foThe output stream.

◆ SetInfo()

void xgboost::MetaInfo::SetInfo ( const char *  key,
const void *  dptr,
DataType  dtype,
size_t  num 
)

Set information in the meta info.

Parameters
keyThe key of the information.
dptrThe data pointer of the source array.
dtypeThe type of the source data.
numNumber of elements in the source array.

Member Data Documentation

◆ base_margin_

HostDeviceVector<bst_float> xgboost::MetaInfo::base_margin_

initialized margins, if specified, xgboost will start from this init margin can be used to specify initial prediction to boost from.

◆ group_ptr_

std::vector<bst_uint> xgboost::MetaInfo::group_ptr_

the index of begin and end of a group needed when the learning task is ranking.

◆ kVersion

const int xgboost::MetaInfo::kVersion = 2
static

version flag, used to check version of this info

◆ kVersionQidAdded

const int xgboost::MetaInfo::kVersionQidAdded = 2
static

version that introduced qid field

◆ labels_

HostDeviceVector<bst_float> xgboost::MetaInfo::labels_

label of each instance

◆ num_col_

uint64_t xgboost::MetaInfo::num_col_ {0}

number of columns in the data

◆ num_nonzero_

uint64_t xgboost::MetaInfo::num_nonzero_ {0}

number of nonzero entries in the data

◆ num_row_

uint64_t xgboost::MetaInfo::num_row_ {0}

number of rows in the data

◆ qids_

std::vector<uint64_t> xgboost::MetaInfo::qids_

session-id of each instance, optional

◆ root_index_

std::vector<bst_uint> xgboost::MetaInfo::root_index_

specified root index of each instance, can be used for multi task setting

◆ weights_

HostDeviceVector<bst_float> xgboost::MetaInfo::weights_

weights of each instance, optional


The documentation for this class was generated from the following file: