LightGBM::BinaryLogloss Class Reference

Objective function for binary classification. More...

#include <binary_objective.hpp>

Inheritance diagram for LightGBM::BinaryLogloss:

Public Member Functions
	BinaryLogloss (const Config &config, std::function< bool(label_t)> is_pos=nullptr)
	BinaryLogloss (const std::vector< std::string > &strs)
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
double	BoostFromScore (int) const override
bool	ClassNeedTrain (int) const override
const char *	GetName () const override
void	ConvertOutput (const double *input, double *output) const override
std::string	ToString () const override
bool	SkipEmptyClass () const override
bool	NeedAccuratePrediction () const override
	The prediction should be accurate or not. True will disable early stopping for prediction.
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 int	NumModelPerIteration () const
virtual int	NumPredictOneRow () const
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 binary classification.

Member Function Documentation

BoostFromScore()

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

inlineoverridevirtual

Reimplemented from LightGBM::ObjectiveFunction.

ClassNeedTrain()

bool LightGBM::BinaryLogloss::ClassNeedTrain ( int  ) const

inlineoverridevirtual

Reimplemented from LightGBM::ObjectiveFunction.

ConvertOutput()

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

inlineoverridevirtual

Reimplemented from LightGBM::ObjectiveFunction.

GetGradients()

void LightGBM::BinaryLogloss::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::BinaryLogloss::GetName ( ) const

inlineoverridevirtual

Implements LightGBM::ObjectiveFunction.

Init()

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

inlineoverridevirtual

Initialize.

Parameters

metadata	Label data
num_data	Number of data

Implements LightGBM::ObjectiveFunction.

NeedAccuratePrediction()

bool LightGBM::BinaryLogloss::NeedAccuratePrediction ( ) const

inlineoverridevirtual

The prediction should be accurate or not. True will disable early stopping for prediction.

Reimplemented from LightGBM::ObjectiveFunction.

SkipEmptyClass()

bool LightGBM::BinaryLogloss::SkipEmptyClass ( ) const

inlineoverridevirtual

Reimplemented from LightGBM::ObjectiveFunction.

ToString()

std::string LightGBM::BinaryLogloss::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/binary_objective.hpp