sparse_page_writer.h File Reference

Copyright 2014-2023, XGBoost Contributors. More...

#include <functional>
#include <string>
#include "../common/io.h"
#include "dmlc/io.h"
#include "dmlc/registry.h"
#include "xgboost/data.h"

Go to the source code of this file.

Data Structures
class	xgboost.data::SparsePageFormat< T >
	Format specification of various data formats like SparsePage. More...
struct	xgboost.data::SparsePageFormatReg< T >
	Registry entry for sparse page format. More...

Namespaces
namespace	xgboost
	namespace of xgboost
namespace	xgboost.data
	Copyright 2019-2023, XGBoost Contributors.

Macros
#define	SparsePageFmt   SparsePageFormat<SparsePage>
	Macro to register sparse page format.
#define	XGBOOST_REGISTER_SPARSE_PAGE_FORMAT(Name)    DMLC_REGISTRY_REGISTER(SparsePageFormatReg<SparsePage>, SparsePageFmt, Name)
#define	CSCPageFmt   SparsePageFormat<CSCPage>
#define	XGBOOST_REGISTER_CSC_PAGE_FORMAT(Name)    DMLC_REGISTRY_REGISTER(SparsePageFormatReg<CSCPage>, CSCPageFmt, Name)
#define	SortedCSCPageFmt   SparsePageFormat<SortedCSCPage>
#define	XGBOOST_REGISTER_SORTED_CSC_PAGE_FORMAT(Name)    DMLC_REGISTRY_REGISTER(SparsePageFormatReg<SortedCSCPage>, SortedCSCPageFmt, Name)
#define	EllpackPageFmt   SparsePageFormat<EllpackPage>
#define	XGBOOST_REGISTER_ELLPACK_PAGE_FORMAT(Name)    DMLC_REGISTRY_REGISTER(SparsePageFormatReg<EllpackPage>, EllpackPageFmt, Name)
#define	GHistIndexPageFmt   SparsePageFormat<GHistIndexMatrix>
#define	XGBOOST_REGISTER_GHIST_INDEX_PAGE_FORMAT(Name)

Functions
template<typename T >
SparsePageFormat< T > *	xgboost.data::CreatePageFormat (const std::string &name)
	Create sparse page of format.

Detailed Description

Copyright 2014-2023, XGBoost Contributors.

Author

Tianqi Chen

Macro Definition Documentation

SparsePageFmt

#define SparsePageFmt   SparsePageFormat<SparsePage>

Macro to register sparse page format.

// example of registering a objective
XGBOOST_REGISTER_SPARSE_PAGE_FORMAT(raw)
.describe("Raw binary data format.")
.set_body([]() {
    return new RawFormat();
  });

XGBOOST_REGISTER_GHIST_INDEX_PAGE_FORMAT

#define XGBOOST_REGISTER_GHIST_INDEX_PAGE_FORMAT

(

Name

)

Value:

  DMLC_REGISTRY_REGISTER(SparsePageFormatReg<GHistIndexMatrix>,                \
                         GHistIndexPageFmt, Name)