LightGBM::CrossEntropy Class Reference

Objective function for cross-entropy (with optional linear weights) More...

#include <xentropy_objective.hpp>

Inheritance diagram for LightGBM::CrossEntropy:

Public Member Functions
	CrossEntropy (const Config &)
	CrossEntropy (const std::vector< std::string > &)
void	Init (const Metadata &metadata, data_size_t num_data) override
	Initialize.
void	GetGradients (const double *score, score_t *gradients, score_t *hessians) const override
	calculating first order derivative of loss function
const char *	GetName () const override
void	ConvertOutput (const double *input, double *output) const override
std::string	ToString () const override
double	BoostFromScore (int) const override
Public Member Functions inherited from LightGBM::ObjectiveFunction
virtual	~ObjectiveFunction ()
	virtual destructor
virtual bool	IsConstantHessian () const
virtual bool	IsRenewTreeOutput () const
virtual double	RenewTreeOutput (double ori_output, const double *, const data_size_t *, const data_size_t *, data_size_t) const
virtual double	RenewTreeOutput (double ori_output, double, const data_size_t *, const data_size_t *, data_size_t) const
virtual bool	ClassNeedTrain (int) const
virtual bool	SkipEmptyClass () const
virtual int	NumModelPerIteration () const
virtual int	NumPredictOneRow () const
virtual bool	NeedAccuratePrediction () const
	The prediction should be accurate or not. True will disable early stopping for prediction.
ObjectiveFunction &	operator= (const ObjectiveFunction &)=delete
	Disable copy.
	ObjectiveFunction (const ObjectiveFunction &)=delete
	Disable copy.

Additional Inherited Members
Static Public Member Functions inherited from LightGBM::ObjectiveFunction
static LIGHTGBM_EXPORT ObjectiveFunction *	CreateObjectiveFunction (const std::string &type, const Config &config)
	Create object of objective function.
static LIGHTGBM_EXPORT ObjectiveFunction *	CreateObjectiveFunction (const std::string &str)
	Load objective function from string object.

Detailed Description

Objective function for cross-entropy (with optional linear weights)

Member Function Documentation

BoostFromScore()

double LightGBM::CrossEntropy::BoostFromScore ( int  ) const

inlineoverridevirtual

Reimplemented from LightGBM::ObjectiveFunction.

ConvertOutput()

void LightGBM::CrossEntropy::ConvertOutput ( const double *  input, double *  output  ) const

inlineoverridevirtual

Reimplemented from LightGBM::ObjectiveFunction.

GetGradients()

void LightGBM::CrossEntropy::GetGradients ( const double *  score, score_t *  gradients, score_t *  hessians  ) const

inlineoverridevirtual

calculating first order derivative of loss function

Parameters

score

prediction score in this round \gradients Output gradients \hessians Output hessians

Implements LightGBM::ObjectiveFunction.

GetName()

const char * LightGBM::CrossEntropy::GetName ( ) const

inlineoverridevirtual

Implements LightGBM::ObjectiveFunction.

Init()

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

inlineoverridevirtual

Initialize.

Parameters

metadata	Label data
num_data	Number of data

Implements LightGBM::ObjectiveFunction.

ToString()

std::string LightGBM::CrossEntropy::ToString ( ) const

inlineoverridevirtual

Implements LightGBM::ObjectiveFunction.

---

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

• External/LightGBM_2.2.3/LightGBM-2.2.3/src/objective/xentropy_objective.hpp