MyCaffe.db.temporal.DataSet Class Reference

The DataSet class loads the training and testing data. More...

Public Member Functions
	DataSet (DatasetDescriptor ds, Log log)
	The constructor. More...
void	CleanUp ()
	Remove all data for the dataset from memory. More...
TemporalSet	GetTemporalSetByPhase (Phase phase)
	Returns the temporal set for the specified phase. More...
TemporalSet	GetTemporalSetBySourceID (int nSourceID)
	Returns the temporal set for the specified source ID. More...
double	GetLoadPercent (out double dfTraining, out double dfTesting)
	Return the load percentage for the dataset. More...
bool	Load (DB_LOAD_METHOD loadMethod, int nLoadLimit, double dfReplacementPct, int nRefreshUpdateMs, bool bNormalizedData, int nHistoricalSteps, int nFutureSteps, int nChunks, EventWaitHandle evtCancel)
	Load the training and testing data. More...
bool	WaitForLoadingToComplete (AutoResetEvent evtCancel)
	Wait for the loading to complete. More...

Properties
DatasetDescriptor	Dataset [get]
	Return the dataset descriptor. More...

Detailed Description

The DataSet class loads the training and testing data.

Definition at line 16 of file DataSet.cs.

Constructor & Destructor Documentation

DataSet()

MyCaffe.db.temporal.DataSet.DataSet	(	DatasetDescriptor	ds,
		Log	log
	)

The constructor.

Parameters

ds	Specifies the dataset descriptor.
log	Specifies the output log.

Definition at line 30 of file DataSet.cs.

Member Function Documentation

CleanUp()

void MyCaffe.db.temporal.DataSet.CleanUp

(

)

Remove all data for the dataset from memory.

Definition at line 39 of file DataSet.cs.

GetLoadPercent()

double MyCaffe.db.temporal.DataSet.GetLoadPercent	(	out double	dfTraining,
		out double	dfTesting
	)

Return the load percentage for the dataset.

Parameters

dfTraining	Specifies the training percent loaded.
dfTesting	Specifies the testing percent loaded.

Returns

Returns the total load percent.

Definition at line 91 of file DataSet.cs.

GetTemporalSetByPhase()

TemporalSet MyCaffe.db.temporal.DataSet.GetTemporalSetByPhase

(

Phase

phase

)

Returns the temporal set for the specified phase.

Parameters

phase

Specifies the phase.

Returns

The temporal set associated with the phase is returned.

Definition at line 64 of file DataSet.cs.

GetTemporalSetBySourceID()

TemporalSet MyCaffe.db.temporal.DataSet.GetTemporalSetBySourceID

(

int

nSourceID

)

Returns the temporal set for the specified source ID.

Parameters

nSourceID

Specifies the source ID associated with the temporal set.

Returns

The temporal set associated with the source ID is returned.

Definition at line 77 of file DataSet.cs.

Load()

bool MyCaffe.db.temporal.DataSet.Load	(	DB_LOAD_METHOD	loadMethod,
		int	nLoadLimit,
		double	dfReplacementPct,
		int	nRefreshUpdateMs,
		bool	bNormalizedData,
		int	nHistoricalSteps,
		int	nFutureSteps,
		int	nChunks,
		EventWaitHandle	evtCancel
	)

Load the training and testing data.

Parameters

loadMethod	Specifies the loading method.
nLoadLimit	Specifies the load limit (or 0 to ignore)
dfReplacementPct	Specifies the percent of replacement on a load limit event.
nRefreshUpdateMs	Specifies the refresh update perod in milliseconds.
bNormalizedData	Specifies to load the normalized data.
nHistoricalSteps	Specifies the number of sequential historical steps in each block.
nFutureSteps	Specifies the number of sequential future steps in each block.
nChunks	Specifies the number of blocks to load at a time.
evtCancel	Specifies the event used to cancel the initialization process.

Definition at line 118 of file DataSet.cs.

WaitForLoadingToComplete()

bool MyCaffe.db.temporal.DataSet.WaitForLoadingToComplete

(

AutoResetEvent

evtCancel

)

Wait for the loading to complete.

Parameters

evtCancel

Specifies an auto reset event used to abort waiting.

Returns

True is returned once loaded, otherwise false is returned when aborting.

Definition at line 152 of file DataSet.cs.

Property Documentation

Dataset

DatasetDescriptor MyCaffe.db.temporal.DataSet.Dataset

get

Return the dataset descriptor.

Definition at line 54 of file DataSet.cs.

---

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

• C:/Data/Data/SS_Projects/Intelligence/GitHub/MyCaffe/MyCaffe.db.temporal/DataSet.cs