xgboost
类型定义 | 函数

类型定义

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 来获取错误信息。

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

返回值
错误信息

◆ 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 表示失败