xgboost::LinearUpdater Class Reference

interface of linear updater More...

#include <linear_updater.h>

Inheritance diagram for xgboost::LinearUpdater:

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

Static Public Member Functions
static LinearUpdater *	Create (const std::string &name, Context const *)
	Create a linear updater given name.

Protected Attributes
Context const *	ctx_

Detailed Description

interface of linear updater

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.

Parameters

args	arguments to the objective function.

Implemented in xgboost::linear::CoordinateUpdater, and xgboost::linear::ShotgunUpdater.

Create()

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

static

Create a linear updater given name.

Parameters

name	Name of the linear updater.

Update()

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

pure virtual

Updates linear model given gradients.

Parameters

in_gpair	The gradient pair statistics of the data.
data	Input data matrix.
model	Model to be updated.
sum_instance_weight	The sum instance weights, used to normalise l1/l2 penalty.

Implemented in xgboost::linear::CoordinateUpdater, and xgboost::linear::ShotgunUpdater.

---

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

• External/xgboost/include/xgboost/linear_updater.h
• External/xgboost/src/linear/linear_updater.cc