SoftmaxParameter.cs

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.ComponentModel;
using MyCaffe.basecode;
using MyCaffe.common;
 
namespace MyCaffe.param
{
    [Serializable]
    [TypeConverter(typeof(ExpandableObjectConverter))]
    public class SoftmaxParameter : EngineParameter 
    {
        int m_nAxis = 1;
        SOFTMAX_ALGORITHM? m_TrainAlgorithm = null;
        SOFTMAX_ALGORITHM m_RunAlgorithm = SOFTMAX_ALGORITHM.DEFAULT;
 
        public SoftmaxParameter()
            : base()
        {
        }
 
        public string useCaffeReason()
        {
            if (engine == Engine.CAFFE)
                return "The engine setting is set on CAFFE.";
 
            return "";
        }
 
        public bool useCudnn()
        {
            if (engine == EngineParameter.Engine.CAFFE)
                return false;
 
            return true;
        }
 
        public SOFTMAX_ALGORITHM? algorithm_train
        {
            get { return m_TrainAlgorithm; }
            set { m_TrainAlgorithm = value; }
        }
 
        public SOFTMAX_ALGORITHM algorithm
        {
            get { return m_RunAlgorithm; }
            set { m_RunAlgorithm = value; }
        }
 
        [Description("Specifies the axis along which to perform the softmax - may be negative to index from the end (e.g., -1 for the last axis).")]
        public int axis
        {
            get { return m_nAxis; }
            set { m_nAxis = value; }
        }
 
        public override object Load(System.IO.BinaryReader br, bool bNewInstance = true)
        {
            RawProto proto = RawProto.Parse(br.ReadString());
            SoftmaxParameter p = FromProto(proto);
 
            if (!bNewInstance)
                Copy(p);
 
            return p;
        }
 
        public override void Copy(LayerParameterBase src)
        {
            base.Copy(src);
 
            if (src is SoftmaxParameter)
            {
                SoftmaxParameter p = (SoftmaxParameter)src;
                m_nAxis = p.m_nAxis;
                m_TrainAlgorithm = p.m_TrainAlgorithm;
                m_RunAlgorithm = p.m_RunAlgorithm;
            }
        }
 
        public override LayerParameterBase Clone()
        {
            SoftmaxParameter p = new SoftmaxParameter();
            p.Copy(this);
            return p;
        }
 
        public override RawProto ToProto(string strName)
        {
            RawProto rpBase = base.ToProto("engine");
            RawProtoCollection rgChildren = new RawProtoCollection();
 
            rgChildren.Add(rpBase.Children);
            rgChildren.Add("axis", axis.ToString());
            rgChildren.Add("algorithm", algorithm.ToString());
            if (algorithm_train.HasValue)
                rgChildren.Add("algorithm_train", algorithm_train.Value.ToString());
 
            return new RawProto(strName, "", rgChildren);
        }
 
        public static new SoftmaxParameter FromProto(RawProto rp)
        {
            string strVal;
            SoftmaxParameter p = new SoftmaxParameter();
 
            p.Copy(EngineParameter.FromProto(rp));
 
            if ((strVal = rp.FindValue("axis")) != null)
                p.axis = int.Parse(strVal);
 
            if ((strVal = rp.FindValue("algorithm")) != null)
            {
                if (strVal == SOFTMAX_ALGORITHM.LOG.ToString())
                    p.algorithm = SOFTMAX_ALGORITHM.LOG;
                else if (strVal == SOFTMAX_ALGORITHM.ACCURATE.ToString())
                    p.algorithm = SOFTMAX_ALGORITHM.ACCURATE;
                else if (strVal == SOFTMAX_ALGORITHM.FAST.ToString())
                    p.algorithm = SOFTMAX_ALGORITHM.FAST;
                else
                    p.algorithm = SOFTMAX_ALGORITHM.DEFAULT;
            }
 
            if ((strVal = rp.FindValue("algorithm_train")) != null)
            {
                if (strVal == SOFTMAX_ALGORITHM.LOG.ToString())
                    p.algorithm_train = SOFTMAX_ALGORITHM.LOG;
                else if (strVal == SOFTMAX_ALGORITHM.ACCURATE.ToString())
                    p.algorithm_train = SOFTMAX_ALGORITHM.ACCURATE;
                else if (strVal == SOFTMAX_ALGORITHM.FAST.ToString())
                    p.algorithm_train = SOFTMAX_ALGORITHM.FAST;
                else
                    p.algorithm_train = SOFTMAX_ALGORITHM.DEFAULT;
            }
            else
            {
                p.algorithm_train = null;
            }
 
            return p;
        }
    }
}