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

Specifies a NetStateRule used to determine whether a Net falls within a given include or exclude pattern. More...

Inheritance diagram for MyCaffe.param.NetStateRule:
MyCaffe.basecode.BaseParameter MyCaffe.basecode.IBinaryPersist

Public Member Functions

 NetStateRule ()
 Specifies the NetStateRule constructor. More...
 
 NetStateRule (Phase p)
 Specifies the NetStateRule constructor. More...
 
void Save (BinaryWriter bw)
 Saves the NetStateRule to a given binary writer. More...
 
object Load (BinaryReader br, bool bNewInstance)
 Loads a NetStateRule from a binary reader. More...
 
object Clone ()
 Creates a new copy of a NetStateRule instance. More...
 
override RawProto ToProto (string strName)
 Converts a NetStateRule into a RawProto. More...
 
int CompareTo (object obj)
 Compares this NetStateRule to another one. 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 NetStateRule FromProto (RawProto rp)
 Parses a RawProto representing a NetStateRule and creates a new instance of a NetStateRule from it. 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

Phase phase [getset]
 Set phase to require the NetState to have a particular phase (TRAIN or TEST) to meet this rule. More...
 
int? min_level [getset]
 Set the minimum levels in which the layer should be used. Leave undefined to meet the rule regardless of level. More...
 
int? max_level [getset]
 Set the maximum levels in which the layer should be used. Leave undefined to meet the rule regardless of level. More...
 
List< string > stage [getset]
 Customizable sets of stages to include. The net must have ALL of the specified stages and NONE of the specified 'not_stage's to meet the rule. (Use mutiple NetStateRules to specify conjunctions of stages.) More...
 
List< string > not_stage [getset]
 Customizable sets of stages to exclude. The net must have ALL of the specified stages and NONE of the specified 'not_stage's to meet the rule. (Use mutiple NetStateRules to specify conjunctions of stages.) More...
 

Detailed Description

Specifies a NetStateRule used to determine whether a Net falls within a given include or exclude pattern.

Definition at line 19 of file NetStateRule.cs.

Constructor & Destructor Documentation

◆ NetStateRule() [1/2]

MyCaffe.param.NetStateRule.NetStateRule ( )

Specifies the NetStateRule constructor.

Definition at line 30 of file NetStateRule.cs.

◆ NetStateRule() [2/2]

MyCaffe.param.NetStateRule.NetStateRule ( Phase  p)

Specifies the NetStateRule constructor.

Parameters
pSpecifies the phase to assign to the NetStateRule

Definition at line 38 of file NetStateRule.cs.

Member Function Documentation

◆ Clone()

object MyCaffe.param.NetStateRule.Clone ( )

Creates a new copy of a NetStateRule instance.

Returns
The new instance is returned.

Definition at line 162 of file NetStateRule.cs.

◆ CompareTo()

int MyCaffe.param.NetStateRule.CompareTo ( object  obj)

Compares this NetStateRule to another one.

Parameters
objSpecifies the other NetStateRule to compare.
Returns
0 is returned if the NetStateRule instances match, otherwise 1 is returned.

Definition at line 253 of file NetStateRule.cs.

◆ FromProto()

static NetStateRule MyCaffe.param.NetStateRule.FromProto ( RawProto  rp)
static

Parses a RawProto representing a NetStateRule and creates a new instance of a NetStateRule from it.

Parameters
rpSpecifies the RawProto used.
Returns
The new NeteStateRule instance is returned.

Definition at line 206 of file NetStateRule.cs.

◆ Load()

object MyCaffe.param.NetStateRule.Load ( BinaryReader  br,
bool  bNewInstance 
)

Loads a NetStateRule from a binary reader.

Parameters
brSpecifies the binary reader to use.
bNewInstanceWhen true, a new NetStateRule instance is created and loaded, otherwise this instance is loaded.
Returns
The instance of the NetStateRule is returned.

Implements MyCaffe.basecode.IBinaryPersist.

Definition at line 69 of file NetStateRule.cs.

◆ Save()

void MyCaffe.param.NetStateRule.Save ( BinaryWriter  bw)

Saves the NetStateRule to a given binary writer.

Parameters
bwSpecifies the binary writer to use.

Implements MyCaffe.basecode.IBinaryPersist.

Definition at line 47 of file NetStateRule.cs.

◆ ToProto()

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

Converts a NetStateRule into a RawProto.

Parameters
strNameSpecifies a name given to the RawProto.
Returns
The new RawProto representing the NetStateRule is returned.

Implements MyCaffe.basecode.BaseParameter.

Definition at line 180 of file NetStateRule.cs.

Property Documentation

◆ max_level

int? MyCaffe.param.NetStateRule.max_level
getset

Set the maximum levels in which the layer should be used. Leave undefined to meet the rule regardless of level.

Definition at line 120 of file NetStateRule.cs.

◆ min_level

int? MyCaffe.param.NetStateRule.min_level
getset

Set the minimum levels in which the layer should be used. Leave undefined to meet the rule regardless of level.

Definition at line 109 of file NetStateRule.cs.

◆ not_stage

List<string> MyCaffe.param.NetStateRule.not_stage
getset

Customizable sets of stages to exclude. The net must have ALL of the specified stages and NONE of the specified 'not_stage's to meet the rule. (Use mutiple NetStateRules to specify conjunctions of stages.)

Definition at line 152 of file NetStateRule.cs.

◆ phase

Phase MyCaffe.param.NetStateRule.phase
getset

Set phase to require the NetState to have a particular phase (TRAIN or TEST) to meet this rule.

Note when the phase is set to NONE, the rule applies to all phases.

Definition at line 98 of file NetStateRule.cs.

◆ stage

List<string> MyCaffe.param.NetStateRule.stage
getset

Customizable sets of stages to include. The net must have ALL of the specified stages and NONE of the specified 'not_stage's to meet the rule. (Use mutiple NetStateRules to specify conjunctions of stages.)

Definition at line 136 of file NetStateRule.cs.


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