MyCaffe  1.12.2.41
Deep learning software for Windows C# programmers.
MyCaffe.param.SoftmaxParameter Class Reference

Specifies the parameters for the SoftmaxLayer More...

Inheritance diagram for MyCaffe.param.SoftmaxParameter:
MyCaffe.param.EngineParameter MyCaffe.param.LayerParameterBase MyCaffe.basecode.BaseParameter MyCaffe.basecode.IBinaryPersist

Public Member Functions

 SoftmaxParameter ()
 Constructor for the parameter. More...
 
string useCaffeReason ()
 Returns the reason that Caffe version was used instead of NVIDIA's cuDnn. More...
 
bool useCudnn ()
 Queries whether or not to use NVIDIA's cuDnn. Softmax uses cuDNN as the default. More...
 
override object Load (System.IO.BinaryReader br, bool bNewInstance=true)
 Load the parameter from a binary reader. More...
 
override void Copy (LayerParameterBase src)
 Copy on parameter to another. More...
 
override LayerParameterBase Clone ()
 Creates a new copy of this instance of the parameter. More...
 
override RawProto ToProto (string strName)
 Convert the parameter into a RawProto. More...
 
- Public Member Functions inherited from MyCaffe.param.EngineParameter
 EngineParameter ()
 Constructor for the parameter. More...
 
override object Load (System.IO.BinaryReader br, bool bNewInstance=true)
 Load the parameter from a binary reader. More...
 
- Public Member Functions inherited from MyCaffe.param.LayerParameterBase
 LayerParameterBase ()
 Constructor for the parameter. More...
 
virtual string PrepareRunModelInputs ()
 This method gives derivative classes a chance specify model inputs required by the run model. More...
 
virtual void PrepareRunModel (LayerParameter p)
 This method gives derivative classes a chance to prepare the layer for a run-model. More...
 
void Save (BinaryWriter bw)
 Save this parameter to a binary writer. More...
 
abstract object Load (BinaryReader br, bool bNewInstance=true)
 Load the parameter from a binary reader. More...
 
- Public Member Functions inherited from MyCaffe.basecode.BaseParameter
 BaseParameter ()
 Constructor for the parameter. More...
 
virtual bool Compare (BaseParameter p)
 Compare this parameter to another parameter. More...
 

Static Public Member Functions

static new SoftmaxParameter FromProto (RawProto rp)
 Parses the parameter from a RawProto. More...
 
- Static Public Member Functions inherited from MyCaffe.param.EngineParameter
static EngineParameter FromProto (RawProto rp)
 Parses the parameter from a RawProto. More...
 
- Static Public Member Functions inherited from MyCaffe.basecode.BaseParameter
static double ParseDouble (string strVal)
 Parse double values using the US culture if the decimal separator = '.', then using the native culture, and if then lastly trying the US culture to handle prototypes containing '.' as the separator, yet parsed in a culture that does not use '.' as a decimal. More...
 
static bool TryParse (string strVal, out double df)
 Parse double values using the US culture if the decimal separator = '.', then using the native culture, and if then lastly trying the US culture to handle prototypes containing '.' as the separator, yet parsed in a culture that does not use '.' as a decimal. More...
 
static float ParseFloat (string strVal)
 Parse float values using the US culture if the decimal separator = '.', then using the native culture, and if then lastly trying the US culture to handle prototypes containing '.' as the separator, yet parsed in a culture that does not use '.' as a decimal. More...
 
static bool TryParse (string strVal, out float f)
 Parse doufloatble values using the US culture if the decimal separator = '.', then using the native culture, and if then lastly trying the US culture to handle prototypes containing '.' as the separator, yet parsed in a culture that does not use '.' as a decimal. More...
 

Properties

SOFTMAX_ALGORITHMalgorithm_train [getset]
 Optionally, specifies the softmax algorithm to use during the training phase, when null, the 'algorithm' is used instead. More...
 
SOFTMAX_ALGORITHM algorithm [getset]
 Specifies the softmax algorithm to use during the running and testing. More...
 
int axis [getset]
 The axis along which to perform the softmax – may be negative to index from the end (e.g., -1 for the last axis). Any other axes will be evaluated as independent softmaxes. More...
 
- Properties inherited from MyCaffe.param.EngineParameter
Engine engine [getset]
 Specifies the Engine in use. More...
 

Additional Inherited Members

- Public Types inherited from MyCaffe.param.EngineParameter
enum  Engine { DEFAULT = 0 , CAFFE = 1 , CUDNN = 2 }
 Defines the type of engine to use. More...
 
