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

Inheritance diagram for MyCaffe.param.TextDataParameter:

Public Member Functions
	TextDataParameter ()
	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 TextDataParameter	FromProto (RawProto rp, TextDataParameter 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
string	encoder_source `[getset]`
	Specifies the encoder data source. More...

string	decoder_source `[getset]`
	Specifies the decoder data source. 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	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...

bool	enable_normal_encoder_output `[getset]`
	When enabled, the normal ordered encoder data is output (default = true). More...

bool	enable_reverse_encoder_output `[getset]`
	When enabled, the reverse ordered encoder data is output (default = true). 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 Text data layer.

Definition at line 15 of file TextDataParameter.cs.

Constructor & Destructor Documentation

◆ TextDataParameter()

MyCaffe.param.TextDataParameter.TextDataParameter ( )

Constructor for the parameter.

Definition at line 32 of file TextDataParameter.cs.

Member Function Documentation

◆ Clone()

override LayerParameterBase MyCaffe.param.TextDataParameter.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 190 of file TextDataParameter.cs.

◆ Copy()

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

virtual

Copy on parameter to another.

Parameters

src	Specifies the parameter to copy.

Implements MyCaffe.param.LayerParameterBase.

Definition at line 176 of file TextDataParameter.cs.

◆ FromProto()

static TextDataParameter MyCaffe.param.TextDataParameter.FromProto	(	RawProto	rp,
		TextDataParameter	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 224 of file TextDataParameter.cs.

◆ Load()

override object MyCaffe.param.TextDataParameter.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 164 of file TextDataParameter.cs.

◆ PrepareRunModel()

override void MyCaffe.param.TextDataParameter.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 64 of file TextDataParameter.cs.

◆ PrepareRunModelInputs()

override string MyCaffe.param.TextDataParameter.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 41 of file TextDataParameter.cs.

◆ ToProto()

override RawProto MyCaffe.param.TextDataParameter.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 202 of file TextDataParameter.cs.

Property Documentation

◆ batch_size

virtual uint MyCaffe.param.TextDataParameter.batch_size

getset

Specifies the batch size.

Definition at line 96 of file TextDataParameter.cs.

◆ decoder_source

string MyCaffe.param.TextDataParameter.decoder_source

getset

Specifies the decoder data source.

Definition at line 86 of file TextDataParameter.cs.

◆ enable_normal_encoder_output

bool MyCaffe.param.TextDataParameter.enable_normal_encoder_output

getset

When enabled, the normal ordered encoder data is output (default = true).

Definition at line 147 of file TextDataParameter.cs.

◆ enable_reverse_encoder_output

bool MyCaffe.param.TextDataParameter.enable_reverse_encoder_output

getset

When enabled, the reverse ordered encoder data is output (default = true).

Definition at line 157 of file TextDataParameter.cs.

◆ encoder_source

string MyCaffe.param.TextDataParameter.encoder_source

getset

Specifies the encoder data source.

Definition at line 76 of file TextDataParameter.cs.

◆ sample_size

uint MyCaffe.param.TextDataParameter.sample_size

getset

Specifies the sample size to select from the data sources.

Definition at line 127 of file TextDataParameter.cs.

◆ shuffle

bool MyCaffe.param.TextDataParameter.shuffle

getset

Specifies the whether to shuffle the data or now.

Definition at line 137 of file TextDataParameter.cs.

◆ time_steps

uint MyCaffe.param.TextDataParameter.time_steps

getset

Specifies the maximum length for each encoder input.

Definition at line 117 of file TextDataParameter.cs.

Event Documentation

◆ OnVerifyBatchSize

EventHandler<VerifyBatchSizeArgs> MyCaffe.param.TextDataParameter.OnVerifyBatchSize

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

Definition at line 29 of file TextDataParameter.cs.

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

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

Public Member Functions

Static Public Member Functions

Properties

Events

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TextDataParameter()

Member Function Documentation

◆ Clone()

◆ Copy()

◆ FromProto()

◆ Load()

◆ PrepareRunModel()

◆ PrepareRunModelInputs()

◆ ToProto()

Property Documentation

◆ batch_size

◆ decoder_source

◆ enable_normal_encoder_output

◆ enable_reverse_encoder_output

◆ encoder_source

◆ sample_size

◆ shuffle

◆ time_steps

Event Documentation

◆ OnVerifyBatchSize