xgboost

Public Types | Public Member Functions | Public Attributes | List of all members
xgboost::ObjInfo Struct Reference

A struct returned by objective, which determines task at hand. The struct is not used by any algorithm yet, only for future development like categorical split. More...

`#include <task.h>`

Collaboration diagram for xgboost::ObjInfo:

## Public Types
enum | Task : uint8_t { kRegression = 0, kBinary = 1, kClassification = 2, kSurvival = 3, kRanking = 4, kOther = 5 }

## Public Member Functions
| ObjInfo (Task t)
| ObjInfo (Task t, bool khess)

## Public Attributes
enum xgboost::ObjInfo::Task | task
bool | const_hess {false}

## Detailed Description

A struct returned by objective, which determines task at hand. The struct is not used by any algorithm yet, only for future development like categorical split.

The task field is useful for tree split finding, also for some metrics like auc. Lastly, knowing whether hessian is constant can allow some optimizations like skipping the quantile sketching.

This struct should not be serialized since it can be recovered from objective function, hence it doesn't need to be stable.

## Member Enumeration Documentation

## ◆ Task

enum xgboost::ObjInfo::Task : uint8_t

Enumerator
kRegression |
kBinary |
kClassification |
kSurvival |
kRanking |
kOther |

## Constructor & Destructor Documentation

## ◆ ObjInfo() [1/2]

xgboost::ObjInfo::ObjInfo | ( | Task | t | ) |
| inline explicit

## ◆ ObjInfo() [2/2]

xgboost::ObjInfo::ObjInfo | ( | Task | t,
|  | bool | khess
| ) |  |
| inline

## Member Data Documentation

## ◆ const_hess

bool xgboost::ObjInfo::const_hess {false}

## ◆ task

enum xgboost::ObjInfo::Task xgboost::ObjInfo::task

The documentation for this struct was generated from the following file:

- /home/runner/work/xgboost/xgboost/include/xgboost/task.h