LightGBM::Metric Class Reference

The interface of metric. Metric is used to calculate metric result. More...

#include <metric.h>

Inheritance diagram for LightGBM::Metric:

Public Member Functions
virtual	~Metric ()
	virtual destructor
virtual void	Init (const Metadata &metadata, data_size_t num_data)=0
	Initialize.
virtual const std::vector< std::string > &	GetName () const =0
virtual double	factor_to_bigger_better () const =0
virtual std::vector< double >	Eval (const double *score, const ObjectiveFunction *objective) const =0
	Calcaluting and printing metric result.
Metric &	operator= (const Metric &)=delete
	Disable copy.
	Metric (const Metric &)=delete
	Disable copy.

Static Public Member Functions
static LIGHTGBM_EXPORT Metric *	CreateMetric (const std::string &type, const Config &config)
	Create object of metrics.

Detailed Description

The interface of metric. Metric is used to calculate metric result.

Member Function Documentation

CreateMetric()

Metric * LightGBM::Metric::CreateMetric ( const std::string &  type, const Config &  config  )

static

Create object of metrics.

Parameters

type	Specific type of metric
config	Config for metric

Eval()

virtual std::vector< double > LightGBM::Metric::Eval ( const double *  score, const ObjectiveFunction *  objective  ) const

pure virtual

Calcaluting and printing metric result.

Parameters

score

Current prediction score

Implemented in LightGBM::AUCMetric, LightGBM::MapMetric, LightGBM::NDCGMetric, LightGBM::BinaryMetric< PointWiseLossCalculator >, LightGBM::BinaryMetric< BinaryErrorMetric >, LightGBM::BinaryMetric< BinaryLoglossMetric >, LightGBM::MulticlassMetric< PointWiseLossCalculator >, LightGBM::MulticlassMetric< MultiErrorMetric >, LightGBM::MulticlassMetric< MultiSoftmaxLoglossMetric >, LightGBM::RegressionMetric< PointWiseLossCalculator >, LightGBM::RegressionMetric< FairLossMetric >, LightGBM::RegressionMetric< GammaDevianceMetric >, LightGBM::RegressionMetric< GammaMetric >, LightGBM::RegressionMetric< HuberLossMetric >, LightGBM::RegressionMetric< L1Metric >, LightGBM::RegressionMetric< L2Metric >, LightGBM::RegressionMetric< MAPEMetric >, LightGBM::RegressionMetric< PoissonMetric >, LightGBM::RegressionMetric< QuantileMetric >, LightGBM::RegressionMetric< RMSEMetric >, LightGBM::RegressionMetric< TweedieMetric >, LightGBM::CrossEntropyMetric, LightGBM::CrossEntropyLambdaMetric, and LightGBM::KullbackLeiblerDivergence.

Init()

virtual void LightGBM::Metric::Init ( const Metadata &  metadata, data_size_t  num_data  )

pure virtual

Initialize.

Parameters

test_name	Specific name for this metric, will output on log
metadata	Label data
num_data	Number of data

Implemented in LightGBM::BinaryMetric< PointWiseLossCalculator >, LightGBM::BinaryMetric< BinaryErrorMetric >, LightGBM::BinaryMetric< BinaryLoglossMetric >, LightGBM::AUCMetric, LightGBM::MapMetric, LightGBM::MulticlassMetric< PointWiseLossCalculator >, LightGBM::MulticlassMetric< MultiErrorMetric >, LightGBM::MulticlassMetric< MultiSoftmaxLoglossMetric >, LightGBM::NDCGMetric, LightGBM::RegressionMetric< PointWiseLossCalculator >, LightGBM::RegressionMetric< FairLossMetric >, LightGBM::RegressionMetric< GammaDevianceMetric >, LightGBM::RegressionMetric< GammaMetric >, LightGBM::RegressionMetric< HuberLossMetric >, LightGBM::RegressionMetric< L1Metric >, LightGBM::RegressionMetric< L2Metric >, LightGBM::RegressionMetric< MAPEMetric >, LightGBM::RegressionMetric< PoissonMetric >, LightGBM::RegressionMetric< QuantileMetric >, LightGBM::RegressionMetric< RMSEMetric >, LightGBM::RegressionMetric< TweedieMetric >, LightGBM::CrossEntropyMetric, LightGBM::CrossEntropyLambdaMetric, and LightGBM::KullbackLeiblerDivergence.

---

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

• External/LightGBM_2.2.3/LightGBM-2.2.3/include/LightGBM/metric.h
• External/LightGBM_2.2.3/LightGBM-2.2.3/src/metric/metric.cpp