MyCaffe  0.11.2.9-beta1
Deep learning software for Windows C# programmers.
MyCaffe.basecode.descriptors.DatasetDescriptor Class Reference

The DatasetDescriptor class describes a dataset which contains both a training data source and testing data source. More...

Inheritance diagram for MyCaffe.basecode.descriptors.DatasetDescriptor:
MyCaffe.basecode.descriptors.BaseDescriptor

Public Member Functions

 DatasetDescriptor (int nID, string strName, GroupDescriptor grpModel, GroupDescriptor grpDs, SourceDescriptor srcTrain, SourceDescriptor srcTest, string strCreatorName, string strDescription, string strOwner=null, GYM_TYPE gymType=GYM_TYPE.NONE)
 The DatasetDescriptor constructor. More...
 
 DatasetDescriptor (string strName)
 The DatasetDescriptor constructor. More...
 
 DatasetDescriptor (DatasetDescriptor d)
 The DatasetDescriptor constructor. More...
 
void Resize (int nChannels, int nHeight, int nWidth)
 Resize the testing and training data sources. More...
 
void Copy (DatasetDescriptor ds)
 Copy another DatasetDesciptor into this one. More...
 
override string ToString ()
 Creates the string representation of the descriptor. More...
 
- Public Member Functions inherited from MyCaffe.basecode.descriptors.BaseDescriptor
 BaseDescriptor (int nID, string strName, string strOwner)
 The BaseDescriptor constructor. More...
 
 BaseDescriptor (BaseDescriptor b)
 The BaseDescriptor constructor. More...
 
void Copy (BaseDescriptor b)
 Copy another BaseDescriptor into this one. More...
 

Static Public Member Functions

static bool IsGymName (string str)
 Returns whether or not the name is from a gym. More...
 
static string GetGymName (string str, out string strType)
 Returns the actual gym name by parsing off the 'GYM:' if it exists. More...
 
static byte [] Serialize (DatasetDescriptor ds)
 Serialize a dataset descriptor to a byte array. More...
 
static DatasetDescriptor Deserialize (byte[] rg)
 Deserialize a dataset descriptor from a byte array. More...
 

Properties

bool IsGym [get]
 Returns whether or not this dataset is from a Gym. More...
 
GYM_TYPE GymType [get]
 Returns the Gym type, if any. More...
 
string FullName [get]
 Returns the full name which returns 'GYM:Name:Type' when using a gym based dataset, otherwise just 'Name' is returned. More...
 
GroupDescriptor DatasetGroup [get]
 Returns the dataset group. More...
 
GroupDescriptor ModelGroup [get, set]
 Get/set the dataset model group. More...
 
SourceDescriptor TrainingSource [get, set]
 Get/set the training data source. More...
 
SourceDescriptor TestingSource [get, set]
 Get/set the testing data source. More...
 
string TrainingSourceName [get]
 Returns the training source name, or null if not specifies. More...
 
string TestingSourceName [get]
 Returns the testing source name or null if not specified. More...
 
string CreatorName [get]
 Returns the dataset creator name. More...
 
string Description [get, set]
 Get/set the description of the Dataset. More...
 
ParameterDescriptorCollection Parameters [get, set]
 Get/set the dataset parameters (if any). More...
 
- Properties inherited from MyCaffe.basecode.descriptors.BaseDescriptor
int ID [get, set]
 Get/set the database ID of the item. More...
 
string Name [get, set]
 Get/set the name of the item. More...
 
string Owner [get, set]
 Get/set the owner of the item. More...
 

Detailed Description

The DatasetDescriptor class describes a dataset which contains both a training data source and testing data source.

Definition at line 17 of file DatasetDescriptor.cs.

Constructor & Destructor Documentation

◆ DatasetDescriptor() [1/3]

MyCaffe.basecode.descriptors.DatasetDescriptor.DatasetDescriptor ( int  nID,
string  strName,
GroupDescriptor  grpModel,
GroupDescriptor  grpDs,
SourceDescriptor  srcTrain,
SourceDescriptor  srcTest,
string  strCreatorName,
string  strDescription,
string  strOwner = null,
GYM_TYPE  gymType = GYM_TYPE.NONE 
)

The DatasetDescriptor constructor.

Parameters
nIDSpecifies the database ID of the item.
strNameSpecifies the name of the item.
grpModelSpecifies the group of the model.
grpDsSpecifies the group of the dataset.
srcTrainSpecifies the data source for training.
srcTestSpecifies the data source for testing.
strCreatorNameSpecifies the dataset creator name.
strDescriptionSpecifies a description of the dataset.
strOwnerSpecifies the identifier of the item's owner.
gymTypeOptionally, specifies the gym type to use if any (default = NONE).

Definition at line 41 of file DatasetDescriptor.cs.

◆ DatasetDescriptor() [2/3]

MyCaffe.basecode.descriptors.DatasetDescriptor.DatasetDescriptor ( string  strName)

The DatasetDescriptor constructor.

Parameters
strNameSpecifies the name of the item.

Definition at line 70 of file DatasetDescriptor.cs.

◆ DatasetDescriptor() [3/3]

MyCaffe.basecode.descriptors.DatasetDescriptor.DatasetDescriptor ( DatasetDescriptor  d)

The DatasetDescriptor constructor.

