PerElementOffsetComponent Class Reference

#include <nnet-simple-component.h>

Inheritance diagram for PerElementOffsetComponent:
Collaboration diagram for PerElementOffsetComponent:

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...
 
 PerElementOffsetComponent ()
 
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 > &, 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...
 
 PerElementOffsetComponent (const PerElementOffsetComponent &other)
 
- 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

const PerElementOffsetComponentoperator= (const PerElementOffsetComponent &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< BaseFloatoffsets_
 
int32 dim_
 
bool use_natural_gradient_
 
OnlineNaturalGradient preconditioner_
 
- 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

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

Constructor & Destructor Documentation

◆ PerElementOffsetComponent() [1/2]

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

Referenced by PerElementOffsetComponent::Copy().

1623 { } // use Init to really initialize.

◆ PerElementOffsetComponent() [2/2]

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

2129  :
2130  UpdatableComponent(component),
2131  offsets_(component.offsets_),
2132  dim_(component.dim_),
2133  use_natural_gradient_(component.use_natural_gradient_),
2134  preconditioner_(component.preconditioner_) { }

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

References KALDI_ASSERT, and PerElementOffsetComponent::offsets_.

2121  {
2122  const PerElementOffsetComponent *other =
2123  dynamic_cast<const PerElementOffsetComponent*>(&other_in);
2124  KALDI_ASSERT(other != NULL);
2125  offsets_.AddVec(alpha, other->offsets_);
2126 }
#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 2222 of file nnet-simple-component.cc.

References CuMatrixBase< Real >::CopyFromMat(), CuMatrixBase< Real >::Data(), PerElementOffsetComponent::dim_, UpdatableComponent::is_gradient_, KALDI_ASSERT, KALDI_LOG, UpdatableComponent::learning_rate_, CuMatrixBase< Real >::NumCols(), CuMatrixBase< Real >::NumRows(), NVTX_RANGE, PerElementOffsetComponent::offsets_, OnlineNaturalGradient::PreconditionDirections(), PerElementOffsetComponent::preconditioner_, CuMatrixBase< Real >::Stride(), and PerElementOffsetComponent::use_natural_gradient_.

2230  {
2231  NVTX_RANGE("PerElementOffsetComponent::Backprop");
2232  PerElementOffsetComponent *to_update =
2233  dynamic_cast<PerElementOffsetComponent*>(to_update_in);
2234 
2235  if (in_deriv && in_deriv->Data() != out_deriv.Data()) {
2236  // Propagate the derivative back to the input.
2237  in_deriv->CopyFromMat(out_deriv);
2238  }
2239 
2240  if (to_update != NULL) {
2241  // we may have to reshape out_deriv, if "block-dim" was set
2242  // in the config file when initializing the object, leading
2243  // to dim_ being a multiple >1 of offset_.Dim().
2244  // To avoid having separate code paths we create a sub-matrix
2245  // in any case, but this may just be a copy of out_deriv.
2246  int32 block_dim = offsets_.Dim(), multiple = dim_ / block_dim,
2247  block_stride = (multiple == 1 ? out_deriv.Stride() : block_dim),
2248  num_rows = out_deriv.NumRows() * multiple;
2249  KALDI_ASSERT(multiple == 1 || out_deriv.Stride() == out_deriv.NumCols());
2250  CuSubMatrix<BaseFloat> out_deriv_reshaped(out_deriv.Data(), num_rows,
2251  block_dim, block_stride);
2252  if (!to_update->use_natural_gradient_ || to_update->is_gradient_) {
2253  KALDI_LOG << "Using non-NG update, lr = " << to_update->learning_rate_;
2254  to_update->offsets_.AddRowSumMat(to_update->learning_rate_,
2255  out_deriv_reshaped);
2256  } else {
2257  KALDI_LOG << "Using NG update, lr = " << to_update->learning_rate_;
2258  // make a copy as we don't want to modify the data of 'out_deriv', which
2259  // was const (even though CuSubMatrix does not respect const-ness in
2260  // this scenario)
2261  CuMatrix<BaseFloat> out_deriv_copy(out_deriv_reshaped);
2262  BaseFloat scale = 1.0;
2263  to_update->preconditioner_.PreconditionDirections(&out_deriv_copy,
2264  &scale);
2265  to_update->offsets_.AddRowSumMat(scale * to_update->learning_rate_,
2266  out_deriv_copy);
2267  }
2268  }
2269 }
kaldi::int32 int32
float BaseFloat
Definition: kaldi-types.h:29
#define KALDI_ASSERT(cond)
Definition: kaldi-error.h:185
#define NVTX_RANGE(name)
Definition: cu-common.h:143
#define KALDI_LOG
Definition: kaldi-error.h:153

◆ Copy()

Component * Copy ( ) const
virtual

Copies component (deep copy).

Implements Component.

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

References PerElementOffsetComponent::PerElementOffsetComponent().

2154  {
2155  return new PerElementOffsetComponent(*this);
2156 }

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

References PerElementOffsetComponent::offsets_, and kaldi::VecVec().

2159  {
2160  const PerElementOffsetComponent *other =
2161  dynamic_cast<const PerElementOffsetComponent*>(&other_in);
2162  return VecVec(offsets_, other->offsets_);
2163 }
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.

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

References UpdatableComponent::Info(), PerElementOffsetComponent::offsets_, kaldi::nnet3::PrintParameterStats(), and PerElementOffsetComponent::use_natural_gradient_.

2142  {
2143  std::ostringstream stream;
2144  stream << UpdatableComponent::Info()
2145  << ", offsets-min=" << offsets_.Min()
2146  << ", offsets-max=" << offsets_.Max()
2147  << ", block-dim=" << offsets_.Dim()
2148  << ", use-natural-gradient="
2149  << (use_natural_gradient_ ? "true" : "false");
2150  PrintParameterStats(stream, "offsets", offsets_, true);
2151  return stream.str();
2152 }
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

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

References PerElementOffsetComponent::dim_, ConfigLine::GetValue(), ConfigLine::HasUnusedValues(), UpdatableComponent::InitLearningRatesFromConfig(), KALDI_ERR, PerElementOffsetComponent::offsets_, PerElementOffsetComponent::preconditioner_, kaldi::ReadKaldiObject(), OnlineNaturalGradient::SetRank(), OnlineNaturalGradient::SetUpdatePeriod(), ConfigLine::UnusedValues(), and PerElementOffsetComponent::use_natural_gradient_.

2166  {
2167  std::string vector_filename;
2169  if (cfl->GetValue("vector", &vector_filename)) {
2170  ReadKaldiObject(vector_filename, &offsets_);
2171  dim_ = offsets_.Dim(); // if dim is not supplied, it defaults to this.
2172  cfl->GetValue("dim", &dim_);
2173  if (dim_ <= 0 || offsets_.Dim() % dim_ != 0)
2174  KALDI_ERR << "Invalid dimension dim=" << dim_;
2175  } else {
2176  if(!cfl->GetValue("dim", &dim_))
2177  KALDI_ERR << "'dim' not provided in the config line.";
2178  if (dim_ <= 0)
2179  KALDI_ERR << "Invalid dimension dim=" << dim_;
2180  BaseFloat param_mean = 0.0, param_stddev = 0.0;
2181  cfl->GetValue("param-mean", &param_mean);
2182  cfl->GetValue("param-stddev", &param_stddev);
2183  int32 block_dim = dim_;
2184  cfl->GetValue("block-dim", &block_dim);
2185  if (block_dim <= 0 || dim_ % block_dim != 0)
2186  KALDI_ERR << "Invalid value block-dim=" << block_dim;
2187  offsets_.Resize(block_dim);
2188  offsets_.SetRandn();
2189  offsets_.Scale(param_stddev);
2190  offsets_.Add(param_mean);
2191  }
2192  use_natural_gradient_ = true;
2193  cfl->GetValue("use-natural-gradient", &use_natural_gradient_);
2194  if (cfl->HasUnusedValues())
2195  KALDI_ERR << "Could not process these elements in initializer: "
2196  << cfl->UnusedValues();
2197  // For now you can't modify these defaults of the natural gradient.
2198  // This code must be kept in sync with the code in Read().
2201 }
void InitLearningRatesFromConfig(ConfigLine *cfl)
kaldi::int32 int32
void ReadKaldiObject(const std::string &filename, Matrix< float > *m)
Definition: kaldi-io.cc:832
float BaseFloat
Definition: kaldi-types.h:29
#define KALDI_ERR
Definition: kaldi-error.h:147

◆ InputDim()

virtual int32 InputDim ( ) const
inlinevirtual

Returns input-dimension of this component.

Implements Component.

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

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

References PerElementOffsetComponent::offsets_.

2308  {
2309  return offsets_.Dim();
2310 }

◆ operator=()

const PerElementOffsetComponent& operator= ( const PerElementOffsetComponent other)
protected

◆ OutputDim()

virtual int32 OutputDim ( ) const
inlinevirtual

Returns output-dimension of this component.

Implements Component.

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

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

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

References kaldi::kUndefined, PerElementOffsetComponent::offsets_, and CuVectorBase< Real >::SetRandn().

2136  {
2137  CuVector<BaseFloat> temp_offsets(offsets_.Dim(), kUndefined);
2138  temp_offsets.SetRandn();
2139  offsets_.AddVec(stddev, temp_offsets);
2140 }

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

References CuMatrixBase< Real >::AddVecToRows(), CuMatrixBase< Real >::CopyFromMat(), CuMatrixBase< Real >::Data(), PerElementOffsetComponent::dim_, KALDI_ASSERT, CuMatrixBase< Real >::NumCols(), CuMatrixBase< Real >::NumRows(), PerElementOffsetComponent::offsets_, and CuMatrixBase< Real >::Stride().

2206  {
2207  if (in.Data() != out->Data())
2208  out->CopyFromMat(in);
2209  if (dim_ == offsets_.Dim()) {
2210  out->AddVecToRows(1.0, offsets_);
2211  } else {
2212  KALDI_ASSERT(out->Stride() == out->NumCols());
2213  int32 block_dim = offsets_.Dim(), multiple = dim_ / block_dim,
2214  num_rows = out->NumRows() * multiple;
2215  CuSubMatrix<BaseFloat> out_rearranged(out->Data(), num_rows,
2216  block_dim, block_dim);
2217  out_rearranged.AddVecToRows(1.0, offsets_);
2218  }
2219  return NULL;
2220 }
kaldi::int32 int32
#define KALDI_ASSERT(cond)
Definition: kaldi-error.h:185

◆ Properties()

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

References PerElementOffsetComponent::dim_, kaldi::nnet3::ExpectToken(), UpdatableComponent::is_gradient_, PerElementOffsetComponent::offsets_, kaldi::PeekToken(), PerElementOffsetComponent::preconditioner_, kaldi::ReadBasicType(), UpdatableComponent::ReadUpdatableCommon(), OnlineNaturalGradient::SetRank(), OnlineNaturalGradient::SetUpdatePeriod(), and PerElementOffsetComponent::use_natural_gradient_.

2271  {
2272  ReadUpdatableCommon(is, binary); // Read opening tag and learning rate
2273  ExpectToken(is, binary, "<Offsets>");
2274  offsets_.Read(is, binary);
2275  if (PeekToken(is, binary) == 'I') {
2276  // for back compatibility; we don't write this here any
2277  // more as it's written and read in Write/ReadUpdatableCommon
2278  ExpectToken(is, binary, "<IsGradient>");
2279  ReadBasicType(is, binary, &is_gradient_);
2280  }
2281  if (PeekToken(is, binary) != '/') {
2282  ExpectToken(is, binary, "<Dim>");
2283  ReadBasicType(is, binary, &dim_);
2284  ExpectToken(is, binary, "<UseNaturalGradient>");
2285  ReadBasicType(is, binary, &use_natural_gradient_);
2286  } else {
2287  dim_ = offsets_.Dim();
2288  use_natural_gradient_ = true;
2289  }
2290  // For now you can't modify these defaults of the natural gradient.
2291  // This code must be kept in sync with the code in InitFromConfig().
2294  ExpectToken(is, binary, "</PerElementOffsetComponent>");
2295 }
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 2111 of file nnet-simple-component.cc.

2111  {
2112  if (scale == 0.0) {
2113  offsets_.SetZero();
2114  } else {
2115  offsets_.Scale(scale);
2116  }
2117 }

◆ Type()

virtual std::string Type ( ) const
inlinevirtual

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

Implements Component.

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

1624 { return "PerElementOffsetComponent"; }

◆ UnVectorize()

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

Converts the parameters from vector form.

Reimplemented from UpdatableComponent.

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

References PerElementOffsetComponent::offsets_.

2317  {
2318  offsets_.CopyFromVec(params);
2319 }

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

References VectorBase< Real >::CopyFromVec(), and PerElementOffsetComponent::offsets_.

2312  {
2313  params->CopyFromVec(offsets_);
2314 }

◆ Write()

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

Write component to stream.

Implements Component.

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

References PerElementOffsetComponent::dim_, PerElementOffsetComponent::offsets_, PerElementOffsetComponent::use_natural_gradient_, kaldi::WriteBasicType(), kaldi::WriteToken(), and UpdatableComponent::WriteUpdatableCommon().

2297  {
2298  WriteUpdatableCommon(os, binary); // Write opening tag and learning rate
2299  WriteToken(os, binary, "<Offsets>");
2300  offsets_.Write(os, binary);
2301  WriteToken(os, binary, "<Dim>");
2302  WriteBasicType(os, binary, dim_);
2303  WriteToken(os, binary, "<UseNaturalGradient>");
2305  WriteToken(os, binary, "</PerElementOffsetComponent>");
2306 }
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
void WriteBasicType(std::ostream &os, bool binary, T t)
WriteBasicType is the name of the write function for bool, integer types, and floating-point types...
Definition: io-funcs-inl.h:34

Member Data Documentation

◆ dim_

◆ offsets_

◆ preconditioner_

◆ use_natural_gradient_


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