7 #ifndef XGBOOST_DATA_H_
8 #define XGBOOST_DATA_H_
10 #include <dmlc/base.h>
11 #include <dmlc/data.h>
12 #include <dmlc/serializer.h>
121 if (label_order_cache_.size() ==
labels.
Size()) {
122 return label_order_cache_;
125 std::iota(label_order_cache_.begin(), label_order_cache_.end(), 0);
128 [&l](
size_t i1,
size_t i2) {return std::abs(l[i1]) < std::abs(l[i2]);});
130 return label_order_cache_;
160 const void** out_dptr)
const;
163 void GetFeatureInfo(
const char *field, std::vector<std::string>* out_str_vecs)
const;
183 mutable std::vector<size_t> label_order_cache_;
208 return (this->index == other.
index && this->fvalue == other.
fvalue);
249 return !(*
this != other);
313 offset_vec.push_back(0);
314 data.HostVector().clear();
345 template <
typename AdapterBatchT>
346 uint64_t
Push(
const AdapterBatchT& batch,
float missing,
int nthread);
372 std::shared_ptr<SparsePage const>
page;
382 class EllpackPageImpl;
418 const EllpackPageImpl*
Impl()
const {
return impl_.get(); }
419 EllpackPageImpl*
Impl() {
return impl_.get(); }
422 std::unique_ptr<EllpackPageImpl> impl_;
425 class GHistIndexMatrix;
435 virtual std::shared_ptr<T const>
Page()
const = 0;
446 CHECK(impl_ !=
nullptr);
452 CHECK(impl_ !=
nullptr);
457 CHECK(impl_ !=
nullptr);
458 return !impl_->AtEnd();
462 CHECK(impl_ !=
nullptr);
463 return impl_->AtEnd();
466 std::shared_ptr<T const>
Page()
const {
467 return impl_->Page();
471 std::shared_ptr<BatchIteratorImpl<T>> impl_;
485 struct XGBAPIThreadLocalEntry;
497 auto const& ctx = *this->
Ctx();
500 virtual void SetInfo(
const char* key, std::string
const& interface_str) {
501 auto const& ctx = *this->
Ctx();
518 template <
typename T>
520 template <
typename T>
522 template <
typename T>
549 const std::string& file_format =
"auto");
563 template <
typename AdapterT>
565 const std::string& cache_prefix =
"");
615 int32_t nthread, std::string cache);
641 inline bool DMatrix::PageExists<EllpackPage>()
const {
646 inline bool DMatrix::PageExists<GHistIndexMatrix>()
const {
651 inline bool DMatrix::PageExists<SparsePage>()
const {
684 namespace serializer {
689 strm->Write(data.
index);
694 return strm->Read(&data->
index) && strm->Read(&data->
fvalue);
defines configuration macros of xgboost.
#define XGBOOST_PARALLEL_STABLE_SORT(X, Y, Z)
Definition: base.h:69
#define XGBOOST_DEVICE
Tag function as usable by device.
Definition: base.h:84
virtual BatchIteratorImpl & operator++()=0
std::forward_iterator_tag iterator_category
Definition: data.h:430
virtual std::shared_ptr< T const > Page() const =0
virtual bool AtEnd() const =0
virtual const T & operator*() const =0
virtual ~BatchIteratorImpl()=default
BatchIterator(std::shared_ptr< BatchIteratorImpl< T >> impl)
Definition: data.h:443
std::forward_iterator_tag iterator_category
Definition: data.h:441
BatchIterator(BatchIteratorImpl< T > *impl)
Definition: data.h:442
const T & operator*() const
Definition: data.h:451
std::shared_ptr< T const > Page() const
Definition: data.h:466
BatchIterator & operator++()
Definition: data.h:445
bool operator!=(const BatchIterator &) const
Definition: data.h:456
bool AtEnd() const
Definition: data.h:461
BatchSet(BatchIterator< T > begin_iter)
Definition: data.h:477
BatchIterator< T > begin()
Definition: data.h:478
BatchIterator< T > end()
Definition: data.h:479
CSCPage()
Definition: data.h:362
CSCPage(SparsePage page)
Definition: data.h:363
Internal data structured used by XGBoost during training.
Definition: data.h:490
virtual BatchSet< SortedCSCPage > GetSortedColumnBatches()=0
virtual BatchSet< CSCPage > GetColumnBatches()=0
virtual BatchSet< SparsePage > GetRowBatches()=0
virtual void SetInfo(const char *key, std::string const &interface_str)
Definition: data.h:500
static const size_t kPageSize
Number of rows per page in external memory. Approximately 100MB per page for dataset with 100 feature...
Definition: data.h:620
static DMatrix * Create(DataIterHandle iter, DMatrixHandle proxy, std::shared_ptr< DMatrix > ref, DataIterResetCallback *reset, XGDMatrixCallbackNext *next, float missing, int nthread, bst_bin_t max_bin)
Create a new Quantile based DMatrix used for histogram based algorithm.
static DMatrix * Load(const std::string &uri, bool silent, bool load_row_split, const std::string &file_format="auto")
Load DMatrix from URI.
virtual ~DMatrix()
virtual destructor
virtual MetaInfo & Info()=0
meta information of the dataset
virtual void SetInfo(const char *key, const void *dptr, DataType dtype, size_t num)
Definition: data.h:496
virtual bool GHistIndexExists() const =0
XGBAPIThreadLocalEntry & GetThreadLocal() const
Get thread local memory for returning data from DMatrix.
virtual bool SparsePageExists() const =0
static DMatrix * Create(DataIterHandle iter, DMatrixHandle proxy, DataIterResetCallback *reset, XGDMatrixCallbackNext *next, float missing, int32_t nthread, std::string cache)
Create an external memory DMatrix with callbacks.
virtual DMatrix * Slice(common::Span< int32_t const > ridxs)=0
virtual BatchSet< ExtSparsePage > GetExtBatches(BatchParam const ¶m)=0
virtual Context const * Ctx() const =0
Get the context object of this DMatrix. The context is created during construction of DMatrix with us...
virtual BatchSet< EllpackPage > GetEllpackBatches(const BatchParam ¶m)=0
virtual bool SingleColBlock() const =0
static DMatrix * Create(AdapterT *adapter, float missing, int nthread, const std::string &cache_prefix="")
Creates a new DMatrix from an external data adapter.
BatchSet< T > GetBatches()
Gets batches. Use range based for loop over BatchSet to access individual batches.
virtual const MetaInfo & Info() const =0
meta information of the dataset
BatchSet< T > GetBatches(const BatchParam ¶m)
virtual bool EllpackExists() const =0
virtual BatchSet< GHistIndexMatrix > GetGradientIndex(const BatchParam ¶m)=0
bool IsDense() const
Whether the matrix is dense.
Definition: data.h:532
DMatrix()=default
default constructor
A page stored in ELLPACK format.
Definition: data.h:389
const EllpackPageImpl * Impl() const
Definition: data.h:418
EllpackPageImpl * Impl()
Definition: data.h:419
void SetBaseRowId(size_t row_id)
Set the base row id for this page.
EllpackPage()
Default constructor.
EllpackPage(EllpackPage &&that)
EllpackPage(DMatrix *dmat, const BatchParam ¶m)
Constructor from an existing DMatrix.
~EllpackPage()
Destructor.
Sparse page for exporting DMatrix. Same as SparsePage, just a different type to prevent being used in...
Definition: data.h:370
ExtSparsePage(std::shared_ptr< SparsePage const > p)
Definition: data.h:373
std::shared_ptr< SparsePage const > page
Definition: data.h:372
common::Span< T const > ConstHostSpan() const
Definition: host_device_vector.h:114
std::vector< T > & HostVector()
Data structure representing JSON format.
Definition: json.h:356
SortedCSCPage(SparsePage page)
Definition: data.h:379
SortedCSCPage()
Definition: data.h:378
In-memory storage unit of sparse batch, stored in CSR format.
Definition: data.h:271
void Push(const SparsePage &batch)
Push a sparse page.
SparsePage()
constructor
Definition: data.h:288
SparsePage GetTranspose(int num_columns, int32_t n_threads) const
void SetBaseRowId(size_t row_id)
Set the base row id for this page.
Definition: data.h:318
uint64_t Push(const AdapterBatchT &batch, float missing, int nthread)
Pushes external data batch onto this page.
void PushCSC(const SparsePage &batch)
Push a SparsePage stored in CSC format.
bool IsIndicesSorted(int32_t n_threads) const
Check wether the column index is sorted.
virtual ~SparsePage()=default
void SortIndices(int32_t n_threads)
Sort the column index.
HostDeviceVector< Entry > data
the data of the segments
Definition: data.h:276
HostSparsePageView GetView() const
Definition: data.h:283
HostDeviceVector< bst_row_t > offset
Definition: data.h:274
SparsePage & operator=(SparsePage const &that)=delete
size_t MemCostBytes() const
Definition: data.h:304
void Clear()
clear the page
Definition: data.h:309
SparsePage(SparsePage const &that)=delete
size_t Size() const
Definition: data.h:299
void SortRows(int32_t n_threads)
SparsePage & operator=(SparsePage &&that)=default
SparsePage(SparsePage &&that)=default
size_t base_rowid
Definition: data.h:278
span class implementation, based on ISO++20 span<T>. The interface should be the same.
Definition: span.h:423
constexpr XGBOOST_DEVICE pointer data() const __span_noexcept
Definition: span.h:548
std::size_t index_type
Definition: span.h:427
constexpr XGBOOST_DEVICE index_type size() const __span_noexcept
Definition: span.h:553
constexpr XGBOOST_DEVICE bool empty() const __span_noexcept
Definition: span.h:560
HostDeviceVector< T > * Data()
Definition: linalg.h:778
size_t Size() const
Definition: linalg.h:774
void * DMatrixHandle
handle to DMatrix
Definition: c_api.h:50
int XGDMatrixCallbackNext(DataIterHandle iter)
Callback function prototype for getting next batch of data.
Definition: c_api.h:407
void * DataIterHandle
handle to a external data iterator
Definition: c_api.h:320
void DataIterResetCallback(DataIterHandle handle)
Callback function prototype for resetting external iterator.
Definition: c_api.h:412
A device-and-host vector abstraction layer.
Linear algebra related utilities.
DMLC_DECLARE_TRAITS(is_pod, xgboost::Entry, true)
Definition: intrusive_ptr.h:207
namespace of xgboost
Definition: base.h:110
uint32_t bst_feature_t
Type for data column (feature) index.
Definition: base.h:123
FeatureType
Definition: data.h:41
uint64_t bst_ulong
unsigned long integers
Definition: base.h:117
int32_t bst_bin_t
Type for histogram bin index.
Definition: base.h:125
DataType
data type accepted by xgboost interface
Definition: data.h:33
float bst_float
float type, used for storing statistics
Definition: base.h:119
static void Write(Stream *strm, const xgboost::Entry &data)
Definition: data.h:688
static bool Read(Stream *strm, xgboost::Entry *data)
Definition: data.h:693
Parameters for constructing batches.
Definition: data.h:215
int gpu_id
The GPU device to use.
Definition: data.h:217
common::Span< float > hess
Hessian, used for sketching with future approx implementation.
Definition: data.h:221
bst_bin_t max_bin
Maximum number of bins per feature for histograms.
Definition: data.h:219
bool regen
Whether should DMatrix regenerate the batch. Only used for GHistIndex.
Definition: data.h:223
bool operator==(BatchParam const &other) const
Definition: data.h:248
BatchParam(int32_t device, bst_bin_t max_bin)
Definition: data.h:229
bool operator!=(BatchParam const &other) const
Definition: data.h:242
double sparse_thresh
Parameter used to generate column matrix for hist.
Definition: data.h:225
BatchParam(bst_bin_t max_bin, common::Span< float > hessian, bool regenerate)
Get batch with sketch weighted by hessian. The batch will be regenerated if the span is changed,...
Definition: data.h:239
BatchParam(bst_bin_t max_bin, double sparse_thresh)
Definition: data.h:232
Element from a sparse vector.
Definition: data.h:187
XGBOOST_DEVICE Entry(bst_feature_t index, bst_float fvalue)
constructor with index and value
Definition: data.h:199
Entry()=default
default constructor
bst_feature_t index
feature index
Definition: data.h:189
static bool CmpIndex(Entry const &a, Entry const &b)
Definition: data.h:204
bst_float fvalue
feature value
Definition: data.h:191
bool operator==(const Entry &other) const
Definition: data.h:207
static bool CmpValue(const Entry &a, const Entry &b)
reversely compare feature values
Definition: data.h:201
Definition: generic_parameters.h:15
size_t Size() const
Definition: data.h:265
common::Span< Entry const > data
Definition: data.h:257
Inst operator[](size_t i) const
Definition: data.h:259
common::Span< bst_row_t const > offset
Definition: data.h:256
Definition: string_view.h:15
entry to to easily hold returning information
Definition: learner.h:44