ParamSpec.cs

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.IO;
using System.ComponentModel;
using MyCaffe.basecode;
using MyCaffe.common;
 
namespace MyCaffe.param
{
    [Serializable]
    [TypeConverter(typeof(ExpandableObjectConverter))]
    public class ParamSpec : BaseParameter, ICloneable, IBinaryPersist 
    {
        string m_strName = "";
 
        DimCheckMode m_shareMode = DimCheckMode.STRICT;
 
        public enum DimCheckMode
        {
            STRICT = 0,
 
            PERMISSIVE = 1
        }
 
        double m_dfLrMult = 1.0;
 
        double m_dfDecayMult = 1.0;
 
        public ParamSpec()
        {
        }
 
        public ParamSpec(string strName)
        {
            m_strName = strName;
        }
 
        public ParamSpec(double dfLrMult, double dfDecayMult, string strName = null)
        {
            m_dfLrMult = dfLrMult;
            m_dfDecayMult = dfDecayMult;
 
            if (strName != null)
                m_strName = strName;
        }
 
        public void Save(BinaryWriter bw)
        {
            bw.Write(m_strName);
            bw.Write((int)m_shareMode);
            bw.Write(m_dfLrMult);
            bw.Write(m_dfDecayMult);
        }
 
        public object Load(BinaryReader br, bool bNewInstance)
        {
            ParamSpec p = this;
 
            if (bNewInstance)
                p = new ParamSpec();
 
            p.m_strName = br.ReadString();
            p.m_shareMode = (DimCheckMode)br.ReadInt32();
            p.m_dfLrMult = br.ReadDouble();
            p.m_dfDecayMult = br.ReadDouble();
 
            return p;
        }
 
#pragma warning disable 1591
 
        [Browsable(false)]
        public string Name 
        {
            get { return m_strName; }
        }
 
#pragma warning restore 1591
 
        [Description("Specifies the name of this parameter.")]
        public string name
        {
            get { return m_strName; }
            set { m_strName = value; }
        }
 
        [Description("Specifies whether to require shared weights to have the same shape, or just the same count - defaults to STICT (same shape).")]
        public DimCheckMode share_mode
        {
            get { return m_shareMode; }
            set { m_shareMode = value; }
        }
 
        [Description("Specifies the multiplier used on the global learning rate for this parameter.")]
        public double lr_mult
        {
            get { return m_dfLrMult; }
            set { m_dfLrMult = value; }
        }
 
        [Description("Specifies the multiplier used on the global weight decay for this parameter.")]
        public double decay_mult
        {
            get { return m_dfDecayMult; }
            set { m_dfDecayMult = value; }
        }
 
        public object Clone()
        {
            ParamSpec p = new ParamSpec();
 
            p.m_strName = m_strName;
            p.m_shareMode = m_shareMode;
            p.m_dfDecayMult = m_dfDecayMult;
            p.m_dfLrMult = m_dfLrMult;
 
            return p;
        }
 
        public override RawProto ToProto(string strName)
        {
            RawProtoCollection rgChildren = new RawProtoCollection();
 
            if (name.Length > 0)
                rgChildren.Add("name", "\"" + name + "\"");
 
            if (share_mode != DimCheckMode.STRICT)
                rgChildren.Add("share_mode", share_mode.ToString());
 
            rgChildren.Add("lr_mult", lr_mult.ToString());
 
            if (decay_mult != 1)
                rgChildren.Add("decay_mult", decay_mult.ToString());
 
            return new RawProto(strName, "", rgChildren);
        }
 
        public static ParamSpec FromProto(RawProto rp)
        {
            string strVal;
            ParamSpec p = new ParamSpec();
 
            if ((strVal = rp.FindValue("name")) != null)
                p.name = strVal;
 
            if ((strVal = rp.FindValue("share_mode")) != null)
            {
                switch (strVal)
                {
                    case "STRICT":
                        p.share_mode = DimCheckMode.STRICT;
                        break;
 
                    case "PERMISSIVE":
                        p.share_mode = DimCheckMode.PERMISSIVE;
                        break;
 
                    default:
                        throw new Exception("Unknown 'share_mode' value: " + strVal);
                }
            }
 
            if ((strVal = rp.FindValue("lr_mult")) != null)
                p.lr_mult = ParseDouble(strVal);
 
            if ((strVal = rp.FindValue("decay_mult")) != null)
                p.decay_mult = ParseDouble(strVal);
 
            return p;
        }
    }
}