LearningRateSchedulerReduceOnPlateau.h

#pragma once
 
#if _MSC_VER >= 1900 && defined(_M_X64)
 
#include "LearningRateSchedulerBase.h"
 
namespace FLImaging
{
    namespace AI
    {
        template <typename T>
        class FL_EXPORT CLearningRateSchedulerReduceOnPlateau : public CLearningRateSchedulerBase<T>
        {
        public:
            enum ESchedulerMode
            {
                ESchedulerMode_Min= 0,
                ESchedulerMode_Max,
            };
 
            enum EDynamicThresholdMode
            {
                EDynamicThresholdMode_None = 0,
                EDynamicThresholdMode_Relative,
                EDynamicThresholdMode_Absolute,
            };
 
            CLearningRateSchedulerReduceOnPlateau();
            CLearningRateSchedulerReduceOnPlateau(const CLearningRateSchedulerReduceOnPlateau<T>& lrs);
            CLearningRateSchedulerReduceOnPlateau(const CLearningRateSchedulerReduceOnPlateau<T>* pLrs);
 
            virtual ~CLearningRateSchedulerReduceOnPlateau();
 
            virtual const CResult Assign(const CLearningRateSchedulerReduceOnPlateau<T>& lrs);
            virtual const CResult Assign(const CLearningRateSchedulerReduceOnPlateau<T>* pLrs);
 
            virtual const CResult Clear();
            virtual const CResult Initialize() override;
 
 
            virtual const CResult SetMinLearningRate(T tMinLearningRate = 0);
            virtual T GetMinLearningRate() const;
 
            virtual const CResult SetGamma(T tGamma = (T)0.1);
            virtual T GetGamma() const;
 
            virtual const CResult SetPatience(int64_t i64Patience = 0);
            virtual int64_t GetPatience() const;
 
            virtual const CResult SetCoolDown(int64_t i64CoolDown = 0);
            virtual int64_t GetCoolDown() const;
 
            virtual const CResult SetSchedulerMode(ESchedulerMode eSchedulerMode = ESchedulerMode_Min);
            virtual ESchedulerMode GetSchedulerMode() const;
 
            virtual const CResult SetThreshold(T tThreshold = 0);
            virtual T GetThreshold() const;
 
            virtual const CResult SetThresholdMode(EDynamicThresholdMode eDynamicThresholdMode = EDynamicThresholdMode_Absolute);
            virtual EDynamicThresholdMode GetThresholdMode() const;
 
            virtual const CResult SetEpsilon(T tEpsilon = FL_EPSILON_FLOAT);
            virtual T GetEpsilon() const;
 
            virtual const CResult Step(T tLoss = 0) override;
 
 
            DeclareGetClassType();
            SupportToDuplicateObject(CLearningRateSchedulerReduceOnPlateau<T>, *this);
 
        protected:
            T m_tMinLearningRate;
            T m_tGamma;
            int64_t m_i64Patience;
            int64_t m_i64CoolDown;
            ESchedulerMode m_eSchedulerMode;
            T m_tThreshold;
            EDynamicThresholdMode m_eDynamicThresholdMode;
            T m_tEpsilon;
 
            T m_tPrevLoss;
            T m_tBestLoss;
            int64_t m_i64CurrentPatienceCount;
            int64_t m_i64CurrentCoolDownCount;
        };
 
 
        typedef CLearningRateSchedulerReduceOnPlateau<float> CLearningRateSchedulerReduceOnPlateauF;
        typedef CLearningRateSchedulerReduceOnPlateau<double> CLearningRateSchedulerReduceOnPlateauD;
 
        typedef CLearningRateSchedulerReduceOnPlateau<float> CLRSReduceOnPlateauF;
        typedef CLearningRateSchedulerReduceOnPlateau<double> CLRSReduceOnPlateauD;
 
        template <typename T>
        using CLRSReduceOnPlateau = CLearningRateSchedulerReduceOnPlateau<T>;
 
    }
}
 
#endif