MyCaffe  1.11.8.27
Deep learning software for Windows C# programmers.
MyCaffe.basecode.descriptors.ProjectDescriptor Class Reference

The ProjectDescriptor class contains all information describing a project, such as its: dataset, group, settings, solver description, model description, and parmeters. More...

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

Public Member Functions

 ProjectDescriptor (string strName)
 The ProjectDescriptor constructor. More...
 
 ProjectDescriptor (int nID, string strName, DatasetDescriptor ds, GroupDescriptor grp, string strSolverName, string strSolverDesc, string strModelName, string strModelDesc, string strGpuOverride, int nTotalIterations, bool bActive, SettingsCaffe settings, string strOwner)
 The ProjectDescriptor constructor. More...
 
 ProjectDescriptor (ProjectDescriptor p)
 The ProjectDescriptor constructor. 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...
 

Properties

virtual string GpuOverride [getset]
 Get/set the GPU ID's to use as an override. More...
 
DatasetDescriptor Dataset [getset]
 Get/set the dataset used. More...
 
DatasetDescriptor DatasetTarget [getset]
 Get/set the secondary 'target' dataset (if used). More...
 
GroupDescriptor Group [getset]
 Get/set the project group. More...
 
string SolverName [getset]
 Get/set the solver name. More...
 
string SolverDescription [getset]
 Get/set the solver description script. More...
 
string ModelName [getset]
 Get/set the model name. More...
 
string ModelDescription [getset]
 Get/set the model description script. More...
 
int TotalIterations [getset]
 Get/set the total iterations. More...
 
bool Active [get]
 Returns whether or not the project is active. More...
 
ParameterDescriptorCollection Parameters [get]
 Returns the collection of parameters of the Project. More...
 
ValueDescriptorCollection AnalysisItems [get]
 Returns the collection of analysis ValueDescriptors of the Project. More...
 
SettingsCaffe Settings [getset]
 Get/set the settings of the Project. More...
 
- Properties inherited from MyCaffe.basecode.descriptors.BaseDescriptor
int ID [getset]
 Get/set the database ID of the item. More...
 
string Name [getset]
 Get/set the name of the item. More...
 
string Owner [getset]
 Get/set the owner of the item. More...
 

Detailed Description

The ProjectDescriptor class contains all information describing a project, such as its: dataset, group, settings, solver description, model description, and parmeters.

Definition at line 14 of file ProjectDescriptor.cs.

Constructor & Destructor Documentation

◆ ProjectDescriptor() [1/3]

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

The ProjectDescriptor constructor.

Parameters
strNameSpecifies the name of the item.

Definition at line 34 of file ProjectDescriptor.cs.

◆ ProjectDescriptor() [2/3]

MyCaffe.basecode.descriptors.ProjectDescriptor.ProjectDescriptor ( int  nID,
string  strName,
DatasetDescriptor  ds,
GroupDescriptor  grp,
string  strSolverName,
string  strSolverDesc,
string  strModelName,
string  strModelDesc,
string  strGpuOverride,
int  nTotalIterations,
bool  bActive,
SettingsCaffe  settings,
string  strOwner 
)

The ProjectDescriptor constructor.

Parameters
nIDSpecifies the database ID of the item.
strNameSpecifies the name of the item.
dsSpecifies the dataset used.
grpSpecifies the project group.
strSolverNameSpecifies the solver name.
strSolverDescSpecifies the solver description script.
strModelNameSpecifies the model name.
strModelDescSpecifies the model description script.
strGpuOverrideSpecifies the GPU ID's to use as an override.
nTotalIterationsSpecifies the total number of iterations.
bActiveSpecifies whether or not the project is active.
settingsSpecifies the settings to use.
strOwnerSpecifies the identifier of the item's owner.

Definition at line 55 of file ProjectDescriptor.cs.

◆ ProjectDescriptor() [3/3]

MyCaffe.basecode.descriptors.ProjectDescriptor.ProjectDescriptor ( ProjectDescriptor  p)

The ProjectDescriptor constructor.

Parameters
pSpecifies another ProjectDescriptor used to create this one.

Definition at line 82 of file ProjectDescriptor.cs.

Member Function Documentation

◆ ToString()

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

Creates the string representation of the descriptor.

Returns
The string representation of the descriptor is returned.

Definition at line 225 of file ProjectDescriptor.cs.

Property Documentation

◆ Active

bool MyCaffe.basecode.descriptors.ProjectDescriptor.Active
get

Returns whether or not the project is active.

Definition at line 188 of file ProjectDescriptor.cs.

◆ AnalysisItems

ValueDescriptorCollection MyCaffe.basecode.descriptors.ProjectDescriptor.AnalysisItems
get

Returns the collection of analysis ValueDescriptors of the Project.

Definition at line 206 of file ProjectDescriptor.cs.

◆ Dataset

DatasetDescriptor MyCaffe.basecode.descriptors.ProjectDescriptor.Dataset
getset

Get/set the dataset used.

Definition at line 101 of file ProjectDescriptor.cs.

◆ DatasetTarget

DatasetDescriptor MyCaffe.basecode.descriptors.ProjectDescriptor.DatasetTarget
getset

Get/set the secondary 'target' dataset (if used).

Definition at line 112 of file ProjectDescriptor.cs.

◆ GpuOverride

virtual string MyCaffe.basecode.descriptors.ProjectDescriptor.GpuOverride
getset

Get/set the GPU ID's to use as an override.

Definition at line 91 of file ProjectDescriptor.cs.

◆ Group

GroupDescriptor MyCaffe.basecode.descriptors.ProjectDescriptor.Group
getset

Get/set the project group.

Definition at line 122 of file ProjectDescriptor.cs.

◆ ModelDescription

string MyCaffe.basecode.descriptors.ProjectDescriptor.ModelDescription
getset

Get/set the model description script.

Definition at line 166 of file ProjectDescriptor.cs.

◆ ModelName

string MyCaffe.basecode.descriptors.ProjectDescriptor.ModelName
getset

Get/set the model name.

Definition at line 155 of file ProjectDescriptor.cs.

◆ Parameters

ParameterDescriptorCollection MyCaffe.basecode.descriptors.ProjectDescriptor.Parameters
get

Returns the collection of parameters of the Project.

Definition at line 197 of file ProjectDescriptor.cs.

◆ Settings

SettingsCaffe MyCaffe.basecode.descriptors.ProjectDescriptor.Settings
getset

Get/set the settings of the Project.

Definition at line 215 of file ProjectDescriptor.cs.

◆ SolverDescription

string MyCaffe.basecode.descriptors.ProjectDescriptor.SolverDescription
getset

Get/set the solver description script.

Definition at line 144 of file ProjectDescriptor.cs.

◆ SolverName

string MyCaffe.basecode.descriptors.ProjectDescriptor.SolverName
getset

Get/set the solver name.

Definition at line 133 of file ProjectDescriptor.cs.

◆ TotalIterations

int MyCaffe.basecode.descriptors.ProjectDescriptor.TotalIterations
getset

Get/set the total iterations.

Definition at line 177 of file ProjectDescriptor.cs.


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