PerElementScaleComponent Class Reference

PerElementScaleComponent scales each dimension of its input with a separate trainable scale; it's like a linear component with a diagonal matrix. More...

#include <nnet-simple-component.h>

Inheritance diagram for PerElementScaleComponent:
Collaboration diagram for PerElementScaleComponent:

Public Member Functions

virtual int32 InputDim () const
 Returns input-dimension of this component. More...
 
virtual int32 OutputDim () const
 Returns output-dimension of this component. More...
 
virtual std::string Info () const
 Returns some text-form information about this component, for diagnostics. More...
 
virtual void InitFromConfig (ConfigLine *cfl)
 Initialize, from a ConfigLine object. More...
 
 PerElementScaleComponent ()
 
virtual std::string Type () const
 Returns a string such as "SigmoidComponent", describing the type of the object. More...
 
virtual int32 Properties () const
 Return bitmask of the component's properties. 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 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...
 
virtual ComponentCopy () const
 Copies component (deep copy). 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 PerturbParams (BaseFloat stddev)
 This function is to be used in testing. More...
 
virtual BaseFloat DotProduct (const UpdatableComponent &other) const
 Computes dot-product between parameters of two instances of a Component. More...
 
virtual int32 NumParameters () const
 The following new virtual function returns the total dimension of the parameters in this class. More...
 
virtual void Vectorize (VectorBase< BaseFloat > *params) const
 Turns the parameters into vector form. More...
 
virtual void UnVectorize (const VectorBase< BaseFloat > &params)
 Converts the parameters from vector form. More...
 
 PerElementScaleComponent (const PerElementScaleComponent &other)
 
void Init (int32 dim, BaseFloat param_mean, BaseFloat param_stddev)
 
void Init (std::string vector_filename)
 
- Public Member Functions inherited from UpdatableComponent
 UpdatableComponent (const UpdatableComponent &other)
 
 UpdatableComponent ()
 
virtual ~UpdatableComponent ()
 
virtual void SetUnderlyingLearningRate (BaseFloat lrate)
 Sets the learning rate of gradient descent- gets multiplied by learning_rate_factor_. More...
 
virtual void SetActualLearningRate (BaseFloat lrate)
 Sets the learning rate directly, bypassing learning_rate_factor_. More...
 
virtual void SetAsGradient ()
 Sets is_gradient_ to true and sets learning_rate_ to 1, ignoring learning_rate_factor_. More...
 
virtual BaseFloat LearningRateFactor ()
 
virtual void SetLearningRateFactor (BaseFloat lrate_factor)
 
void SetUpdatableConfigs (const UpdatableComponent &other)
 
virtual void FreezeNaturalGradient (bool freeze)
 freezes/unfreezes NaturalGradient updates, if applicable (to be overriden by components that use Natural Gradient). More...
 
BaseFloat LearningRate () const
 Gets the learning rate to be used in gradient descent. More...
 
BaseFloat MaxChange () const
 Returns the per-component max-change value, which is interpreted as the maximum change (in l2 norm) in parameters that is allowed per minibatch for this component. More...
 
void SetMaxChange (BaseFloat max_change)
 
BaseFloat L2Regularization () const
 Returns the l2 regularization constant, which may be set in any updatable component (usually from the config file). More...
 
void SetL2Regularization (BaseFloat a)
 
- 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 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

virtual void Update (const std::string &debug_info, const CuMatrixBase< BaseFloat > &in_value, const CuMatrixBase< BaseFloat > &out_deriv)
 
virtual void UpdateSimple (const CuMatrixBase< BaseFloat > &in_value, const CuMatrixBase< BaseFloat > &out_deriv)
 
const PerElementScaleComponentoperator= (const PerElementScaleComponent &other)
 
- Protected Member Functions inherited from UpdatableComponent
void InitLearningRatesFromConfig (ConfigLine *cfl)
 
std::string ReadUpdatableCommon (std::istream &is, bool binary)
 
void WriteUpdatableCommon (std::ostream &is, bool binary) const
 

Protected Attributes