Parameters
dSpecifies another DatasetDesciptor used to create this one.

Definition at line 79 of file DatasetDescriptor.cs.

Member Function Documentation

◆ Copy()

void MyCaffe.basecode.descriptors.DatasetDescriptor.Copy ( DatasetDescriptor  ds)

Copy another DatasetDesciptor into this one.

Parameters
dsSpecifies the DatasetDesciptor to copy.

Definition at line 101 of file DatasetDescriptor.cs.

◆ Deserialize()

static DatasetDescriptor MyCaffe.basecode.descriptors.DatasetDescriptor.Deserialize ( byte []  rg)
static

Deserialize a dataset descriptor from a byte array.

Parameters
rgSpecifies the byte array.
Returns
The deserialized dataset descriptor is returned.

Definition at line 305 of file DatasetDescriptor.cs.

◆ GetGymName()

static string MyCaffe.basecode.descriptors.DatasetDescriptor.GetGymName ( string  str,
out string  strType 
)
static

Returns the actual gym name by parsing off the 'GYM:' if it exists.

Parameters
strSpecifies the name.
strTypeSpecifies the type.
Returns
The actual gym name is returned.

Definition at line 180 of file DatasetDescriptor.cs.

◆ IsGymName()

static bool MyCaffe.basecode.descriptors.DatasetDescriptor.IsGymName ( string  str)
static

Returns whether or not the name is from a gym.

Parameters
strSpecifies the name.
Returns
If the name is from a gym, true is returned, otherwise false is returned.

Definition at line 166 of file DatasetDescriptor.cs.

◆ Resize()

void MyCaffe.basecode.descriptors.DatasetDescriptor.Resize ( int  nChannels,
int  nHeight,
int  nWidth 
)

Resize the testing and training data sources.

Parameters
nChannelsSpecifies the new channel size.
nHeightSpecifies the new height size.
nWidthSpecifies the new width size.

Definition at line 91 of file DatasetDescriptor.cs.

◆ Serialize()

static byte [] MyCaffe.basecode.descriptors.DatasetDescriptor.Serialize ( DatasetDescriptor  ds)
static

Serialize a dataset descriptor to a byte array.

Parameters
dsSpecifies the dataset descriptor to serialize.
Returns
A byte array containing the serialized dataset is returned.

Definition at line 289 of file DatasetDescriptor.cs.

◆ ToString()

override string MyCaffe.basecode.descriptors.DatasetDescriptor.ToString ( )

Creates the string representation of the descriptor.

Returns
The string representation of the descriptor is returned.

Definition at line 318 of file DatasetDescriptor.cs.

Property Documentation

◆ CreatorName

string MyCaffe.basecode.descriptors.DatasetDescriptor.CreatorName
get

Returns the dataset creator name.

Definition at line 260 of file DatasetDescriptor.cs.

◆ DatasetGroup

GroupDescriptor MyCaffe.basecode.descriptors.DatasetDescriptor.DatasetGroup
get

Returns the dataset group.

Definition at line 203 of file DatasetDescriptor.cs.

◆ Description

string MyCaffe.basecode.descriptors.DatasetDescriptor.Description
getset

Get/set the description of the Dataset.

Definition at line 269 of file DatasetDescriptor.cs.

◆ FullName

string MyCaffe.basecode.descriptors.DatasetDescriptor.FullName
get

Returns the full name which returns 'GYM:Name:Type' when using a gym based dataset, otherwise just 'Name' is returned.

Definition at line 157 of file DatasetDescriptor.cs.

◆ GymType

GYM_TYPE MyCaffe.basecode.descriptors.DatasetDescriptor.GymType
get

Returns the Gym type, if any.

Definition at line 149 of file DatasetDescriptor.cs.

◆ IsGym

bool MyCaffe.basecode.descriptors.DatasetDescriptor.IsGym
get

Returns whether or not this dataset is from a Gym.

Definition at line 141 of file DatasetDescriptor.cs.

◆ ModelGroup

GroupDescriptor MyCaffe.basecode.descriptors.DatasetDescriptor.ModelGroup
getset

Get/set the dataset model group.

Definition at line 212 of file DatasetDescriptor.cs.

◆ Parameters

ParameterDescriptorCollection MyCaffe.basecode.descriptors.DatasetDescriptor.Parameters
getset

Get/set the dataset parameters (if any).

Definition at line 279 of file DatasetDescriptor.cs.

◆ TestingSource

SourceDescriptor MyCaffe.basecode.descriptors.DatasetDescriptor.TestingSource
getset

Get/set the testing data source.

Definition at line 232 of file DatasetDescriptor.cs.

◆ TestingSourceName

string MyCaffe.basecode.descriptors.DatasetDescriptor.TestingSourceName
get

Returns the testing source name or null if not specified.

Definition at line 251 of file DatasetDescriptor.cs.

◆ TrainingSource

SourceDescriptor MyCaffe.basecode.descriptors.DatasetDescriptor.TrainingSource
getset

Get/set the training data source.

Definition at line 222 of file DatasetDescriptor.cs.

◆ TrainingSourceName

string MyCaffe.basecode.descriptors.DatasetDescriptor.TrainingSourceName
get

Returns the training source name, or null if not specifies.

Definition at line 242 of file DatasetDescriptor.cs.


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