关于数据集的元信息，始终驻留在内存中。更多...

#include <data.h>

xgboost::MetaInfo 的协作图

公共成员函数
	MetaInfo ()

	MetaInfo (MetaInfo &&that)=default

	MetaInfo (MetaInfo const &that)=delete

MetaInfo &	operator= (MetaInfo &&that)=default

MetaInfo &	operator= (MetaInfo const &that)=delete

void	Validate (DeviceOrd device) const
	验证所有元信息。更多...

MetaInfo	Slice (Context const *ctx, common::Span< bst_idx_t const > ridxs, bst_idx_t nnz) const
	切片元信息。更多...

MetaInfo	Copy () const

bool	IsDense () const
	矩阵是否是密集的。更多...

bst_float	GetWeight (size_t i) const
	获取每个实例的权重。更多...

const std::vector< size_t > &	LabelAbsSort (Context const *ctx) const
	按绝对值获取标签的排序索引（argsort）（用于cox损失）。更多...

void	Clear ()
	清除所有信息。更多...

void	LoadBinary (dmlc::Stream *fi)
	从二进制流加载元信息。更多...

void	SaveBinary (dmlc::Stream *fo) const
	将元信息保存到二进制流。更多...

void	SetInfo (Context const &ctx, StringView key, StringView interface_str)
	使用数组接口在元信息中设置信息。更多...

void	GetInfo (char const key, bst_ulong out_len, DataType dtype, const void **out_dptr) const

void	SetFeatureInfo (const char key, const char *info, const bst_ulong size)

void	GetFeatureInfo (const char field, std::vector< std::string > out_str_vecs) const

void	Extend (MetaInfo const &that, bool accumulate_rows, bool check_column)
	扩展其他 MetaInfo。更多...

void	SynchronizeNumberOfColumns (Context const *ctx, DataSplitMode split_mode)
	同步所有工作节点的列数。更多...

bool	IsRowSplit () const
	数据是否按行拆分。更多...

bool	IsColumnSplit () const
	数据是否按列拆分。更多...

bool	IsRanking () const
	这是否是排序学习数据。更多...

bool	IsVerticalFederated () const
	一个方便的方法，用于检查我们是否正在进行垂直联邦学习，这需要一些特殊的处理。更多...

bool	ShouldHaveLabels () const
	一个方便的方法，用于检查 MetaInfo 是否应该包含标签。更多...

bool	HasCategorical () const
	DMatrix 是否具有分类特征的标志。更多...

CatContainer const *	Cats () const
	分类的获取器。更多...

CatContainer *	Cats ()

std::shared_ptr< CatContainer const >	CatsShared () const

void	Cats (std::shared_ptr< CatContainer > cats)
	分类的设置器。更多...

公共属性
bst_idx_t	num_row_ {0}
	数据中的行数。更多...

uint64_t	num_col_ {0}
	数据中的列数。更多...

uint64_t	num_nonzero_ {0}
	数据中非零条目的数量。更多...

linalg::Tensor< float, 2 >	标签
	每个实例的标签。更多...

DataSplitMode	data_split_mode {DataSplitMode::kRow}
	数据拆分模式。更多...

std::vector< bst_group_t >	group_ptr_
	学习任务为排序时所需的组的开始和结束索引。更多...

HostDeviceVector< bst_float >	weights_
	每个实例的权重，可选。更多...

linalg::Matrix< float >	base_margin_
	初始化的边距，如果指定，xgboost 将从这个初始边距开始。可用于指定初始预测以进行提升。更多...

HostDeviceVector< bst_float >	labels_lower_bound_
	标签的下限，用于生存分析（审查回归）。更多...

HostDeviceVector< bst_float >	labels_upper_bound_
	标签的上限，用于生存分析（审查回归）。更多...

std::vector< std::string >	feature_type_names
	用户提供的每个特征的类型名称。例如：“int”/“float”/“i”/“q”。更多...

std::vector< std::string >	feature_names
	每个特征的名称。更多...

HostDeviceVector< FeatureType >	feature_types

HostDeviceVector< float >	feature_weights

静态公共属性
static constexpr uint64_t	kNumField = 13
	MetaInfo 中的数据字段数量。更多...

详细描述

数据集的元信息，始终存储在内存中。

构造函数和析构函数文档

