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

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

Inheritance diagram for MyCaffe.param.HDF5DataParameter:
MyCaffe.param.LayerParameterBase MyCaffe.basecode.BaseParameter MyCaffe.basecode.IBinaryPersist

Public Member Functions

 HDF5DataParameter ()
 Constructor for the parameter. 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...
 
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 HDF5DataParameter FromProto (RawProto rp, HDF5DataParameter 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 source [getset]
 Specifies the data source. More...
 
virtual uint batch_size [getset]
 Specifies the batch size. More...
 
List< BlobShapeexpected_top_shapes [getset]
 Specifies the expected top shapes. Only used to verify input shapes, if the shape is -1 or does not exist the verification test is ignored for the shape. More...
 
bool shuffle [getset]
 Specifies the whether to shuffle the data or now. More...
 

Events

EventHandler< VerifyBatchSizeArgsOnVerifyBatchSize
 This event is, optionally, called to verify the batch size of the HDF5DataParameter. 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 HDF5 data layer.

Note: given the new use of the Transformation Parameter, the depreciated elements of the HDF5DataParameter have been removed.

Definition at line 19 of file HDF5DataParameter.cs.

Constructor & Destructor Documentation

◆ HDF5DataParameter()

MyCaffe.param.HDF5DataParameter.HDF5DataParameter ( )

Constructor for the parameter.

Definition at line 32 of file HDF5DataParameter.cs.

Member Function Documentation

◆ Clone()

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

◆ Copy()

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

Copy on parameter to another.

Parameters
srcSpecifies the parameter to copy.

Implements MyCaffe.param.LayerParameterBase.

Definition at line 100 of file HDF5DataParameter.cs.

◆ FromProto()

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

Parses the parameter from a RawProto.

Parameters
rpSpecifies the RawProto to parse.
pOptionally, 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 149 of file HDF5DataParameter.cs.

◆ Load()

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

◆ ToProto()

override RawProto MyCaffe.param.HDF5DataParameter.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.

Implements MyCaffe.basecode.BaseParameter.

Definition at line 127 of file HDF5DataParameter.cs.

Property Documentation

◆ batch_size

virtual uint MyCaffe.param.HDF5DataParameter.batch_size
getset

Specifies the batch size.

Definition at line 50 of file HDF5DataParameter.cs.

◆ expected_top_shapes

List<BlobShape> MyCaffe.param.HDF5DataParameter.expected_top_shapes
getset

Specifies the expected top shapes. Only used to verify input shapes, if the shape is -1 or does not exist the verification test is ignored for the shape.

Definition at line 71 of file HDF5DataParameter.cs.

◆ shuffle

bool MyCaffe.param.HDF5DataParameter.shuffle
getset

Specifies the whether to shuffle the data or now.

Definition at line 81 of file HDF5DataParameter.cs.

◆ source

string MyCaffe.param.HDF5DataParameter.source
getset

Specifies the data source.

Definition at line 40 of file HDF5DataParameter.cs.

Event Documentation

◆ OnVerifyBatchSize

EventHandler<VerifyBatchSizeArgs> MyCaffe.param.HDF5DataParameter.OnVerifyBatchSize

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

Definition at line 29 of file HDF5DataParameter.cs.


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