FixedAffineComponent Class Reference

FixedAffineComponent is an affine transform that is supplied at network initialization time and is not trainable. More...

#include <nnet-simple-component.h>

Inheritance diagram for FixedAffineComponent:
Collaboration diagram for FixedAffineComponent:

Public Member Functions

 FixedAffineComponent ()
 
virtual std::string Type () const
 Returns a string such as "SigmoidComponent", describing the type of the object. More...
 
virtual std::string Info () const
 Returns some text-form information about this component, for diagnostics. More...
 
 FixedAffineComponent (const AffineComponent &c)
 
void Init (const CuMatrixBase< BaseFloat > &matrix)
 matrix should be of size input-dim+1 to output-dim, last col is offset More...
 
virtual void InitFromConfig (ConfigLine *cfl)
 Initialize, from a ConfigLine object. More...
 
virtual int32 Properties () const
 Return bitmask of the component's properties. More...
 
virtual int32 InputDim () const
 Returns input-dimension of this component. More...
 
virtual int32 OutputDim () const
 Returns output-dimension of this component. More...
 
virtual void * Propagate (const ComponentPrecomputedIndexes *indexes, const CuMatrixBase< BaseFloat > &in, CuMatrixBase< BaseFloat > *out) const
 Propagate function. More...
 
virtual void Backprop (const std::string &debug_info, const ComponentPrecomputedIndexes *indexes, const CuMatrixBase< BaseFloat > &in_value, const CuMatrixBase< BaseFloat > &, const CuMatrixBase< BaseFloat > &out_deriv, void *memo, Component *to_update, CuMatrixBase< BaseFloat > *in_deriv) const
 Backprop function; depending on which of the arguments 'to_update' and 'in_deriv' are non-NULL, this can compute input-data derivatives and/or perform model update. More...
 
virtual ComponentCopy () const
 Copies component (deep copy). More...
 
virtual void Read (std::istream &is, bool binary)
 Read function (used after we know the type of the Component); accepts input that is missing the token that describes the component type, in case it has already been consumed. More...
 
virtual void Write (std::ostream &os, bool binary) const
 Write component to stream. More...
 
const CuMatrix< BaseFloat > & LinearParams () const
 
const CuVector< BaseFloat > & BiasParams () const
 
- Public Member Functions inherited from Component
virtual void StoreStats (const CuMatrixBase< BaseFloat > &in_value, const CuMatrixBase< BaseFloat > &out_value, void *memo)
 This function may store stats on average activation values, and for some component types, the average value of the derivative of the nonlinearity. More...
 
virtual void ZeroStats ()
 Components that provide an implementation of StoreStats should also provide an implementation of ZeroStats(), to set those stats to zero. More...
 
virtual void GetInputIndexes (const MiscComputationInfo &misc_info, const Index &output_index, std::vector< Index > *desired_indexes) const
 This function only does something interesting for non-simple Components. More...
 
virtual bool IsComputable (const MiscComputationInfo &misc_info, const Index &output_index, const IndexSet &input_index_set, std::vector< Index > *used_inputs) const
 This function only does something interesting for non-simple Components, and it exists to make it possible to manage optionally-required inputs. More...
 
virtual void ReorderIndexes (std::vector< Index > *input_indexes, std::vector< Index > *output_indexes) const
 This function only does something interesting for non-simple Components. More...
 
virtual ComponentPrecomputedIndexesPrecomputeIndexes (const MiscComputationInfo &misc_info, const std::vector< Index > &input_indexes, const std::vector< Index > &output_indexes, bool need_backprop) const
 This function must return NULL for simple Components. More...
 
virtual void Scale (BaseFloat scale)
 This virtual function when called on – an UpdatableComponent scales the parameters by "scale" when called by an UpdatableComponent. More...
 
virtual void Add (BaseFloat alpha, const Component &other)
 This virtual function when called by – an UpdatableComponent adds the parameters of another updatable component, times some constant, to the current parameters. More...
 
virtual void DeleteMemo (void *memo) const
 This virtual function only needs to be overwritten by Components that return a non-NULL memo from their Propagate() function. More...
 
virtual void ConsolidateMemory ()
 This virtual function relates to memory management, and avoiding fragmentation. More...
 
 Component ()
 
virtual ~Component ()
 

Protected Member Functions

 KALDI_DISALLOW_COPY_AND_ASSIGN (FixedAffineComponent)
 

Protected Attributes

CuMatrix< BaseFloatlinear_params_
 
CuVector< BaseFloatbias_params_
 

Friends

class AffineComponent
 

Additional Inherited Members

- Static Public Member Functions inherited from Component
static ComponentReadNew (std::istream &is, bool binary)
 Read component from stream (works out its type). Dies on error. More...
 