◆ MetaInfo() [1/3]

xgboost::MetaInfo::MetaInfo ( )

◆ MetaInfo() [2/3]

xgboost::MetaInfo::MetaInfo ( MetaInfo && that )

默认

◆ MetaInfo() [3/3]

xgboost::MetaInfo::MetaInfo ( MetaInfo const & that )

删除

成员函数文档

◆ Cats() [1/3]

CatContainer* xgboost::MetaInfo::Cats ( )

◆ Cats() [2/3]

CatContainer const* xgboost::MetaInfo::Cats ( ) const

分类的获取器。

◆ Cats() [3/3]

void xgboost::MetaInfo::Cats ( std::shared_ptr< CatContainer > cats )

分类的设置器。

◆ CatsShared()

std::shared_ptr<CatContainer const> xgboost::MetaInfo::CatsShared ( ) const

◆ Clear()

void xgboost::MetaInfo::Clear ( )

清除所有信息

◆ Copy()

MetaInfo xgboost::MetaInfo::Copy ( ) const

◆ Extend()

void xgboost::MetaInfo::Extend	(	MetaInfo const &	that,
		bool	accumulate_rows,
		bool	check_column
	)

扩展其他 MetaInfo。

参数

that	其他 MetaInfo 对象。
accumulate_rows	此函数中是否需要累积行。如果客户端代码预先知道行数，则将此参数设置为 false。
check_column	扩展方法是否应检查列的一致性。

◆ GetFeatureInfo()

void xgboost::MetaInfo::GetFeatureInfo	(	const char *	field,
		std::vector< std::string > *	out_str_vecs
	)		const

◆ GetInfo()

void xgboost::MetaInfo::GetInfo	(	char const *	key,
		bst_ulong *	out_len,
		DataType	dtype,
		const void **	out_dptr
	)		const

◆ GetWeight()

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

inline

获取每个实例的权重。

参数

i 实例索引。

返回: 权重。

◆ HasCategorical()

bool xgboost::MetaInfo::HasCategorical ( ) const

inline

DMatrix 是否具有分类特征的标志。

◆ IsColumnSplit()

bool xgboost::MetaInfo::IsColumnSplit ( ) const

inline

数据是否按列拆分。

◆ IsDense()

bool xgboost::MetaInfo::IsDense ( ) const

inline

矩阵是否是稠密的。

◆ IsRanking()

bool xgboost::MetaInfo::IsRanking ( ) const

inline

这是否是排序学习数据。

◆ IsRowSplit()

bool xgboost::MetaInfo::IsRowSplit ( ) const

inline

数据是否按行拆分。

◆ IsVerticalFederated()

bool xgboost::MetaInfo::IsVerticalFederated ( ) const

一个方便的方法，用于检查我们是否正在进行垂直联邦学习，这需要一些特殊的处理。

◆ LabelAbsSort()

const std::vector<size_t>& xgboost::MetaInfo::LabelAbsSort ( Context const * ctx ) const

按绝对值获取标签的排序索引（argsort）（用于cox损失）。

◆ LoadBinary()

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

从二进制流加载元信息。

参数

fi 输入流

◆ operator=() [1/2]

MetaInfo& xgboost::MetaInfo::operator= ( MetaInfo && that )

默认

◆ operator=() [2/2]

MetaInfo& xgboost::MetaInfo::operator= ( MetaInfo const & that )

删除

◆ SaveBinary()

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

将元信息保存到二进制流。

参数

fo 输出流。

◆ SetFeatureInfo()

void xgboost::MetaInfo::SetFeatureInfo	(	const char *	key,
		const char **	info,
		const bst_ulong	size
	)

◆ SetInfo()

void xgboost::MetaInfo::SetInfo	(	Context const &	ctx,
		StringView	key,
		StringView	interface_str
	)

使用数组接口在元信息中设置信息。

参数

key	信息的键。
interface_str	JSON 格式数组接口的字符串表示。

◆ ShouldHaveLabels()

bool xgboost::MetaInfo::ShouldHaveLabels ( ) const

一个方便的方法，用于检查 MetaInfo 是否应该包含标签。

通常我们假设标签在所有地方都可用。唯一的例外是在垂直联邦学习中，标签仅在 worker 0 上可用。

◆ Slice()

