xgboost::linear::ShuffleFeatureSelector Class Reference

Similar to Cyclic but with random feature shuffling prior to each update. More...

#include <coordinate_common.h>

Inheritance diagram for xgboost::linear::ShuffleFeatureSelector:

Public Member Functions
void	Setup (Context const *, const gbm::GBLinearModel &model, const std::vector< GradientPair > &, DMatrix *, float, float, int) override
	Setting up the selector state prior to looping through features.
int	NextFeature (Context const *, int iteration, const gbm::GBLinearModel &model, int, const std::vector< GradientPair > &, DMatrix *, float, float) override
	Select next coordinate to update.
	FeatureSelector ()=default
Public Member Functions inherited from xgboost::linear::FeatureSelector
virtual	~FeatureSelector ()=default
	virtual destructor

Protected Attributes
std::vector< bst_uint >	feat_index_

Additional Inherited Members
Static Public Member Functions inherited from xgboost::linear::FeatureSelector
static FeatureSelector *	Create (int choice)
	factory method

Detailed Description

Similar to Cyclic but with random feature shuffling prior to each update.

Note

Its randomness is controllable by setting a random seed.

Member Function Documentation

NextFeature()

int xgboost::linear::ShuffleFeatureSelector::NextFeature ( Context const *  ctx, int  iteration, const gbm::GBLinearModel &  model, int  group_idx, const std::vector< GradientPair > &  gpair, DMatrix *  p_fmat, float  alpha, float  lambda  )

inlineoverridevirtual

Select next coordinate to update.

Parameters

ctx	Booster context
iteration	The iteration in a loop through features
model	The model.
group_idx	Zero-based index of the group.
gpair	The gpair.
p_fmat	The feature matrix.
alpha	Regularisation alpha.
lambda	Regularisation lambda.

Returns

The index of the selected feature. -1 indicates none selected.

Implements xgboost::linear::FeatureSelector.

Setup()

void xgboost::linear::ShuffleFeatureSelector::Setup ( Context const *  , const gbm::GBLinearModel &  , const std::vector< GradientPair > &  , DMatrix *  , float  , float  , int    )

inlineoverridevirtual

Setting up the selector state prior to looping through features.

Parameters

ctx	The booster context.
model	The model.
gpair	The gpair.
p_fmat	The feature matrix.
alpha	Regularisation alpha.
lambda	Regularisation lambda.
param	A parameter with algorithm-dependent use.

Reimplemented from xgboost::linear::FeatureSelector.

---

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

• External/xgboost/src/linear/coordinate_common.h