static ComponentNewComponentOfType (const std::string &type)
 Returns a new Component of the given type e.g. More...
 

Detailed Description

FixedAffineComponent is an affine transform that is supplied at network initialization time and is not trainable.

Definition at line 992 of file nnet-simple-component.h.

Constructor & Destructor Documentation

◆ FixedAffineComponent() [1/2]

Definition at line 994 of file nnet-simple-component.h.

Referenced by FixedAffineComponent::Copy().

994 { }

◆ FixedAffineComponent() [2/2]

Definition at line 3388 of file nnet-simple-component.cc.

3388  :
3389  linear_params_(c.LinearParams()),
3390  bias_params_(c.BiasParams()) { }

Member Function Documentation

◆ Backprop()

void Backprop ( const std::string &  debug_info,
const ComponentPrecomputedIndexes indexes,
const CuMatrixBase< BaseFloat > &  in_value,
const CuMatrixBase< BaseFloat > &  out_value,
const CuMatrixBase< BaseFloat > &  out_deriv,
void *  memo,
Component to_update,
CuMatrixBase< BaseFloat > *  in_deriv 
) const
virtual

Backprop function; depending on which of the arguments 'to_update' and 'in_deriv' are non-NULL, this can compute input-data derivatives and/or perform model update.

Parameters
[in]debug_infoThe component name, to be printed out in any warning messages.
[in]indexesA pointer to some information output by this class's PrecomputeIndexes function (will be NULL for simple components, i.e. those that don't do things like splicing).
[in]in_valueThe matrix that was given as input to the Propagate function. Will be ignored (and may be empty) if Properties()&kBackpropNeedsInput == 0.
[in]out_valueThe matrix that was output from the Propagate function. Will be ignored (and may be empty) if Properties()&kBackpropNeedsOutput == 0
[in]out_derivThe derivative at the output of this component.
[in]memoThis will normally be NULL, but for component types that set the flag kUsesMemo, this will be the return value of the Propagate() function that corresponds to this Backprop() function. Ownership of any pointers is not transferred to the Backprop function; DeleteMemo() will be called to delete it.
[out]to_updateIf model update is desired, the Component to be updated, else NULL. Does not have to be identical to this. If supplied, you can assume that to_update->Properties() & kUpdatableComponent is nonzero.
[out]in_derivThe derivative at the input of this component, if needed (else NULL). If Properties()&kBackpropInPlace, may be the same matrix as out_deriv. If Properties()&kBackpropAdds, this is added to by the Backprop routine, else it is set. The component code chooses which mode to work in, based on convenience.

Implements Component.

Definition at line 3400 of file nnet-simple-component.cc.

References CuMatrixBase< Real >::AddMatMat(), kaldi::kNoTrans, FixedAffineComponent::linear_params_, and NVTX_RANGE.

3407  {
3408  NVTX_RANGE("FixedAffineComponent::Backprop");
3409  // kBackpropAdds is true. It's the user's responsibility to zero out
3410  // <in_deriv> if they need it to be so.
3411  if (in_deriv)
3412  in_deriv->AddMatMat(1.0, out_deriv, kNoTrans,
3413  linear_params_, kNoTrans, 1.0);
3414 }
#define NVTX_RANGE(name)
Definition: cu-common.h:143

◆ BiasParams()

const CuVector<BaseFloat>& BiasParams ( ) const
inline

Definition at line 1032 of file nnet-simple-component.h.

Referenced by ModelCollapser::CollapseComponentsAffine().

1032 { return bias_params_; }

◆ Copy()

Component * Copy ( ) const
virtual

Copies component (deep copy).

Implements Component.

Definition at line 3416 of file nnet-simple-component.cc.

References FixedAffineComponent::bias_params_, FixedAffineComponent::FixedAffineComponent(), and FixedAffineComponent::linear_params_.

3416  {
3418  ans->linear_params_ = linear_params_;
3419  ans->bias_params_ = bias_params_;
3420  return ans;
3421 }

◆ Info()

std::string Info ( ) const
virtual

Returns some text-form information about this component, for diagnostics.

Starts with the type of the component. E.g. "SigmoidComponent dim=900", although most components will have much more info.

Reimplemented from Component.

Definition at line 3344 of file nnet-simple-component.cc.

References Component::Info(), and kaldi::nnet3::PrintParameterStats().

3344  {
3345  std::ostringstream stream;
3346  stream << Component::Info();
3347  PrintParameterStats(stream, "linear-params", linear_params_);
3348  PrintParameterStats(stream, "bias", bias_params_, true);
3349  return stream.str();
3350 }
virtual std::string Info() const
Returns some text-form information about this component, for diagnostics.
void PrintParameterStats(std::ostringstream &os, const std::string &name, const CuVectorBase< BaseFloat > &params, bool include_mean)
Print to &#39;os&#39; some information about the mean and standard deviation of some parameters, used in Info() functions in nnet-simple-component.cc.
Definition: nnet-parse.cc:157