CuVector< BaseFloatscales_
 
- Protected Attributes inherited from UpdatableComponent
BaseFloat learning_rate_
 learning rate (typically 0.0..0.01) More...
 
BaseFloat learning_rate_factor_
 learning rate factor (normally 1.0, but can be set to another < value so that when < you call SetLearningRate(), that value will be scaled by this factor. More...
 
BaseFloat l2_regularize_
 L2 regularization constant. More...
 
bool is_gradient_
 True if this component is to be treated as a gradient rather than as parameters. More...
 
BaseFloat max_change_
 configuration value for imposing max-change More...
 

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

PerElementScaleComponent scales each dimension of its input with a separate trainable scale; it's like a linear component with a diagonal matrix.

This version (and its child class NaturalGradientPerElementScaleComponent) requires the input for backprop. See also ScaleAndOffsetComponent.

Accepted values on its config line, with defaults if applicable:

vector If specified, the offsets will be read from this file ('vector' is interpreted as an rxfilename).

dim The dimension that this component inputs and outputs. Only required if 'vector' is not specified.

param-mean=1.0 Mean of randomly initialized offset parameters; should only be supplied if 'vector' is not supplied. param-stddev=0.0 Standard deviation of randomly initialized offset parameters; should only be supplied if 'vector' is not supplied.

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

Constructor & Destructor Documentation

◆ PerElementScaleComponent() [1/2]

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

Referenced by PerElementScaleComponent::Copy().

1521 { } // use Init to really initialize.

◆ PerElementScaleComponent() [2/2]

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

1963  :
1964  UpdatableComponent(component),
1965  scales_(component.scales_) { }

Member Function Documentation

◆ Add()

void Add ( BaseFloat  alpha,
const Component other 
)
virtual

This virtual function when called by – an UpdatableComponent adds the parameters of another updatable component, times some constant, to the current parameters.

– a NonlinearComponent (or another component that stores stats, like BatchNormComponent)– it relates to adding stats. Otherwise it will normally do nothing.

Reimplemented from Component.

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

References KALDI_ASSERT, and PerElementScaleComponent::scales_.

Referenced by CompositeComponent::Add().

1955  {
1956  const PerElementScaleComponent *other =
1957  dynamic_cast<const PerElementScaleComponent*>(&other_in);
1958  KALDI_ASSERT(other != NULL);
1959  scales_.AddVec(alpha, other->scales_);
1960 }
#define KALDI_ASSERT(cond)
Definition: kaldi-error.h:185

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

References CuMatrixBase< Real >::CopyFromMat(), CuMatrixBase< Real >::Data(), UpdatableComponent::is_gradient_, CuMatrixBase< Real >::MulColsVec(), NVTX_RANGE, PerElementScaleComponent::scales_, PerElementScaleComponent::Update(), and PerElementScaleComponent::UpdateSimple().

Referenced by CompositeComponent::Backprop().

2056  {
2057  NVTX_RANGE("PerElementScaleComponent::Backprop");
2058  PerElementScaleComponent *to_update =
2059  dynamic_cast<PerElementScaleComponent*>(to_update_in);
2060 
2061  if (to_update != NULL) {
2062  // Next update the model (must do this 2nd so the derivatives we propagate
2063  // are accurate, in case this == to_update_in.)
2064  if (to_update->is_gradient_)
2065  to_update->UpdateSimple(in_value, out_deriv);
2066  else // the call below is to a virtual function that may be re-implemented
2067  to_update->Update(debug_info, in_value, out_deriv); // by child classes.
2068  }
2069 
2070  if (in_deriv) {
2071  // Propagate the derivative back to the input.
2072  if (in_deriv->Data() != out_deriv.Data())
2073  in_deriv->CopyFromMat(out_deriv);
2074  in_deriv->MulColsVec(scales_);
2075  }
2076 }
#define NVTX_RANGE(name)
Definition: cu-common.h:143

◆ Copy()

Component * Copy ( ) const
virtual

Copies component (deep copy).

Implements Component.

Reimplemented in NaturalGradientPerElementScaleComponent.

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

References PerElementScaleComponent::PerElementScaleComponent().

1982  {
1983  return new PerElementScaleComponent(*this);
1984 }

◆ DotProduct()

BaseFloat DotProduct ( const UpdatableComponent other) const
virtual

Computes dot-product between parameters of two instances of a Component.

Can be used for computing parameter-norm of an UpdatableComponent.

Implements UpdatableComponent.

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

References PerElementScaleComponent::scales_, and kaldi::VecVec().

1987  {
1988  const PerElementScaleComponent *other =
1989  dynamic_cast<const PerElementScaleComponent*>(&other_in);
1990  return VecVec(scales_, other->scales_);
1991 }
Real VecVec(const VectorBase< Real > &a, const VectorBase< Real > &b)
Returns dot product between v1 and v2.
Definition: kaldi-vector.cc:37

◆ 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 UpdatableComponent.

Reimplemented in NaturalGradientPerElementScaleComponent.

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

References UpdatableComponent::Info(), kaldi::nnet3::PrintParameterStats(), and PerElementScaleComponent::scales_.

Referenced by NaturalGradientPerElementScaleComponent::Info().

1973  {
1974  std::ostringstream stream;
1975  stream << UpdatableComponent::Info()
1976  << ", scales-min=" << scales_.Min()
1977  << ", scales-max=" << scales_.Max();
1978  PrintParameterStats(stream, "scales", scales_, true);
1979  return stream.str();
1980 }
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() [1/2]

void Init ( int32  dim,
BaseFloat  param_mean,
BaseFloat  param_stddev 
)

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

References KALDI_ASSERT, and PerElementScaleComponent::scales_.

Referenced by NaturalGradientPerElementScaleComponent::Init(), and PerElementScaleComponent::InitFromConfig().

1995  {
1996  KALDI_ASSERT(dim > 0 && param_stddev >= 0.0);
1997  scales_.Resize(dim);
1998  scales_.SetRandn();
1999  scales_.Scale(param_stddev);
2000  scales_.Add(param_mean);
2001 }
#define KALDI_ASSERT(cond)
Definition: kaldi-error.h:185

◆ Init() [2/2]

void Init ( std::string  vector_filename)

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

References CuVectorBase< Real >::Dim(), kaldi::ReadKaldiObject(), and PerElementScaleComponent::scales_.

2003  {
2004  CuVector<BaseFloat> vec;
2005  ReadKaldiObject(vector_filename, &vec); // will abort on failure.
2006  scales_.Resize(vec.Dim());
2007  scales_.CopyFromVec(vec);
2008 }
void ReadKaldiObject(const std::string &filename, Matrix< float > *m)
Definition: kaldi-io.cc:832

◆ 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.

Reimplemented in NaturalGradientPerElementScaleComponent.

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

References ConfigLine::GetValue(), ConfigLine::HasUnusedValues(), PerElementScaleComponent::Init(), UpdatableComponent::InitLearningRatesFromConfig(), PerElementScaleComponent::InputDim(), KALDI_ASSERT, KALDI_ERR, and ConfigLine::UnusedValues().

2010  {
2011  std::string vector_filename;
2012  int32 dim = -1;
2014  if (cfl->GetValue("vector", &vector_filename)) {
2015  Init(vector_filename);
2016  if (cfl->GetValue("dim", &dim))
2017  KALDI_ASSERT(dim == InputDim() &&
2018  "input-dim mismatch vs. vector.");
2019  } else {
2020  if(!cfl->GetValue("dim", &dim))
2021  KALDI_ERR << "'dim' not provided in the config line.";
2022  BaseFloat param_mean = 1.0, param_stddev = 0.0;
2023  cfl->GetValue("param-mean", &param_mean);
2024  cfl->GetValue("param-stddev", &param_stddev);
2025  Init(dim, param_mean, param_stddev);
2026  }
2027  if (cfl->HasUnusedValues())
2028  KALDI_ERR << "Could not process these elements in initializer: "
2029  << cfl->UnusedValues();
2030 }
void InitLearningRatesFromConfig(ConfigLine *cfl)
kaldi::int32 int32
float BaseFloat
Definition: kaldi-types.h:29
#define KALDI_ERR
Definition: kaldi-error.h:147
void Init(int32 dim, BaseFloat param_mean, BaseFloat param_stddev)
#define KALDI_ASSERT(cond)
Definition: kaldi-error.h:185
virtual int32 InputDim() const
Returns input-dimension of this component.

◆ InputDim()

virtual int32 InputDim ( ) const
inlinevirtual

◆ NumParameters()

int32 NumParameters ( ) const
virtual

The following new virtual function returns the total dimension of the parameters in this class.

Reimplemented from UpdatableComponent.

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

References PerElementScaleComponent::InputDim().

2098  {
2099  return InputDim();
2100 }
virtual int32 InputDim() const
Returns input-dimension of this component.

◆ operator=()

const PerElementScaleComponent& operator= ( const PerElementScaleComponent other)
protected

◆ OutputDim()

virtual int32 OutputDim ( ) const
inlinevirtual

Returns output-dimension of this component.

Implements Component.

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

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

Referenced by CompositeComponent::Backprop(), CompositeComponent::Init(), and CompositeComponent::Propagate().

1516 { return scales_.Dim(); }

◆ PerturbParams()

void PerturbParams ( BaseFloat  stddev)
virtual

This function is to be used in testing.

It adds unit noise times "stddev" to the parameters of the component.

Implements UpdatableComponent.

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

References kaldi::kUndefined, PerElementScaleComponent::scales_, and CuVectorBase< Real >::SetRandn().

1967  {
1968  CuVector<BaseFloat> temp_scales(scales_.Dim(), kUndefined);
1969  temp_scales.SetRandn();
1970  scales_.AddVec(stddev, temp_scales);
1971 }

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

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

Referenced by CompositeComponent::Propagate().

2035  {
2036  out->CopyFromMat(in);
2037  out->MulColsVec(scales_);
2038  return NULL;
2039 }

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

References Component::Add(), PnormComponent::Backprop(), PnormComponent::Copy(), kaldi::nnet3::DotProduct(), PnormComponent::Init(), kaldi::nnet3::kBackpropInPlace, kaldi::nnet3::kBackpropNeedsInput, kaldi::nnet3::kPropagateInPlace, kaldi::nnet3::kSimpleComponent, kaldi::nnet3::kUpdatableComponent, kaldi::nnet3::NumParameters(), kaldi::nnet3::PerturbParams(), PnormComponent::Propagate(), PnormComponent::Read(), Component::Scale(), and PnormComponent::Write().

Referenced by CompositeComponent::Backprop(), CompositeComponent::DotProduct(), CompositeComponent::FreezeNaturalGradient(), CompositeComponent::GetStrideType(), CompositeComponent::Init(), CompositeComponent::NumParameters(), CompositeComponent::PerturbParams(), CompositeComponent::SetActualLearningRate(), CompositeComponent::SetAsGradient(), CompositeComponent::SetUnderlyingLearningRate(), CompositeComponent::UnVectorize(), and CompositeComponent::Vectorize().

◆ 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.

Reimplemented in NaturalGradientPerElementScaleComponent.

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

References kaldi::nnet3::ExpectToken(), UpdatableComponent::is_gradient_, kaldi::PeekToken(), kaldi::ReadBasicType(), UpdatableComponent::ReadUpdatableCommon(), and PerElementScaleComponent::scales_.

2078  {
2079  ReadUpdatableCommon(is, binary); // Read opening tag and learning rate.
2080  ExpectToken(is, binary, "<Params>");
2081  scales_.Read(is, binary);
2082  if (PeekToken(is, binary) == 'I') {
2083  // for back compatibility; we don't write this here any
2084  // more as it's written and read in Write/ReadUpdatableCommon
2085  ExpectToken(is, binary, "<IsGradient>");
2086  ReadBasicType(is, binary, &is_gradient_);
2087  }
2088  ExpectToken(is, binary, "</PerElementScaleComponent>");
2089 }
void ReadBasicType(std::istream &is, bool binary, T *t)
ReadBasicType is the name of the read function for bool, integer types, and floating-point types...
Definition: io-funcs-inl.h:55
static void ExpectToken(const std::string &token, const std::string &what_we_are_parsing, const std::string **next_token)
std::string ReadUpdatableCommon(std::istream &is, bool binary)
int PeekToken(std::istream &is, bool binary)
PeekToken will return the first character of the next token, or -1 if end of file.
Definition: io-funcs.cc:170
bool is_gradient_
True if this component is to be treated as a gradient rather than as parameters.

◆ Scale()

void Scale ( BaseFloat  scale)
virtual

This virtual function when called on – an UpdatableComponent scales the parameters by "scale" when called by an UpdatableComponent.

– a Nonlinear component (or another component that stores stats, like BatchNormComponent)– it relates to scaling activation stats, not parameters. Otherwise it will normally do nothing.

Reimplemented from Component.

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

Referenced by CompositeComponent::Scale().

1946  {
1947  if (scale == 0.0) {
1948  scales_.SetZero();
1949  } else {
1950  scales_.Scale(scale);
1951  }
1952 }

◆ Type()

virtual std::string Type ( ) const
inlinevirtual

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

Implements Component.

Reimplemented in NaturalGradientPerElementScaleComponent.

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

1522 { return "PerElementScaleComponent"; }

◆ UnVectorize()

void UnVectorize ( const VectorBase< BaseFloat > &  params)
virtual

Converts the parameters from vector form.

Reimplemented from UpdatableComponent.

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

References PerElementScaleComponent::scales_.

2107  {
2108  scales_.CopyFromVec(params);
2109 }

◆ Update()

virtual void Update ( const std::string &  debug_info,
const CuMatrixBase< BaseFloat > &  in_value,
const CuMatrixBase< BaseFloat > &  out_deriv 
)
inlineprotectedvirtual

Reimplemented in NaturalGradientPerElementScaleComponent.

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

Referenced by PerElementScaleComponent::Backprop().

1567  {
1568  UpdateSimple(in_value, out_deriv);
1569  }
virtual void UpdateSimple(const CuMatrixBase< BaseFloat > &in_value, const CuMatrixBase< BaseFloat > &out_deriv)

◆ UpdateSimple()

void UpdateSimple ( const CuMatrixBase< BaseFloat > &  in_value,
const CuMatrixBase< BaseFloat > &  out_deriv 
)
protectedvirtual

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

References kaldi::kNoTrans, kaldi::kTrans, UpdatableComponent::learning_rate_, and PerElementScaleComponent::scales_.

Referenced by PerElementScaleComponent::Backprop().

2043  {
2044  scales_.AddDiagMatMat(learning_rate_, out_deriv, kTrans,
2045  in_value, kNoTrans, 1.0);
2046 }
BaseFloat learning_rate_
learning rate (typically 0.0..0.01)

◆ Vectorize()

void Vectorize ( VectorBase< BaseFloat > *  params) const
virtual

Turns the parameters into vector form.

We put the vector form on the CPU, because in the kinds of situations where we do this, we'll tend to use too much memory for the GPU.

Reimplemented from UpdatableComponent.

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

References VectorBase< Real >::CopyFromVec(), and PerElementScaleComponent::scales_.

2102  {
2103  params->CopyFromVec(scales_);
2104 }

◆ Write()

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

Write component to stream.

Implements Component.

Reimplemented in NaturalGradientPerElementScaleComponent.

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

References PerElementScaleComponent::scales_, kaldi::WriteToken(), and UpdatableComponent::WriteUpdatableCommon().

2091  {
2092  WriteUpdatableCommon(os, binary); // Write opening tag and learning rate.
2093  WriteToken(os, binary, "<Params>");
2094  scales_.Write(os, binary);
2095  WriteToken(os, binary, "</PerElementScaleComponent>");
2096 }
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
void WriteUpdatableCommon(std::ostream &is, bool binary) const

Member Data Documentation

◆ scales_


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