SVMSGD.h

Go to the documentation of this file.

#ifndef _SVMSGD_H___
#define _SVMSGD_H___

/*
   SVM with stochastic gradient
   Copyright (C) 2007- Leon Bottou

   This program is free software; you can redistribute it and/or
   modify it under the terms of the GNU Lesser General Public
   License as published by the Free Software Foundation; either
   version 2.1 of the License, or (at your option) any later version.

   This program 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 this program; if not, write to the Free Software
   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA

   Shogun adjustments (w) 2008 Soeren Sonnenburg
*/

#include <shogun/lib/common.h>
#include <shogun/machine/LinearMachine.h>
#include <shogun/features/DotFeatures.h>
#include <shogun/features/Labels.h>
#include <shogun/loss/LossFunction.h>

namespace shogun
{
class CSVMSGD : public CLinearMachine
{
    public:
        CSVMSGD();

        CSVMSGD(float64_t C);

        CSVMSGD(
            float64_t C, CDotFeatures* traindat,
            CLabels* trainlab);

        virtual ~CSVMSGD();

        virtual inline EClassifierType get_classifier_type() { return CT_SVMSGD; }

        inline void set_C(float64_t c_neg, float64_t c_pos) { C1=c_neg; C2=c_pos; }

        inline float64_t get_C1() { return C1; }

        inline float64_t get_C2() { return C2; }

        inline void set_epochs(int32_t e) { epochs=e; }

        inline int32_t get_epochs() { return epochs; }

        inline void set_bias_enabled(bool enable_bias) { use_bias=enable_bias; }

        inline bool get_bias_enabled() { return use_bias; }

        inline void set_regularized_bias_enabled(bool enable_bias) { use_regularized_bias=enable_bias; }

        inline bool get_regularized_bias_enabled() { return use_regularized_bias; }

        void set_loss_function(CLossFunction* loss_func);

        inline CLossFunction* get_loss_function() { SG_REF(loss); return loss; }

        inline virtual const char* get_name() const { return "SVMSGD"; }

    protected:
        void calibrate();

        virtual bool train_machine(CFeatures* data=NULL);

    private:
        void init();

    private:
        float64_t t;
        float64_t C1;
        float64_t C2;
        float64_t wscale;
        float64_t bscale;
        int32_t epochs;
        int32_t skip;
        int32_t count;

        bool use_bias;
        bool use_regularized_bias;

        CLossFunction* loss;
};
}
#endif