File: ClassLLCriterion.h

package info (click to toggle)
torch 2-1
  • links: PTS
  • area: main
  • in suites: woody
  • size: 5,488 kB
  • ctags: 3,217
  • sloc: cpp: 14,272; makefile: 201
file content (61 lines) | stat: -rw-r--r-- 2,013 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
// Copyright (C) 2002 Ronan Collobert (collober@iro.umontreal.ca)
//                
//
// This file is part of Torch. Release II.
// [The Ultimate Machine Learning Library]
//
// Torch is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 2 of the License, or
// (at your option) any later version.
//
// Torch is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Torch; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

#ifndef CLASS_LL_CRITERION_INC
#define CLASS_LL_CRITERION_INC

#include "Criterion.h"
#include "ClassFormat.h"

namespace Torch {

/** This criterion can be used to train *in classification* a #GradientMachine#
    object using the #GMTrainer# trainer. It then maximizes the log likelihood
    of the data.

    If we write $o_i$ for the output $i$ of the #GradientMachine#, it supposes that
    \begin{itemize}
      \item the outputs $o_i$ are log-probabilities.
      \item $exp(o_i)$ is the probability for the class $i$
      \item the predicted class follows a multinomial distribution with parameters
            $(exp(o_1), exp(o_2), exp(o_3)...)$
    \end{itemize}

    @author Ronan Collobert (collober@iro.umontreal.ca)
*/
class ClassLLCriterion : public Criterion
{
  public:
    ClassFormat *class_format;
    int beta_on;

    /// The ClassFormat is needed just to know how the targets are encoded in the data.
    ClassLLCriterion(ClassFormat *class_format);

    virtual void reset();
    virtual void forward(List *inputs);
    virtual void backward(List *inputs, real *alpha);
    virtual ~ClassLLCriterion();
};


}

#endif