- Public Types inherited from MyCaffe.param.LayerParameterBase
enum  LABEL_TYPE { NONE , SINGLE , MULTIPLE , ONLY_ONE }
 Defines the label type. More...
 

Detailed Description

Specifies the parameters for the SoftmaxLayer

See also
Improving neural networks by preventing co-adaptation of feature detectors by Geoffrey E. Hinton, Nitish Srivastava, Alex Krizhevsky, Ilya Sutskever, and Ruslan R. Salakhutdinov, 2012.
Google's Neural Machine Translation System: Bridging the Gap between Human and Machine Translation by Wu, et al., 2016.
Outrageously Large Neural Networks: The Sparsely-Gated Mixture-of-Experts Layer by Noam Shazeer, Azalia Mirhoseini, Krzysztof Maziarz, Andy Davis, Quoc Le, Geoffrey Hinton, and Jeff Dean, 2017.
Exploring the Limits of Language Modeling by Rafal Jozefowicz, Oriol Vinyals, Mike Schuster, Noam Shazeer, and Yonghui Wu, 2016.

Definition at line 22 of file SoftmaxParameter.cs.

Constructor & Destructor Documentation

◆ SoftmaxParameter()

MyCaffe.param.SoftmaxParameter.SoftmaxParameter ( )

Constructor for the parameter.

Definition at line 29 of file SoftmaxParameter.cs.

Member Function Documentation

◆ Clone()

override LayerParameterBase MyCaffe.param.SoftmaxParameter.Clone ( )
virtual

Creates a new copy of this instance of the parameter.

Returns
A new instance of this parameter is returned.

Reimplemented from MyCaffe.param.EngineParameter.

Definition at line 115 of file SoftmaxParameter.cs.

◆ Copy()

override void MyCaffe.param.SoftmaxParameter.Copy ( LayerParameterBase  src)
virtual

Copy on parameter to another.

Parameters
srcSpecifies the parameter to copy.

Reimplemented from MyCaffe.param.EngineParameter.

Definition at line 101 of file SoftmaxParameter.cs.

◆ FromProto()

static new SoftmaxParameter MyCaffe.param.SoftmaxParameter.FromProto ( RawProto  rp)
static

Parses the parameter from a RawProto.

Parameters
rpSpecifies the RawProto to parse.
Returns
A new instance of the parameter is returned.

Definition at line 142 of file SoftmaxParameter.cs.

◆ Load()

override object MyCaffe.param.SoftmaxParameter.Load ( System.IO.BinaryReader  br,
bool  bNewInstance = true 
)

Load the parameter from a binary reader.

Parameters
brSpecifies the binary reader.
bNewInstanceWhen true a new instance is created (the default), otherwise the existing instance is loaded from the binary reader.
Returns
Returns an instance of the parameter.

Definition at line 89 of file SoftmaxParameter.cs.

◆ ToProto()

override RawProto MyCaffe.param.SoftmaxParameter.ToProto ( string  strName)
virtual

Convert the parameter into a RawProto.

Parameters
strNameSpecifies the name to associate with the RawProto.
Returns
The new RawProto is returned.

Reimplemented from MyCaffe.param.EngineParameter.

Definition at line 123 of file SoftmaxParameter.cs.

◆ useCaffeReason()

string MyCaffe.param.SoftmaxParameter.useCaffeReason ( )

Returns the reason that Caffe version was used instead of NVIDIA's cuDnn.

Returns

Definition at line 38 of file SoftmaxParameter.cs.

◆ useCudnn()

bool MyCaffe.param.SoftmaxParameter.useCudnn ( )

Queries whether or not to use NVIDIA's cuDnn. Softmax uses cuDNN as the default.

Returns
Returns true when cuDnn is to be used, false otherwise.

Definition at line 50 of file SoftmaxParameter.cs.

Property Documentation

◆ algorithm

SOFTMAX_ALGORITHM MyCaffe.param.SoftmaxParameter.algorithm
getset

Specifies the softmax algorithm to use during the running and testing.

Definition at line 70 of file SoftmaxParameter.cs.

◆ algorithm_train

SOFTMAX_ALGORITHM? MyCaffe.param.SoftmaxParameter.algorithm_train
getset

Optionally, specifies the softmax algorithm to use during the training phase, when null, the 'algorithm' is used instead.

Definition at line 61 of file SoftmaxParameter.cs.

◆ axis

int MyCaffe.param.SoftmaxParameter.axis
getset

The axis along which to perform the softmax – may be negative to index from the end (e.g., -1 for the last axis). Any other axes will be evaluated as independent softmaxes.

Definition at line 82 of file SoftmaxParameter.cs.


The documentation for this class was generated from the following file: