SHOGUN  4.1.0
 全部  命名空间 文件 函数 变量 类型定义 枚举 枚举值 友元 宏定义  
所有成员列表 | Public 成员函数 | Public 属性 | Protected 成员函数
CLossFunction类 参考abstract

详细描述

Class CLossFunction is the base class of all loss functions.

The class provides the loss for one example, first and second derivates of the loss function, (used very commonly) the square of the gradient and the importance-aware weight update for the function. (used mainly for VW)

Refer: Online Importance Weight Aware Updates, Nikos Karampatziakis, John Langford http://arxiv.org/abs/1011.1576

在文件 LossFunction.h57 行定义.

类 CLossFunction 继承关系图:
Inheritance graph
[图例]

Public 成员函数

 CLossFunction ()
 
virtual ~CLossFunction ()
 
virtual float64_t loss (float64_t prediction, float64_t label)
 
virtual float64_t loss (float64_t z)=0
 
virtual float64_t first_derivative (float64_t prediction, float64_t label)
 
virtual float64_t first_derivative (float64_t z)=0
 
virtual float64_t second_derivative (float64_t prediction, float64_t label)
 
virtual float64_t second_derivative (float64_t z)=0
 
virtual float64_t get_update (float64_t prediction, float64_t label, float64_t eta_t, float64_t norm)=0
 
virtual float64_t get_square_grad (float64_t prediction, float64_t label)=0
 
virtual ELossType get_loss_type ()=0
 
virtual const char * get_name () const
 
virtual CSGObjectshallow_copy () const
 
virtual CSGObjectdeep_copy () const
 
virtual bool is_generic (EPrimitiveType *generic) const
 
template<class T >
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
void unset_generic ()
 
virtual void print_serializable (const char *prefix="")
 
virtual bool save_serializable (CSerializableFile *file, const char *prefix="")
 
virtual bool load_serializable (CSerializableFile *file, const char *prefix="")
 
void set_global_io (SGIO *io)
 
SGIOget_global_io ()
 
void set_global_parallel (Parallel *parallel)
 
Parallelget_global_parallel ()
 
void set_global_version (Version *version)
 
Versionget_global_version ()
 
SGStringList< char > get_modelsel_names ()
 
void print_modsel_params ()
 
char * get_modsel_param_descr (const char *param_name)
 
index_t get_modsel_param_index (const char *param_name)
 
void build_gradient_parameter_dictionary (CMap< TParameter *, CSGObject * > *dict)
 
virtual void update_parameter_hash ()
 
virtual bool parameter_hash_changed ()
 
virtual bool equals (CSGObject *other, float64_t accuracy=0.0, bool tolerant=false)
 
virtual CSGObjectclone ()
 

Public 属性

SGIOio
 
Parallelparallel
 
Versionversion
 
Parameterm_parameters
 
Parameterm_model_selection_parameters
 
Parameterm_gradient_parameters
 
uint32_t m_hash
 

Protected 成员函数

virtual void load_serializable_pre () throw (ShogunException)
 
virtual void load_serializable_post () throw (ShogunException)
 
virtual void save_serializable_pre () throw (ShogunException)
 
virtual void save_serializable_post () throw (ShogunException)
 

构造及析构函数说明

Constructor

在文件 LossFunction.h64 行定义.

virtual ~CLossFunction ( )
virtual

Destructor

在文件 LossFunction.h69 行定义.

成员函数说明

void build_gradient_parameter_dictionary ( CMap< TParameter *, CSGObject * > *  dict)
inherited

Builds a dictionary of all parameters in SGObject as well of those of SGObjects that are parameters of this object. Dictionary maps parameters to the objects that own them.

参数
dictdictionary of parameters to be built.

在文件 SGObject.cpp597 行定义.

CSGObject * clone ( )
virtualinherited

Creates a clone of the current object. This is done via recursively traversing all parameters, which corresponds to a deep copy. Calling equals on the cloned object always returns true although none of the memory of both objects overlaps.

返回
an identical copy of the given object, which is disjoint in memory. NULL if the clone fails. Note that the returned object is SG_REF'ed

在文件 SGObject.cpp714 行定义.

CSGObject * deep_copy ( ) const
virtualinherited

A deep copy. All the instance variables will also be copied.

在文件 SGObject.cpp198 行定义.

bool equals ( CSGObject other,
float64_t  accuracy = 0.0,
bool  tolerant = false 
)
virtualinherited

Recursively compares the current SGObject to another one. Compares all registered numerical parameters, recursion upon complex (SGObject) parameters. Does not compare pointers!

May be overwritten but please do with care! Should not be necessary in most cases.

参数
otherobject to compare with
accuracyaccuracy to use for comparison (optional)
tolerantallows linient check on float equality (within accuracy)
返回
true if all parameters were equal, false if not

在文件 SGObject.cpp618 行定义.

virtual float64_t first_derivative ( float64_t  prediction,
float64_t  label 
)
virtual

Get first derivative of the loss function

