FixedScaleComponent Class Reference

FixedScaleComponent applies a fixed per-element scale; it's similar to the Rescale component in the nnet1 setup (and only needed for nnet1 model conversion). More...

#include <nnet-simple-component.h>

Inheritance diagram for FixedScaleComponent:
Collaboration diagram for FixedScaleComponent:

Public Member Functions

 FixedScaleComponent ()
 
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...
 
virtual int32 Properties () const
 Return bitmask of the component's properties. More...
 
void Init (const CuVectorBase< BaseFloat > &scales)
 
virtual void InitFromConfig (ConfigLine *cfl)
 Initialize, from a ConfigLine object. 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 > &, const CuMatrixBase< BaseFloat > &, const CuMatrixBase< BaseFloat > &out_deriv, void *memo, Component *, 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 CuVector< BaseFloat > & Scales () 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...
 
 Component ()
 
virtual ~Component ()
 

Protected Member Functions

 KALDI_DISALLOW_COPY_AND_ASSIGN (FixedScaleComponent)
 

Protected Attributes

CuVector< BaseFloatscales_
 

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

FixedScaleComponent applies a fixed per-element scale; it's similar to the Rescale component in the nnet1 setup (and only needed for nnet1 model conversion).

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

Constructor & Destructor Documentation

◆ FixedScaleComponent()

FixedScaleComponent ( )
inline

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

1091 { }

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 3644 of file nnet-simple-component.cc.

References CuMatrixBase< Real >::CopyFromMat(), and CuMatrixBase< Real >::MulColsVec().

3651  {
3652  in_deriv->CopyFromMat(out_deriv); // does nothing if same memory.
3653  in_deriv->MulColsVec(scales_);
3654 }
void CopyFromMat(const MatrixBase< OtherReal > &src, MatrixTransposeType trans=kNoTrans)
Definition: cu-matrix.cc:339
void MulColsVec(const CuVectorBase< Real > &scale)
scale i&#39;th column by scale[i]
Definition: cu-matrix.cc:752

◆ Copy()

Component * Copy ( ) const
virtual

Copies component (deep copy).

Implements Component.

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

References FixedScaleComponent::scales_.

3656  {
3658  ans->scales_ = scales_;
3659  return ans;
3660 }

◆ 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 3629 of file nnet-simple-component.cc.

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

3629  {
3630  std::ostringstream stream;
3631  stream << Component::Info();
3632  PrintParameterStats(stream, "scales", scales_, true);
3633  return stream.str();
3634 }
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:530

◆ Init()

void Init ( const CuVectorBase< BaseFloat > &  scales)

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

References CuVectorBase< Real >::Dim(), and KALDI_ASSERT.

3594  {
3595  KALDI_ASSERT(scales.Dim() != 0);
3596  scales_ = scales;
3597 }
#define KALDI_ASSERT(cond)
Definition: kaldi-error.h:169
MatrixIndexT Dim() const
Dimensions.
Definition: cu-vector.h:68

◆ 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 3600 of file nnet-simple-component.cc.

References ConfigLine::GetValue(), ConfigLine::HasUnusedValues(), FixedAffineComponent::Init(), KALDI_ASSERT, KALDI_ERR, kaldi::ReadKaldiObject(), CuVectorBase< Real >::Set(), CuVectorBase< Real >::SetRandn(), FixedAffineComponent::Type(), and ConfigLine::WholeLine().

