Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
xgboost::LinearUpdater Class Referenceabstract

interface of linear updater More...

#include <linear_updater.h>

Inheritance diagram for xgboost::LinearUpdater:
Inheritance graph
Collaboration diagram for xgboost::LinearUpdater:
Collaboration graph

Public Member Functions

 ~LinearUpdater () override=default
 virtual destructor More...
virtual void Configure (const std::vector< std::pair< std::string, std::string > > &args)=0
 Initialize the updater with given arguments. More...
virtual void Update (linalg::Matrix< GradientPair > *in_gpair, DMatrix *data, gbm::GBLinearModel *model, double sum_instance_weight)=0
 Updates linear model given gradients. More...
- Public Member Functions inherited from xgboost::Configurable
virtual ~Configurable ()=default
virtual void LoadConfig (Json const &in)=0
 Load configuration from JSON object. More...
virtual void SaveConfig (Json *out) const =0
 Save configuration to JSON object. More...

Static Public Member Functions

static LinearUpdaterCreate (const std::string &name, Context const *)
 Create a linear updater given name. More...

Protected Attributes

Context const * ctx_

Detailed Description

interface of linear updater

Constructor & Destructor Documentation

◆ ~LinearUpdater()

xgboost::LinearUpdater::~LinearUpdater ( )

virtual destructor

Member Function Documentation

◆ Configure()

virtual void xgboost::LinearUpdater::Configure ( const std::vector< std::pair< std::string, std::string > > &  args)
pure virtual

Initialize the updater with given arguments.

argsarguments to the objective function.

◆ Create()

static LinearUpdater* xgboost::LinearUpdater::Create ( const std::string &  name,
Context const *   

Create a linear updater given name.

nameName of the linear updater.

◆ Update()

virtual void xgboost::LinearUpdater::Update ( linalg::Matrix< GradientPair > *  in_gpair,
DMatrix data,
gbm::GBLinearModel *  model,
double  sum_instance_weight 
pure virtual

Updates linear model given gradients.

in_gpairThe gradient pair statistics of the data.
dataInput data matrix.
modelModel to be updated.
sum_instance_weightThe sum instance weights, used to normalise l1/l2 penalty.

Member Data Documentation

◆ ctx_

Context const* xgboost::LinearUpdater::ctx_

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