Specifies the parameter for the model data layer. More...

Inheritance diagram for MyCaffe.param.ModelDataParameter:

Public Member Functions
	ModelDataParameter ()
	Constructor for the parameter. More...

override string	PrepareRunModelInputs ()
	This method gives derivative classes a chance specify model inputs required by the run model. More...

override void	PrepareRunModel (LayerParameter p)
	This method gives derivative classes a chance modify the layer parameter for a run model. 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.LayerParameterBase
	LayerParameterBase ()
	Constructor for the parameter. 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 ModelDataParameter	FromProto (RawProto rp, ModelDataParameter p=null)
	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
List< string >	source `[getset]`
	Specifies the data 'sources' within the database. Each source must already have pre-calculated RawImageResult data within the RawImageResults table including both Results for encoder input and ExtraData for decoder input. More...

virtual uint	batch_size `[getset]`
	Specifies the batch size. More...

uint	time_steps `[getset]`
	Specifies the maximum length for each encoder input. More...

uint	input_dim `[getset]`
	Specifies the input dimension for each encoder input. More...

uint	sample_size `[getset]`
	Specifies the sample size to select from the data sources. More...

bool	shuffle `[getset]`
	Specifies the whether to shuffle the data or now. More...

Events
EventHandler< VerifyBatchSizeArgs >	OnVerifyBatchSize
	This event is, optionally, called to verify the batch size of the TextDataParameter. More...

Additional Inherited Members
Public Types inherited from MyCaffe.param.LayerParameterBase
enum	LABEL_TYPE { NONE , SINGLE , MULTIPLE , ONLY_ONE }
	Defines the label type. More...

Detailed Description

Specifies the parameter for the model data layer.

Definition at line 15 of file ModelDataParameter.cs.

Constructor & Destructor Documentation

◆ ModelDataParameter()

MyCaffe.param.ModelDataParameter.ModelDataParameter ( )

Constructor for the parameter.

Definition at line 30 of file ModelDataParameter.cs.

Member Function Documentation

◆ Clone()

override LayerParameterBase MyCaffe.param.ModelDataParameter.Clone ( )

virtual

Creates a new copy of this instance of the parameter.

Returns: A new instance of this parameter is returned.

Implements MyCaffe.param.LayerParameterBase.

Definition at line 163 of file ModelDataParameter.cs.

◆ Copy()

override void MyCaffe.param.ModelDataParameter.Copy ( LayerParameterBase src )

virtual

Copy on parameter to another.

Parameters

src	Specifies the parameter to copy.

Implements MyCaffe.param.LayerParameterBase.

Definition at line 151 of file ModelDataParameter.cs.

◆ FromProto()

static ModelDataParameter MyCaffe.param.ModelDataParameter.FromProto	(	RawProto	rp,
		ModelDataParameter	p = `null`
	)

static

Parses the parameter from a RawProto.

Parameters

rp	Specifies the RawProto to parse.
p	Optionally, specifies an instance to load. If null, a new instance is created and loaded.

Returns: A new instance of the parameter is returned.

Definition at line 195 of file ModelDataParameter.cs.

◆ Load()

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

Load the parameter from a binary reader.

Parameters

br	Specifies the binary reader.
bNewInstance	When 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 139 of file ModelDataParameter.cs.

◆ PrepareRunModel()

override void MyCaffe.param.ModelDataParameter.PrepareRunModel ( LayerParameter p )

virtual

This method gives derivative classes a chance modify the layer parameter for a run model.

Reimplemented from MyCaffe.param.LayerParameterBase.

Definition at line 60 of file ModelDataParameter.cs.

◆ PrepareRunModelInputs()

override string MyCaffe.param.ModelDataParameter.PrepareRunModelInputs ( )

virtual

This method gives derivative classes a chance specify model inputs required by the run model.

Returns: The model inputs required by the layer (if any) or null.

Reimplemented from MyCaffe.param.LayerParameterBase.

Definition at line 39 of file ModelDataParameter.cs.

◆ ToProto()

override RawProto MyCaffe.param.ModelDataParameter.ToProto ( string strName )

virtual

Convert the parameter into a RawProto.

Parameters

strName Specifies the name to associate with the RawProto.

Returns: The new RawProto is returned.

Implements MyCaffe.basecode.BaseParameter.

Definition at line 175 of file ModelDataParameter.cs.

Property Documentation

◆ batch_size

virtual uint MyCaffe.param.ModelDataParameter.batch_size

getset

Specifies the batch size.

Definition at line 81 of file ModelDataParameter.cs.

◆ input_dim

uint MyCaffe.param.ModelDataParameter.input_dim

getset

Specifies the input dimension for each encoder input.

Definition at line 112 of file ModelDataParameter.cs.

◆ sample_size

uint MyCaffe.param.ModelDataParameter.sample_size

getset

Specifies the sample size to select from the data sources.

Definition at line 122 of file ModelDataParameter.cs.

◆ shuffle

bool MyCaffe.param.ModelDataParameter.shuffle

getset

Specifies the whether to shuffle the data or now.

Definition at line 132 of file ModelDataParameter.cs.

◆ source

List<string> MyCaffe.param.ModelDataParameter.source

getset

Specifies the data 'sources' within the database. Each source must already have pre-calculated RawImageResult data within the RawImageResults table including both Results for encoder input and ExtraData for decoder input.

Definition at line 71 of file ModelDataParameter.cs.

◆ time_steps

uint MyCaffe.param.ModelDataParameter.time_steps

getset

Specifies the maximum length for each encoder input.

Definition at line 102 of file ModelDataParameter.cs.

Event Documentation

◆ OnVerifyBatchSize

EventHandler<VerifyBatchSizeArgs> MyCaffe.param.ModelDataParameter.OnVerifyBatchSize

This event is, optionally, called to verify the batch size of the TextDataParameter.

Definition at line 27 of file ModelDataParameter.cs.

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

C:/Data/Data/SS_Projects/Intelligence/GitHub/MyCaffe/MyCaffe/param.beta/ModelDataParameter.cs

Public Member Functions

Static Public Member Functions

Properties

Events

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ModelDataParameter()

Member Function Documentation

◆ Clone()

◆ Copy()

◆ FromProto()

◆ Load()

◆ PrepareRunModel()

◆ PrepareRunModelInputs()

◆ ToProto()

Property Documentation

◆ batch_size

◆ input_dim

◆ sample_size

◆ shuffle

◆ source

◆ time_steps

Event Documentation

◆ OnVerifyBatchSize