3600  {
3601  std::string filename;
3602  // Accepts "scales" config (for filename) or "dim" -> random init, for testing.
3603  if (cfl->GetValue("scales", &filename)) {
3604  if (cfl->HasUnusedValues())
3605  KALDI_ERR << "Invalid initializer for layer of type "
3606  << Type() << ": \"" << cfl->WholeLine() << "\"";
3607  CuVector<BaseFloat> vec;
3608  ReadKaldiObject(filename, &vec);
3609  Init(vec);
3610  } else {
3611  int32 dim;
3612  BaseFloat scale = 1.0;
3613  bool scale_is_set = cfl->GetValue("scale", &scale);
3614  if (!cfl->GetValue("dim", &dim) || cfl->HasUnusedValues())
3615  KALDI_ERR << "Invalid initializer for layer of type "
3616  << Type() << ": \"" << cfl->WholeLine() << "\"";
3617  KALDI_ASSERT(dim > 0);
3618  CuVector<BaseFloat> vec(dim);
3619  if (scale_is_set) {
3620  vec.Set(scale);
3621  } else {
3622  vec.SetRandn();
3623  }
3624  Init(vec);
3625  }
3626 }
void ReadKaldiObject(const std::string &filename, Matrix< float > *m)
Definition: kaldi-io.cc:832
float BaseFloat
Definition: kaldi-types.h:29
void Init(const CuVectorBase< BaseFloat > &scales)
#define KALDI_ERR
Definition: kaldi-error.h:127
virtual std::string Type() const
Returns a string such as "SigmoidComponent", describing the type of the object.
#define KALDI_ASSERT(cond)
Definition: kaldi-error.h:169

◆ InputDim()

virtual int32 InputDim ( ) const
inlinevirtual

Returns input-dimension of this component.

Implements Component.

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

Referenced by ModelCollapser::CollapseComponentsScale().

1104 { return scales_.Dim(); }
MatrixIndexT Dim() const
Dimensions.
Definition: cu-vector.h:68

◆ KALDI_DISALLOW_COPY_AND_ASSIGN()

KALDI_DISALLOW_COPY_AND_ASSIGN ( FixedScaleComponent  )
protected

◆ OutputDim()

virtual int32 OutputDim ( ) const
inlinevirtual

Returns output-dimension of this component.

Implements Component.

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

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

1105 { return scales_.Dim(); }
MatrixIndexT Dim() const
Dimensions.
Definition: cu-vector.h:68

◆ 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 3636 of file nnet-simple-component.cc.

References CuMatrixBase< Real >::CopyFromMat(), and CuMatrixBase< Real >::MulColsVec().

3638  {
3639  out->CopyFromMat(in); // does nothing if same matrix.
3640  out->MulColsVec(scales_);
3641  return NULL;
3642 }
void CopyFromMat(const MatrixBase< OtherReal > &src, MatrixTransposeType trans=kNoTrans)
Definition: cu-matrix.cc:339
void MulColsVec(const CuVectorBase< Real > &scale)
scale i&#39;th column by scale[i]
Definition: cu-matrix.cc:752

◆ 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 1094 of file nnet-simple-component.h.

References PnormComponent::Init(), PnormComponent::InitFromConfig(), kaldi::nnet3::kBackpropInPlace, kaldi::nnet3::kPropagateInPlace, 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 3670 of file nnet-simple-component.cc.

References kaldi::nnet3::ExpectOneOrTwoTokens(), and kaldi::nnet3::ExpectToken().

3670  {
3671  ExpectOneOrTwoTokens(is, binary, "<FixedScaleComponent>", "<Scales>");
3672  scales_.Read(is, binary);
3673  ExpectToken(is, binary, "</FixedScaleComponent>");
3674 }
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: nnet-parse.cc:224
static void ExpectToken(const std::string &token, const std::string &what_we_are_parsing, const std::string **next_token)
void Read(std::istream &is, bool binary)
I/O.
Definition: cu-vector.cc:911

◆ Scales()

const CuVector<BaseFloat>& Scales ( ) const
inline

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

Referenced by ModelCollapser::CollapseComponentsScale().

1122 { return scales_; }

◆ Type()

virtual std::string Type ( ) const
inlinevirtual

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

Implements Component.

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

References Component::Info().

1092 { return "FixedScaleComponent"; }

◆ Write()

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

Write component to stream.

Implements Component.

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

References kaldi::WriteToken().

3663  {
3664  WriteToken(os, binary, "<FixedScaleComponent>");
3665  WriteToken(os, binary, "<Scales>");
3666  scales_.Write(os, binary);
3667  WriteToken(os, binary, "</FixedScaleComponent>");
3668 }
void Write(std::ostream &is, bool binary) const
Definition: cu-vector.cc:921
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

Member Data Documentation

◆ scales_

CuVector<BaseFloat> scales_
protected

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

Referenced by FixedScaleComponent::Copy().


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