参数
predictionprediction
labellabel
返回
first derivative

CHuberLoss, CAbsoluteDeviationLoss, CExponentialLoss, CHingeLoss , 以及 CSquaredLoss 重载.

在文件 LossFunction.h101 行定义.

virtual float64_t first_derivative ( float64_t  z)
pure virtual

Get first derivative of the loss function

参数
zwhere to evaluate the derivative of the loss
返回
first derivative

CHuberLoss, CAbsoluteDeviationLoss, CExponentialLoss, CHingeLoss, CSquaredLoss, CLogLoss, CLogLossMargin, CSmoothHingeLoss , 以及 CSquaredHingeLoss 内被实现.

SGIO * get_global_io ( )
inherited

get the io object

返回
io object

在文件 SGObject.cpp235 行定义.

Parallel * get_global_parallel ( )
inherited

get the parallel object

返回
parallel object

在文件 SGObject.cpp277 行定义.

Version * get_global_version ( )
inherited

get the version object

返回
version object

在文件 SGObject.cpp290 行定义.

virtual ELossType get_loss_type ( )
pure virtual

Get loss type

abstract base method

返回
loss type as enum

CHuberLoss, CHingeLoss, CSquaredLoss, CAbsoluteDeviationLoss, CExponentialLoss, CLogLoss, CLogLossMargin, CSmoothHingeLoss , 以及 CSquaredHingeLoss 内被实现.

SGStringList< char > get_modelsel_names ( )
inherited
返回
vector of names of all parameters which are registered for model selection

在文件 SGObject.cpp498 行定义.

char * get_modsel_param_descr ( const char *  param_name)
inherited

Returns description of a given parameter string, if it exists. SG_ERROR otherwise

参数
param_namename of the parameter
返回
description of the parameter

在文件 SGObject.cpp522 行定义.

index_t get_modsel_param_index ( const char *  param_name)
inherited

Returns index of model selection parameter with provided index

参数
param_namename of model selection parameter
返回
index of model selection parameter with provided name, -1 if there is no such

在文件 SGObject.cpp535 行定义.

virtual const char* get_name ( ) const
virtual

Return the name of the object

返回
LossFunction

实现了 CSGObject.

CHuberLoss, CHingeLoss, CSquaredLoss, CAbsoluteDeviationLoss, CExponentialLoss, CSquaredHingeLoss, CLogLoss, CLogLossMargin , 以及 CSmoothHingeLoss 重载.

在文件 LossFunction.h173 行定义.

virtual float64_t get_square_grad ( float64_t  prediction,
float64_t  label 
)
pure virtual

Get square of gradient, used for adaptive learning

参数
predictionprediction
labellabel
返回
square of gradient

CHuberLoss, CHingeLoss, CSquaredLoss, CAbsoluteDeviationLoss, CExponentialLoss, CLogLoss, CLogLossMargin, CSmoothHingeLoss , 以及 CSquaredHingeLoss 内被实现.

virtual float64_t get_update ( float64_t  prediction,
float64_t  label,
float64_t  eta_t,
float64_t  norm 
)
pure virtual

Get importance aware weight update for this loss function

参数
predictionprediction
labellabel
eta_tlearning rate at update number t
normscale value
返回
update

CHuberLoss, CHingeLoss, CSquaredLoss, CAbsoluteDeviationLoss, CExponentialLoss, CLogLoss, CLogLossMargin, CSmoothHingeLoss , 以及 CSquaredHingeLoss 内被实现.

bool is_generic ( EPrimitiveType *  generic) const
virtualinherited

If the SGSerializable is a class template then TRUE will be returned and GENERIC is set to the type of the generic.

参数
genericset to the type of the generic if returning TRUE
返回
TRUE if a class template.

在文件 SGObject.cpp296 行定义.

bool load_serializable ( CSerializableFile file,
const char *  prefix = "" 
)
virtualinherited

Load this object from file. If it will fail (returning FALSE) then this object will contain inconsistent data and should not be used!

参数
filewhere to load from
prefixprefix for members
返回
TRUE if done, otherwise FALSE

在文件 SGObject.cpp369 行定义.

void load_serializable_post ( )
throw (ShogunException
)
protectedvirtualinherited

Can (optionally) be overridden to post-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::LOAD_SERIALIZABLE_POST is called.

异常
ShogunExceptionwill be thrown if an error occurs.

CKernel, CWeightedDegreePositionStringKernel, CList, CAlphabet, CLinearHMM, CGaussianKernel, CInverseMultiQuadricKernel, CCircularKernel , 以及 CExponentialKernel 重载.

在文件 SGObject.cpp426 行定义.

void load_serializable_pre ( )
throw (ShogunException
)
protectedvirtualinherited

Can (optionally) be overridden to pre-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::LOAD_SERIALIZABLE_PRE is called.

异常
ShogunExceptionwill be thrown if an error occurs.

CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool > , 以及 CDynamicObjectArray 重载.

在文件 SGObject.cpp421 行定义.

