PoolingParameter.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 PoolingParameter : KernelParameter
    {
        PoolingMethod m_pool = PoolingMethod.MAX;
        bool m_bGlobalPooling = false;
        PoolingReshapeAlgorithm m_reshapeAlgorithm = PoolingReshapeAlgorithm.DEFAULT;
 
        public enum PoolingReshapeAlgorithm
        {
            DEFAULT,
            CAFFE, // default
            ONNX,
        }
 
        public enum PoolingMethod
        {
            MAX = 0,
            AVE = 1,
            STOCHASTIC = 2
        }
 
        public PoolingParameter()
        {
        }
 
        public string useCaffeReason()
        {
            if (engine == Engine.CAFFE)
                return "The engine setting is set on CAFFE.";
 
            if (pool == PoolingMethod.STOCHASTIC)
                return "The STOCHASTIC pooing method is currently not supported with cuDnn.";
 
            return "";
        }
 
        public bool useCudnn()
        {
            if (engine == EngineParameter.Engine.CAFFE)
                return false;
 
            if (pool == PoolingParameter.PoolingMethod.STOCHASTIC)
                return false;
 
            return true;
        }
 
        [Description("Specifies pooling method to use.")] 
        public PoolingMethod pool
        {
            get { return m_pool; }
            set { m_pool = value; }
        }
 
        [Description("Specifies whether or not to enable global pooling.")]
        public bool global_pooling
        {
            get { return m_bGlobalPooling; }
            set { m_bGlobalPooling = value; }
        }
 
        public PoolingReshapeAlgorithm reshape_algorithm
        {
            get { return m_reshapeAlgorithm; }
            set { m_reshapeAlgorithm = value; }
        }
 
        public override object Load(System.IO.BinaryReader br, bool bNewInstance = true)
        {
            RawProto proto = RawProto.Parse(br.ReadString());
            PoolingParameter p = FromProto(proto);
 
            if (!bNewInstance)
                Copy(p);
 
            return p;
        }
 
        public override void Copy(LayerParameterBase src)
        {
            base.Copy(src);
 
            if (src is PoolingParameter)
            {
                PoolingParameter p = (PoolingParameter)src;
                m_pool = p.m_pool;
                m_bGlobalPooling = p.m_bGlobalPooling;
                m_reshapeAlgorithm = p.m_reshapeAlgorithm;
            }
        }
 
        public override LayerParameterBase Clone()
        {
            PoolingParameter p = new PoolingParameter();
            p.Copy(this);
            return p;
        }
 
        public override RawProto ToProto(string strName)
        {
            dilation.Clear();
            RawProto rpBase = base.ToProto("kernel");
            RawProtoCollection rgChildren = new RawProtoCollection();
 
            rgChildren.Add(rpBase.Children);
            rgChildren.Add("pool", pool.ToString());
 
            if (global_pooling != false)
                rgChildren.Add("global_pooling", global_pooling.ToString());
 
            if (reshape_algorithm != PoolingReshapeAlgorithm.DEFAULT)
                rgChildren.Add("reshape_algorithm", reshape_algorithm.ToString());
 
            return new RawProto(strName, "", rgChildren);
        }
 
        public static new PoolingParameter FromProto(RawProto rp)
        {
            string strVal;
            PoolingParameter p = new PoolingParameter();
 
            ((KernelParameter)p).Copy(KernelParameter.FromProto(rp));
 
            if ((strVal = rp.FindValue("pool")) != null)
            {
                switch (strVal)
                {
                    case "MAX":
                        p.pool = PoolingMethod.MAX;
                        break;
 
                    case "AVE":
                        p.pool = PoolingMethod.AVE;
                        break;
 
                    case "STOCHASTIC":
                        p.pool = PoolingMethod.STOCHASTIC;
                        break;
 
                    default:
                        throw new Exception("Unknown pooling 'method' value: " + strVal);
                }
            }
 
            if ((strVal = rp.FindValue("global_pooling")) != null)
                p.global_pooling = bool.Parse(strVal);
 
            if ((strVal = rp.FindValue("reshape_algorithm")) != null)
            {
                switch (strVal)
                {
                    case "CAFFE":
                        p.reshape_algorithm = PoolingReshapeAlgorithm.CAFFE;
                        break;
 
                    case "ONNX":
                        p.reshape_algorithm = PoolingReshapeAlgorithm.ONNX;
                        break;
 
                    default:
                        p.reshape_algorithm = PoolingReshapeAlgorithm.DEFAULT;
                        break;
                }
            }
 
            return p;
        }
    }
}