◆ Init()

void Init ( const CuMatrixBase< BaseFloat > &  matrix)

matrix should be of size input-dim+1 to output-dim, last col is offset

Definition at line 3352 of file nnet-simple-component.cc.

References KALDI_ASSERT, CuMatrixBase< Real >::NumCols(), CuMatrixBase< Real >::NumRows(), and CuMatrixBase< Real >::Range().

Referenced by SumGroupComponent::InitFromConfig(), FixedScaleComponent::InitFromConfig(), FixedBiasComponent::InitFromConfig(), NaturalGradientPerElementScaleComponent::InitFromConfig(), and SumGroupComponent::Read().

3352  {
3353  KALDI_ASSERT(mat.NumCols() > 1);
3354  linear_params_ = mat.Range(0, mat.NumRows(), 0, mat.NumCols() - 1);
3355  bias_params_.Resize(mat.NumRows());
3356  bias_params_.CopyColFromMat(mat, mat.NumCols() - 1);
3357 }
#define KALDI_ASSERT(cond)
Definition: kaldi-error.h:185

◆ InitFromConfig()

void InitFromConfig ( ConfigLine cfl)
virtual

Initialize, from a ConfigLine object.

Parameters
[in]cflA ConfigLine containing any parameters that are needed for initialization. For example: "dim=100 param-stddev=0.1"

Implements Component.

Definition at line 3359 of file nnet-simple-component.cc.

References ConfigLine::GetValue(), ConfigLine::HasUnusedValues(), KALDI_ASSERT, KALDI_ERR, CuMatrixBase< Real >::NumRows(), CuMatrix< Real >::Read(), CuMatrixBase< Real >::SetRandn(), Input::Stream(), LinearComponent::Type(), and ConfigLine::WholeLine().

3359  {
3360  std::string filename;
3361  // Two forms allowed: "matrix=<rxfilename>", or "input-dim=x output-dim=y"
3362  // (for testing purposes only).
3363  if (cfl->GetValue("matrix", &filename)) {
3364  if (cfl->HasUnusedValues())
3365  KALDI_ERR << "Invalid initializer for layer of type "
3366  << Type() << ": \"" << cfl->WholeLine() << "\"";
3367 
3368  bool binary;
3369  Input ki(filename, &binary);
3370  CuMatrix<BaseFloat> mat;
3371  mat.Read(ki.Stream(), binary);
3372  KALDI_ASSERT(mat.NumRows() != 0);
3373  Init(mat);
3374  } else {
3375  int32 input_dim = -1, output_dim = -1;
3376  if (!cfl->GetValue("input-dim", &input_dim) ||
3377  !cfl->GetValue("output-dim", &output_dim) || cfl->HasUnusedValues()) {
3378  KALDI_ERR << "Invalid initializer for layer of type "
3379  << Type() << ": \"" << cfl->WholeLine() << "\"";
3380  }
3381  CuMatrix<BaseFloat> mat(output_dim, input_dim + 1);
3382  mat.SetRandn();
3383  Init(mat);
3384  }
3385 }
kaldi::int32 int32
#define KALDI_ERR
Definition: kaldi-error.h:147
void Init(const CuMatrixBase< BaseFloat > &matrix)
matrix should be of size input-dim+1 to output-dim, last col is offset
#define KALDI_ASSERT(cond)
Definition: kaldi-error.h:185
virtual std::string Type() const
Returns a string such as "SigmoidComponent", describing the type of the object.

◆ InputDim()

virtual int32 InputDim ( ) const
inlinevirtual

Returns input-dimension of this component.

Implements Component.

Definition at line 1011 of file nnet-simple-component.h.

Referenced by ModelCollapser::CollapseComponentsAffine().

1011 { return linear_params_.NumCols(); }

◆ KALDI_DISALLOW_COPY_AND_ASSIGN()

KALDI_DISALLOW_COPY_AND_ASSIGN ( FixedAffineComponent  )
protected

◆ LinearParams()

const CuMatrix<BaseFloat>& LinearParams ( ) const
inline

Definition at line 1031 of file nnet-simple-component.h.

Referenced by ModelCollapser::CollapseComponentsAffine().

1031 { return linear_params_; }

◆ OutputDim()

virtual int32 OutputDim ( ) const
inlinevirtual

Returns output-dimension of this component.

Implements Component.

Definition at line 1012 of file nnet-simple-component.h.

References PnormComponent::Backprop(), PnormComponent::Copy(), PnormComponent::Propagate(), PnormComponent::Read(), and PnormComponent::Write().

