DropoutParameter.cs

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.ComponentModel;
using MyCaffe.basecode;
 
namespace MyCaffe.param
{
    [Serializable]
    [TypeConverter(typeof(ExpandableObjectConverter))]
    public class DropoutParameter : EngineParameter
    {
        double m_dfDropoutRatio = 0.5;
        long m_lSeed = 0;
        bool m_bActive = true;
 
        public DropoutParameter()
            : base()
        {
        }
 
        public string useCaffeReason()
        {
            if (engine == Engine.CAFFE)
                return "The engine setting is set on CAFFE.";
 
            if (engine == Engine.DEFAULT)
                return "The engine setting is set to DEFAULT and, unlike other layers, the DropoutLayer defaults to use CAFFE.";
 
            return "";
        }
 
        public bool useCudnn()
        {
            if (engine == EngineParameter.Engine.CUDNN)
                return true;
 
            return false;   // DEFAULT = CAFFE
        }
 
        [Description("Specifies the dropout ratio. (e.g. the probability that values will be dropped out and set to zero.  A value of 0.25 = 25% chance that a value is set to 0, and dropped out.)")]
        public double dropout_ratio
        {
            get { return m_dfDropoutRatio; }
            set { m_dfDropoutRatio = value; }
        }
 
        [Description("Specifies the random number generator seed used with the cuDnn dropout - the default value of '0' uses a random seed.")]
        public long seed
        {
            get { return m_lSeed; }
            set { m_lSeed = value; }
        }
 
        [Description("Specifies whether or not the dropout is active or not.  When inactive and training, the dropout acts the same as it does during testing and is ignored.")]
        public bool active
        {
            get { return m_bActive; }
            set { m_bActive = value; }
        }
 
        public override object Load(System.IO.BinaryReader br, bool bNewInstance = true)
        {
            RawProto proto = RawProto.Parse(br.ReadString());
            DropoutParameter p = FromProto(proto);
 
            if (!bNewInstance)
                Copy(p);
 
            return p;
        }
 
        public override void Copy(LayerParameterBase src)
        {
            base.Copy(src);
 
            if (src is DropoutParameter)
            {
                DropoutParameter p = (DropoutParameter)src;
                m_dfDropoutRatio = p.m_dfDropoutRatio;
                m_lSeed = p.m_lSeed;
                m_bActive = p.m_bActive;
            }
        }
 
        public override LayerParameterBase Clone()
        {
            DropoutParameter p = new DropoutParameter();
            p.Copy(this);
            return p;
        }
 
        public override RawProto ToProto(string strName)
        {
            RawProto rpBase = base.ToProto("engine");
            RawProtoCollection rgChildren = new RawProtoCollection();
 
            rgChildren.Add(rpBase.Children);
 
            if (dropout_ratio != 0.5)
                rgChildren.Add("dropout_ratio", dropout_ratio.ToString());
 
            if (seed != 0)
                rgChildren.Add("seed", seed.ToString());
 
            if (!active)
                rgChildren.Add("active", active.ToString());
           
            return new RawProto(strName, "", rgChildren);
        }
 
        public static new DropoutParameter FromProto(RawProto rp)
        {
            string strVal;
            DropoutParameter p = new DropoutParameter();
 
            ((EngineParameter)p).Copy(EngineParameter.FromProto(rp));
 
            if ((strVal = rp.FindValue("dropout_ratio")) != null)
                p.dropout_ratio = ParseDouble(strVal);
 
            if ((strVal = rp.FindValue("seed")) != null)
                p.seed = long.Parse(strVal);
 
            if ((strVal = rp.FindValue("active")) != null)
                p.active = bool.Parse(strVal);
 
            return p;
        }
    }
}