GClasses
GClasses::GBlockLinear Class Reference

Detailed Description

Standard fully-connected block of weights. Often followed by a GBlockActivation.

#include <GBlock.h>

Inheritance diagram for GClasses::GBlockLinear:
GClasses::GBlock

Public Member Functions

 GBlockLinear (size_t outputs, size_t inputs=0)
 
 GBlockLinear (GDomNode *pNode)
 
virtual void backProp (GContext &ctx, const GVec &input, const GVec &output, const GVec &outBlame, GVec &inBlame) const override
 Evaluates outBlame, and adds to inBlame. (Note that it "adds to" the inBlame because multiple blocks may fork from a common source.) More...
 
void backProp2 (const GVec &outBlame, GVec &inBlame1, GVec &inBlame2) const
 A convenience method that mirrors forwardProp2. More...
 
GVecbias ()
 Returns the bias vector of this block. More...
 
const GVecbias () const
 Returns the bias vector of this block. More...
 
void contractWeights (double factor, bool contractBiases, const GVec &output)
 Applies contractive regularization to the weights in this block. More...
 
virtual void copyWeights (const GBlock *pSource) override
 Copy the weights from pSource to this block. (Assumes pSource is the same type of block.) More...
 
virtual void diminishWeights (double amount, bool regularizeBiases) override
 Moves all weights in the direction of zero by the specified amount. More...
 
void dropInput (size_t input)
 Drops an input from this block. More...
 
void dropOutput (size_t output)
 Drops an output from this block. More...
 
virtual void forwardProp (GContext &ctx, const GVec &input, GVec &output) const override
 Evaluate the input, set the output. More...
 
void forwardProp2 (const GVec &in1, const GVec &in2, GVec &output) const
 A convenience method that concatenates two vectors before feeding into this block. More...
 
virtual size_t inputs () const override
 Returns the number of inputs this block consumes. More...
 
virtual void maxNorm (double min, double max) override
 Scales weights if necessary such that the manitude of the weights (not including the bias) feeding into each unit are >= min and <= max. More...
 
virtual std::string name () const override
 Returns the name of this block. More...
 
virtual size_t outputs () const override
 Returns the number of outputs this block produces. More...
 
virtual void perturbWeights (GRand &rand, double deviation) override
 Perturbs the weights that feed into the specifed units with Gaussian noise. The default values apply the perturbation to all units. More...
 
void renormalizeInput (size_t input, double oldMin, double oldMax, double newMin=0.0, double newMax=1.0)
 Adjusts weights such that values in the new range will result in the same behavior that previously resulted from values in the old range. More...
 
virtual void resetWeights (GRand &rand) override
 Initialize the weights with small random values. More...
 
virtual void resize (size_t inputs, size_t outputs) override
 Resizes this block. More...
 
virtual void scaleWeights (double factor, bool scaleBiases) override
 Multiplies all the weights by the specified factor. More...
 
virtual GDomNodeserialize (GDom *pDoc) const override
 Marshall this block into a DOM. More...
 
virtual void step (double learningRate, const GVec &gradient) override
 Add the weight and bias gradient to the weights. More...
 
void transformWeights (GMatrix &transform, const GVec &offset)
 Transforms the weights of this block by the specified transformation matrix and offset vector. transform should be the pseudoinverse of the transform applied to the inputs. pOffset should be the negation of the offset added to the inputs after the transform, or the transformed offset that is added before the transform. More...
 
virtual BlockType type () const override
 Returns the type of this block. More...
 
virtual void updateGradient (GContext &ctx, const GVec &input, const GVec &outBlame, GVec &gradient) const override
 Updates the gradient for updating the weights by gradient descent. (Assumes the error has already been computed and deactivated.) More...
 
void updateGradient2 (const GVec &in1, const GVec &in2, const GVec &outBlame, GVec &gradient) const
 A convenience method that goes with forwardProp2 and backProp2. More...
 
virtual size_t vectorToWeights (const double *pVector) override
 Deserialize from a vector to the weights in this block. Return the number of elements consumed. More...
 
