库

类型定义
typedef void *	DMatrixHandle
	DMatrix 的句柄 更多...
typedef void *	BoosterHandle
	Booster 的句柄 更多...

函数
void	XGBoostVersion (int *major, int *minor, int *patch)
	返回当前使用的 XGBoost 库的版本。 更多...
int	XGBuildInfo (char const **out)
	获取共享库的编译信息。 更多...
const char *	XGBGetLastError ()
	获取上次错误的字符串消息 更多...
int	XGBRegisterLogCallback (void(*callback)(const char *))
	为 LOG(INFO) 消息注册回调函数——有用的消息，而不是错误。注意：此函数可以由多个线程调用。回调函数将在注册它的线程上运行 更多...
int	XGBSetGlobalConfig (char const *config)
	设置全局配置（适用于全局的参数集合）。此函数接受表示要配置的全局范围参数的键值对列表。键值对列表以 JSON 字符串形式传递。 更多...
int	XGBGetGlobalConfig (char const **out_config)
	获取当前全局配置（适用于全局的参数集合）。 更多...

详细描述

这些函数用于获取 XGBoost 的一般信息，包括版本、构建信息和当前全局配置。

类型定义文档

BoosterHandle

typedef void* BoosterHandle

Booster 句柄

DMatrixHandle

typedef void* DMatrixHandle

DMatrix 句柄

函数文档

XGBGetGlobalConfig()

int XGBGetGlobalConfig

(

char const **

out_config

)

获取当前全局配置（适用于全局的参数集合）。

参数

out_config

指向接收到的返回全局配置的指针，表示为 JSON 字符串。

返回

成功返回 0，失败返回 -1

XGBGetLastError()

const char* XGBGetLastError

(

)

获取上一个错误的字符串消息

此文件中的所有函数在成功时返回 0，在发生错误时返回 -1，可以调用 XGBGetLastError 来检索错误

此函数是线程安全的，可以由不同的线程调用

返回

const char* 错误信息

XGBoostVersion()

void XGBoostVersion	(	int *	major,
		int *	minor,
		int *	patch
	)

返回当前使用的 XGBoost 库的版本。

输出变量仅在不为 NULL 时才写入。

参数

major	存储主版本号
minor	存储次版本号
patch	存储补丁（修订）号

XGBRegisterLogCallback()

int XGBRegisterLogCallback

(

void(*)(const char *)

callback

)

为 LOG(INFO) 消息注册回调函数——有用的消息，而不是错误。注意：此函数可以由多个线程调用。回调函数将在注册它的线程上运行

返回

成功返回 0，失败返回 -1

XGBSetGlobalConfig()

int XGBSetGlobalConfig

(

char const *

config

)

设置全局配置（适用于全局的参数集合）。此函数接受表示要配置的全局范围参数的键值对列表。键值对列表以 JSON 字符串形式传递。

参数

config

表示键值对列表的 JSON 字符串。JSON 对象应为扁平结构：任何值都不能是 JSON 对象或数组。

返回

成功返回 0，失败返回 -1

XGBuildInfo()

int XGBuildInfo

(

char const **

out

)

获取共享库的编译信息。

参数

out	包含构建标志和依赖项版本的字符串编码 JSON 对象。

返回

成功返回 0，失败返回 -1