Referenced by ModelCollapser::CollapseComponentsAffine().

1012 { return linear_params_.NumRows(); }

◆ Propagate()

void * Propagate ( const ComponentPrecomputedIndexes indexes,
const CuMatrixBase< BaseFloat > &  in,
CuMatrixBase< BaseFloat > *  out 
) const
virtual

Propagate function.

Parameters
[in]indexesA pointer to some information output by this class's PrecomputeIndexes function (will be NULL for simple components, i.e. those that don't do things like splicing).
[in]inThe input to this component. Num-columns == InputDim().
[out]outThe output of this component. Num-columns == OutputDim(). Note: output of this component will be added to the initial value of "out" if Properties()&kPropagateAdds != 0; otherwise the output will be set and the initial value ignored. Each Component chooses whether it is more convenient implementation-wise to add or set, and the calling code has to deal with it.
Returns
Normally returns NULL, but may return a non-NULL value for components which have the flag kUsesMemo set. This value will be passed into the corresponding Backprop routine.

Implements Component.

Definition at line 3392 of file nnet-simple-component.cc.

References CuMatrixBase< Real >::AddMatMat(), FixedAffineComponent::bias_params_, CuMatrixBase< Real >::CopyRowsFromVec(), kaldi::kNoTrans, kaldi::kTrans, and FixedAffineComponent::linear_params_.

3394  {
3395  out->CopyRowsFromVec(bias_params_); // Adds the bias term first.
3396  out->AddMatMat(1.0, in, kNoTrans, linear_params_, kTrans, 1.0);
3397  return NULL;
3398 }

◆ Properties()

virtual int32 Properties ( ) const
inlinevirtual

Return bitmask of the component's properties.

These properties depend only on the component's type. See enum ComponentProperties.

Implements Component.

Definition at line 1010 of file nnet-simple-component.h.

References kaldi::nnet3::kBackpropAdds, and kaldi::nnet3::kSimpleComponent.

◆ Read()

void Read ( std::istream &  is,
bool  binary 
)
virtual

Read function (used after we know the type of the Component); accepts input that is missing the token that describes the component type, in case it has already been consumed.

Implements Component.

Definition at line 3432 of file nnet-simple-component.cc.

References FixedAffineComponent::bias_params_, kaldi::ExpectOneOrTwoTokens(), kaldi::nnet3::ExpectToken(), and FixedAffineComponent::linear_params_.

3432  {
3433  ExpectOneOrTwoTokens(is, binary, "<FixedAffineComponent>", "<LinearParams>");
3434  linear_params_.Read(is, binary);
3435  ExpectToken(is, binary, "<BiasParams>");
3436  bias_params_.Read(is, binary);
3437  ExpectToken(is, binary, "</FixedAffineComponent>");
3438 }
void ExpectOneOrTwoTokens(std::istream &is, bool binary, const std::string &token1, const std::string &token2)
This function is like ExpectToken but for two tokens, and it will either accept token1 and then token...
Definition: text-utils.cc:536
static void ExpectToken(const std::string &token, const std::string &what_we_are_parsing, const std::string **next_token)

◆ Type()

virtual std::string Type ( ) const
inlinevirtual

Returns a string such as "SigmoidComponent", describing the type of the object.

Implements Component.

Definition at line 995 of file nnet-simple-component.h.

References Component::Info(), PnormComponent::Init(), and PnormComponent::InitFromConfig().

Referenced by SumGroupComponent::InitFromConfig(), FixedScaleComponent::InitFromConfig(), FixedBiasComponent::InitFromConfig(), and NaturalGradientPerElementScaleComponent::InitFromConfig().

995 { return "FixedAffineComponent"; }

◆ Write()

void Write ( std::ostream &  os,
bool  binary 
) const
virtual

Write component to stream.

Implements Component.

Definition at line 3423 of file nnet-simple-component.cc.

References FixedAffineComponent::bias_params_, FixedAffineComponent::linear_params_, and kaldi::WriteToken().

3423  {
3424  WriteToken(os, binary, "<FixedAffineComponent>");
3425  WriteToken(os, binary, "<LinearParams>");
3426  linear_params_.Write(os, binary);
3427  WriteToken(os, binary, "<BiasParams>");
3428  bias_params_.Write(os, binary);
3429  WriteToken(os, binary, "</FixedAffineComponent>");
3430 }
void WriteToken(std::ostream &os, bool binary, const char *token)
The WriteToken functions are for writing nonempty sequences of non-space characters.
Definition: io-funcs.cc:134

Friends And Related Function Documentation

◆ AffineComponent

friend class AffineComponent
friend

Definition at line 1034 of file nnet-simple-component.h.

Member Data Documentation

◆ bias_params_

◆ linear_params_


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