LearningRateSchedulerBase.h

#pragma once
 
#if _MSC_VER >= 1900 && defined(_M_X64)
 
namespace FLImaging
{
    namespace AI
    {
        template <typename T>
        class FL_EXPORT CLearningRateSchedulerBase : public Base::CFLBase
        {
        public:
            CLearningRateSchedulerBase();
            CLearningRateSchedulerBase(const CLearningRateSchedulerBase<T>& lrs);
            CLearningRateSchedulerBase(const CLearningRateSchedulerBase<T>* pLrs);
 
            virtual ~CLearningRateSchedulerBase();
 
            virtual const CResult Assign(const CLearningRateSchedulerBase<T>& lrs);
            virtual const CResult Assign(const CLearningRateSchedulerBase<T>* pLrs);
 
            virtual const CResult Clear();
            virtual const CResult Initialize();
 
            virtual const CResult SetBurnInBatchIteration(int64_t i64BurnInBatchIteration);
            virtual int64_t GetBurnInBatchIteration() const;
            virtual const CResult AddBatchIteration(int64_t i64BatchCount);
            virtual bool IsBurnIn() const;
 
            virtual const CResult SetLearningRate(T tLearningRate = 1e-3);
            virtual T GetLearningRate() const;
            virtual T GetCurrentLearningRate() const;
 
            virtual const CResult SetWarmupStep(int64_t i64WarmupStep = 0);
            virtual int64_t GetWarmupStep() const;
 
            virtual const CResult Step(T tLoss = 0) = 0;
 
 
            DeclareGetClassType();
            SupportToDuplicateAbstractObject(CLearningRateSchedulerBase<T>);
 
        protected:
            virtual void Throw(const CResult& res, const wchar_t* pWcsExtraMessage = nullptr) const override;
 
        protected:
            int64_t m_i64CurrentBatchIteration;
            int64_t m_i64BurnInBatchIteration;
            int64_t m_i64CurrentSteps;
            int64_t m_i64WarmupStep;
 
            T m_tCurrentLearingRate;
            T m_tOriginLearningRate;
            bool m_bInitialized;
        };
 
 
        typedef CLearningRateSchedulerBase<float> CLearningRateSchedulerBaseF;
        typedef CLearningRateSchedulerBase<double> CLearningRateSchedulerBaseD;
 
        typedef CLearningRateSchedulerBase<float> CLRSBaseF;
        typedef CLearningRateSchedulerBase<double> CLRSBaseD;
 
        template <typename T>
        using CLRSBase = CLearningRateSchedulerBase<T>;
 
    }
}
 
#endif