virtual size_t weightCount () const override
 Returns the number of double-precision elements necessary to serialize the weights of this block into a vector. More...
 
GMatrixweights ()
 Get the entire weights matrix. More...
 
const GMatrixweights () const
 Get the entire weights matrix. More...
 
virtual size_t weightsToVector (double *pOutVector) const override
 Serialize the weights in this block into a vector. Return the number of elements written. More...
 
- Public Member Functions inherited from GClasses::GBlock
 GBlock ()
 
 GBlock (GDomNode *pNode)
 
virtual ~GBlock ()
 
virtual bool elementWise () const
 Returns true iff this block operates only on individual elements. More...
 
size_t inPos () const
 Returns the offset in the previous layer's output where values are fed as input to this block. More...
 
virtual bool isRecurrent () const
 Returns true iff this block is recurrent. More...
 
void setInPos (size_t n)
 Sets the starting offset in the previous layer's output where values will be fed as input to this block. More...
 
virtual std::string to_str () const
 Returns a string representation of this block. More...
 
virtual bool usesGPU ()
 Returns true iff this block does its computations in parallel on a GPU. More...
 

Protected Attributes

GMatrix m_weights
 
- Protected Attributes inherited from GClasses::GBlock
size_t m_inPos
 

Additional Inherited Members

- Public Types inherited from GClasses::GBlock
- Static Public Member Functions inherited from GClasses::GBlock
static GBlockdeserialize (GDomNode *pNode)
 Unmarshalls the specified DOM node into a block object. More...
 
- Protected Member Functions inherited from GClasses::GBlock
GDomNodebaseDomNode (GDom *pDoc) const
 
void basicTest ()
 Exercises some basic functionality that all blocks have in common. More...
 

Constructor & Destructor Documentation

GClasses::GBlockLinear::GBlockLinear ( size_t  outputs,
size_t  inputs = 0 
)
GClasses::GBlockLinear::GBlockLinear ( GDomNode pNode)

Member Function Documentation

virtual void GClasses::GBlockLinear::backProp ( GContext ctx,
const GVec input,
const GVec output,
const GVec outBlame,
GVec inBlame 
) const
overridevirtual

Evaluates outBlame, and adds to inBlame. (Note that it "adds to" the inBlame because multiple blocks may fork from a common source.)

Implements GClasses::GBlock.

void GClasses::GBlockLinear::backProp2 ( const GVec outBlame,
GVec inBlame1,
GVec inBlame2 
) const

A convenience method that mirrors forwardProp2.

GVec& GClasses::GBlockLinear::bias ( )
inline

Returns the bias vector of this block.

const GVec& GClasses::GBlockLinear::bias ( ) const
inline

Returns the bias vector of this block.

void GClasses::GBlockLinear::contractWeights ( double  factor,
bool  contractBiases,
const GVec output 
)

Applies contractive regularization to the weights in this block.

virtual void GClasses::GBlockLinear::copyWeights ( const GBlock pSource)
overridevirtual

Copy the weights from pSource to this block. (Assumes pSource is the same type of block.)

Implements GClasses::GBlock.

virtual void GClasses::GBlockLinear::diminishWeights ( double  amount,
bool  regularizeBiases 
)
overridevirtual

Moves all weights in the direction of zero by the specified amount.

Implements GClasses::GBlock.

void GClasses::GBlockLinear::dropInput ( size_t  input)

Drops an input from this block.

void GClasses::GBlockLinear::dropOutput ( size_t  output)

Drops an output from this block.

virtual void GClasses::GBlockLinear::forwardProp ( GContext ctx,
const GVec input,
GVec output 
) const
overridevirtual

Evaluate the input, set the output.

Implements GClasses::GBlock.

void GClasses::GBlockLinear::forwardProp2 ( const GVec in1,
const GVec in2,
GVec output 
) const

A convenience method that concatenates two vectors before feeding into this block.

virtual size_t GClasses::GBlockLinear::inputs ( ) const
inlineoverridevirtual

