MyCaffe.trainers.common.IMemoryCollection Interface Reference

The IMemoryCollection interface is implemented by all memory collection types. More...

Inheritance diagram for MyCaffe.trainers.common.IMemoryCollection:

Public Member Functions
void	Add (MemoryItem m)
	Add a new item to the memory collection. More...
MemoryCollection	GetSamples (CryptoRandom random, int nCount, double dfBeta)
	Retrieve a set of samples from the collection. More...
void	Update (MemoryCollection rgSamples)
	Updates the memory collection - currently only used by the Prioritized memory collection to update its priorities. More...
void	CleanUp ()
	Performs final clean-up tasks. More...

Properties
int	Count [get]
	Returns the number of items in the memory collection. More...

Detailed Description

The IMemoryCollection interface is implemented by all memory collection types.

Definition at line 36 of file Interfaces.cs.

Member Function Documentation

Add()

void MyCaffe.trainers.common.IMemoryCollection.Add

(

MemoryItem

m

)

Add a new item to the memory collection.

Parameters

m	Specifies the memory item to add.

Implemented in MyCaffe.trainers.common.PrioritizedMemoryCollection, MyCaffe.trainers.common.RandomMemoryCollection, and MyCaffe.trainers.common.FileMemoryCollection.

CleanUp()

void MyCaffe.trainers.common.IMemoryCollection.CleanUp

(

)

Performs final clean-up tasks.

Implemented in MyCaffe.trainers.common.FileMemoryCollection, MyCaffe.trainers.common.PrioritizedMemoryCollection, and MyCaffe.trainers.common.RandomMemoryCollection.

GetSamples()

MemoryCollection MyCaffe.trainers.common.IMemoryCollection.GetSamples	(	CryptoRandom	random,
		int	nCount,
		double	dfBeta
	)

Retrieve a set of samples from the collection.

Parameters

random	Specifies the random number generator.
nCount	Specifies the number of samples to retrieve.
dfBeta	Specifies a value used by the prioritized memory collection.

Returns

Implemented in MyCaffe.trainers.common.FileMemoryCollection, MyCaffe.trainers.common.PrioritizedMemoryCollection, and MyCaffe.trainers.common.RandomMemoryCollection.

Update()

void MyCaffe.trainers.common.IMemoryCollection.Update

(

MemoryCollection

rgSamples

)

Updates the memory collection - currently only used by the Prioritized memory collection to update its priorities.

Parameters

rgSamples

Specifies the samples with updated priorities (if used).

Implemented in MyCaffe.trainers.common.FileMemoryCollection, MyCaffe.trainers.common.PrioritizedMemoryCollection, and MyCaffe.trainers.common.RandomMemoryCollection.

Property Documentation

Count

int MyCaffe.trainers.common.IMemoryCollection.Count

get

Returns the number of items in the memory collection.

Definition at line 59 of file Interfaces.cs.

---

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

• C:/Data/Data/SS_Projects/Intelligence/GitHub/MyCaffe/MyCaffe.trainers/common/Interfaces.cs