MetaInfo xgboost::MetaInfo::Slice	(	Context const *	ctx,
		common::Span< bst_idx_t const >	ridxs,
		bst_idx_t	nnz
	)		const

切片元信息。

ridxs 的设备由 ctx 对象指定。

参数

ridxs	选定行的索引。
nnz	非缺失值的数量。

◆ SynchronizeNumberOfColumns()

void xgboost::MetaInfo::SynchronizeNumberOfColumns	(	Context const *	ctx,
		DataSplitMode	split_mode
	)

同步所有工作节点的列数。

通常我们只需要找出所有工作节点的最大列数，但在垂直联邦学习中，由于每个工作节点加载自己的列列表，我们需要对它们求和。

◆ Validate()

void xgboost::MetaInfo::Validate ( DeviceOrd device ) const

验证所有元信息。

成员数据文档

◆ base_margin_

linalg::Matrix<float> xgboost::MetaInfo::base_margin_

初始化的边距，如果指定，xgboost 将从这个初始边距开始。可用于指定初始预测以进行提升。

◆ data_split_mode

DataSplitMode xgboost::MetaInfo::data_split_mode {DataSplitMode::kRow}

数据拆分模式

◆ feature_names

std::vector<std::string> xgboost::MetaInfo::feature_names

每个特征的名称。

◆ feature_type_names

std::vector<std::string> xgboost::MetaInfo::feature_type_names

用户提供的每个特征的类型名称。例如：“int”/“float”/“i”/“q”。

◆ feature_types

HostDeviceVector<FeatureType> xgboost::MetaInfo::feature_types

◆ feature_weights

HostDeviceVector<float> xgboost::MetaInfo::feature_weights

◆ group_ptr_

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

学习任务为排序时所需的组的开始和结束索引。

◆ kNumField

constexpr uint64_t xgboost::MetaInfo::kNumField = 13

staticconstexpr

MetaInfo 中的数据字段数量

◆ labels

linalg::Tensor<float, 2> xgboost::MetaInfo::labels

每个实例的标签

◆ labels_lower_bound_

HostDeviceVector<bst_float> xgboost::MetaInfo::labels_lower_bound_

标签的下限，用于生存分析（审查回归）

◆ labels_upper_bound_

HostDeviceVector<bst_float> xgboost::MetaInfo::labels_upper_bound_

标签的上限，用于生存分析（审查回归）

◆ num_col_

uint64_t xgboost::MetaInfo::num_col_ {0}

数据中的列数

◆ num_nonzero_

uint64_t xgboost::MetaInfo::num_nonzero_ {0}

数据中非零条目的数量

◆ num_row_

bst_idx_t xgboost::MetaInfo::num_row_ {0}

数据中的行数

◆ weights_

HostDeviceVector<bst_float> xgboost::MetaInfo::weights_

每个实例的权重，可选

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

/home/docs/checkouts/readthedocs.org/user_builds/xgboost/checkouts/stable/include/xgboost/data.h

公共成员函数

公共属性

静态公共属性

详细描述

构造函数和析构函数文档

◆ MetaInfo() [1/3]

◆ MetaInfo() [2/3]

◆ MetaInfo() [3/3]

成员函数文档

◆ Cats() [1/3]

◆ Cats() [2/3]

◆ Cats() [3/3]

◆ CatsShared()

◆ Clear()

◆ Copy()

◆ Extend()

◆ GetFeatureInfo()

◆ GetInfo()

◆ GetWeight()

◆ HasCategorical()

◆ IsColumnSplit()

◆ IsDense()

◆ IsRanking()

◆ IsRowSplit()

◆ IsVerticalFederated()

◆ LabelAbsSort()

◆ LoadBinary()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ SaveBinary()

◆ SetFeatureInfo()

◆ SetInfo()

◆ ShouldHaveLabels()

◆ Slice()

◆ SynchronizeNumberOfColumns()

◆ Validate()

成员数据文档

◆ base_margin_

◆ data_split_mode

◆ feature_names

◆ feature_type_names

◆ feature_types

◆ feature_weights

◆ group_ptr_

◆ kNumField

◆ labels

◆ labels_lower_bound_

◆ labels_upper_bound_

◆ num_col_

◆ num_nonzero_

◆ num_row_

◆ weights_