Returns the number of inputs this block consumes.

Implements GClasses::GBlock.

virtual void GClasses::GBlockLinear::maxNorm ( double  min,
double  max 
)
overridevirtual

Scales weights if necessary such that the manitude of the weights (not including the bias) feeding into each unit are >= min and <= max.

Implements GClasses::GBlock.

virtual std::string GClasses::GBlockLinear::name ( ) const
inlineoverridevirtual

Returns the name of this block.

Implements GClasses::GBlock.

virtual size_t GClasses::GBlockLinear::outputs ( ) const
inlineoverridevirtual

Returns the number of outputs this block produces.

Implements GClasses::GBlock.

virtual void GClasses::GBlockLinear::perturbWeights ( GRand rand,
double  deviation 
)
overridevirtual

Perturbs the weights that feed into the specifed units with Gaussian noise. The default values apply the perturbation to all units.

Implements GClasses::GBlock.

void GClasses::GBlockLinear::renormalizeInput ( size_t  input,
double  oldMin,
double  oldMax,
double  newMin = 0.0,
double  newMax = 1.0 
)

Adjusts weights such that values in the new range will result in the same behavior that previously resulted from values in the old range.

virtual void GClasses::GBlockLinear::resetWeights ( GRand rand)
overridevirtual

Initialize the weights with small random values.

Implements GClasses::GBlock.

virtual void GClasses::GBlockLinear::resize ( size_t  inputs,
size_t  outputs 
)
overridevirtual

Resizes this block.

Implements GClasses::GBlock.

virtual void GClasses::GBlockLinear::scaleWeights ( double  factor,
bool  scaleBiases 
)
overridevirtual

Multiplies all the weights by the specified factor.

Implements GClasses::GBlock.

virtual GDomNode* GClasses::GBlockLinear::serialize ( GDom pDoc) const
overridevirtual

Marshall this block into a DOM.

Implements GClasses::GBlock.

virtual void GClasses::GBlockLinear::step ( double  learningRate,
const GVec gradient 
)
overridevirtual

Add the weight and bias gradient to the weights.

Implements GClasses::GBlock.

void GClasses::GBlockLinear::transformWeights ( GMatrix transform,
const GVec offset 
)

Transforms the weights of this block by the specified transformation matrix and offset vector. transform should be the pseudoinverse of the transform applied to the inputs. pOffset should be the negation of the offset added to the inputs after the transform, or the transformed offset that is added before the transform.

virtual BlockType GClasses::GBlockLinear::type ( ) const
inlineoverridevirtual

Returns the type of this block.

Implements GClasses::GBlock.

virtual void GClasses::GBlockLinear::updateGradient ( GContext ctx,
const GVec input,
const GVec outBlame,
GVec gradient 
) const
overridevirtual

Updates the gradient for updating the weights by gradient descent. (Assumes the error has already been computed and deactivated.)

Implements GClasses::GBlock.

void GClasses::GBlockLinear::updateGradient2 ( const GVec in1,
const GVec in2,
const GVec outBlame,
GVec gradient 
) const

A convenience method that goes with forwardProp2 and backProp2.

virtual size_t GClasses::GBlockLinear::vectorToWeights ( const double *  pVector)
overridevirtual

Deserialize from a vector to the weights in this block. Return the number of elements consumed.

Implements GClasses::GBlock.

virtual size_t GClasses::GBlockLinear::weightCount ( ) const
overridevirtual

Returns the number of double-precision elements necessary to serialize the weights of this block into a vector.

Implements GClasses::GBlock.

GMatrix& GClasses::GBlockLinear::weights ( )
inline

Get the entire weights matrix.

const GMatrix& GClasses::GBlockLinear::weights ( ) const
inline

Get the entire weights matrix.

virtual size_t GClasses::GBlockLinear::weightsToVector ( double *  pOutVector) const
overridevirtual

Serialize the weights in this block into a vector. Return the number of elements written.

Implements GClasses::GBlock.

Member Data Documentation

GMatrix GClasses::GBlockLinear::m_weights
protected