virtual float64_t loss ( float64_t  prediction,
float64_t  label 
)
virtual

Get loss for an example

参数
predictionprediction
labellabel
返回
loss

CHuberLoss, CAbsoluteDeviationLoss, CExponentialLoss, CHingeLoss , 以及 CSquaredLoss 重载.

在文件 LossFunction.h79 行定义.

virtual float64_t loss ( float64_t  z)
pure virtual

Get loss for an example

参数
zwhere to evaluate the loss
返回
loss

CHuberLoss, CAbsoluteDeviationLoss, CExponentialLoss, CHingeLoss, CSquaredLoss, CLogLoss, CLogLossMargin, CSmoothHingeLoss , 以及 CSquaredHingeLoss 内被实现.

bool parameter_hash_changed ( )
virtualinherited
返回
whether parameter combination has changed since last update

在文件 SGObject.cpp262 行定义.

void print_modsel_params ( )
inherited

prints all parameter registered for model selection and their type

在文件 SGObject.cpp474 行定义.

void print_serializable ( const char *  prefix = "")
virtualinherited

prints registered parameters out

参数
prefixprefix for members

在文件 SGObject.cpp308 行定义.

bool save_serializable ( CSerializableFile file,
const char *  prefix = "" 
)
virtualinherited

Save this object to file.

参数
filewhere to save the object; will be closed during returning if PREFIX is an empty string.
prefixprefix for members
返回
TRUE if done, otherwise FALSE

在文件 SGObject.cpp314 行定义.

void save_serializable_post ( )
throw (ShogunException
)
protectedvirtualinherited

Can (optionally) be overridden to post-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::SAVE_SERIALIZABLE_POST is called.

异常
ShogunExceptionwill be thrown if an error occurs.

CKernel 重载.

在文件 SGObject.cpp436 行定义.

void save_serializable_pre ( )
throw (ShogunException
)
protectedvirtualinherited

Can (optionally) be overridden to pre-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::SAVE_SERIALIZABLE_PRE is called.

异常
ShogunExceptionwill be thrown if an error occurs.

CKernel, CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool > , 以及 CDynamicObjectArray 重载.

在文件 SGObject.cpp431 行定义.

virtual float64_t second_derivative ( float64_t  prediction,
float64_t  label 
)
virtual

Get second derivative of the loss function

参数
predictionprediction
labellabel
返回
second derivative

CHuberLoss, CHingeLoss, CAbsoluteDeviationLoss, CExponentialLoss , 以及 CSquaredLoss 重载.

在文件 LossFunction.h123 行定义.

virtual float64_t second_derivative ( float64_t  z)
pure virtual

Get second derivative of the loss function

参数
zwhere to evaluate the second derivative of the loss
返回
second derivative

CHuberLoss, CHingeLoss, CSquaredLoss, CAbsoluteDeviationLoss, CExponentialLoss, CLogLoss, CLogLossMargin, CSmoothHingeLoss , 以及 CSquaredHingeLoss 内被实现.

void set_generic ( )
inherited

在文件 SGObject.cpp41 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp46 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp51 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp56 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp61 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp66 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp71 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp76 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp81 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp86 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp91 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp96 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp101 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp106 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp111 行定义.

void set_generic ( )
inherited

set generic type to T

void set_global_io ( SGIO io)
inherited

set the io object

参数
ioio object to use

在文件 SGObject.cpp228 行定义.

void set_global_parallel ( Parallel parallel)
inherited

set the parallel object

参数
parallelparallel object to use

在文件 SGObject.cpp241 行定义.

void set_global_version ( Version version)
inherited

set the version object

参数
versionversion object to use

在文件 SGObject.cpp283 行定义.

CSGObject * shallow_copy ( ) const
virtualinherited

A shallow copy. All the SGObject instance variables will be simply assigned and SG_REF-ed.

CGaussianKernel 重载.

在文件 SGObject.cpp192 行定义.

void unset_generic ( )
inherited

unset generic type

this has to be called in classes specializing a template class

在文件 SGObject.cpp303 行定义.

void update_parameter_hash ( )
virtualinherited

Updates the hash of current parameter combination

在文件 SGObject.cpp248 行定义.

类成员变量说明

SGIO* io
inherited

io

在文件 SGObject.h369 行定义.

Parameter* m_gradient_parameters
inherited

parameters wrt which we can compute gradients

在文件 SGObject.h384 行定义.

uint32_t m_hash
inherited

Hash of parameter values

在文件 SGObject.h387 行定义.

Parameter* m_model_selection_parameters
inherited

model selection parameters

在文件 SGObject.h381 行定义.

Parameter* m_parameters
inherited

parameters

在文件 SGObject.h378 行定义.

Parallel* parallel
inherited

parallel

在文件 SGObject.h372 行定义.

Version* version
inherited

version

在文件 SGObject.h375 行定义.


该类的文档由以下文件生成:

SHOGUN 机器学习工具包 - 项目文档