All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
ConstantComponent Class Reference

#include <nnet-general-component.h>

Inheritance diagram for ConstantComponent:
Collaboration diagram for ConstantComponent:

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...
 
 ConstantComponent ()
 
 ConstantComponent (const ConstantComponent &other)
 
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 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 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...
 
- 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 ReorderIndexes (std::vector< Index > *input_indexes, std::vector< Index > *output_indexes) const
 This function only does something interesting for non-simple Components. More...
 
virtual
ComponentPrecomputedIndexes
PrecomputeIndexes (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...
 
 Component ()
 
virtual ~Component ()
 

Private Member Functions

const ConstantComponentoperator= (const ConstantComponent &other)
 

Private Attributes

CuVector< BaseFloatoutput_
 
bool is_updatable_
 
bool use_natural_gradient_
 
OnlineNaturalGradient preconditioner_
 

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

Detailed Description

Definition at line 615 of file nnet-general-component.h.

Constructor & Destructor Documentation

Definition at line 1218 of file nnet-general-component.cc.

1219  :
1220  UpdatableComponent(other), output_(other.output_),
1221  is_updatable_(other.is_updatable_),
1222  use_natural_gradient_(other.use_natural_gradient_),
1223  preconditioner_(other.preconditioner_) { }

Member Function Documentation

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 1332 of file nnet-general-component.cc.

References CuVectorBase< Real >::AddVec(), ConstantComponent::is_updatable_, KALDI_ASSERT, and ConstantComponent::output_.

1332  {
1333  if (is_updatable_) {
1334  const ConstantComponent *other =
1335  dynamic_cast<const ConstantComponent*>(&other_in);
1336  KALDI_ASSERT(other != NULL);
1337  output_.AddVec(alpha, other->output_);
1338  }
1339 }
#define KALDI_ASSERT(cond)
Definition: kaldi-error.h:169
void AddVec(Real alpha, const CuVectorBase< Real > &vec, Real beta=1.0)
Definition: cu-vector.cc:1182
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 1233 of file nnet-general-component.cc.

References CuVectorBase< Real >::AddRowSumMat(), UpdatableComponent::is_gradient_, ConstantComponent::is_updatable_, KALDI_ASSERT, UpdatableComponent::learning_rate_, ConstantComponent::output_, OnlineNaturalGradient::PreconditionDirections(), ConstantComponent::preconditioner_, and ConstantComponent::use_natural_gradient_.

1241  {
1242  // we don't update in_deriv, since we set the flag
1243  // kBackpropAdds, and the output doesn't depend on the
1244  // input, so the input-derivative is zero.
1245  if (to_update_in) {
1246  ConstantComponent *to_update =
1247  dynamic_cast<ConstantComponent*>(to_update_in);
1248  if (to_update->is_updatable_) {
1249  // only do the update if the is_updatable_ flag is set.
1250  KALDI_ASSERT(to_update && to_update->is_updatable_);
1251  if (to_update->use_natural_gradient_ && !to_update->is_gradient_) {
1252  CuMatrix<BaseFloat> out_deriv_copy(out_deriv);
1253  BaseFloat scale = 1.0;
1254  to_update->preconditioner_.PreconditionDirections(&out_deriv_copy,
1255  &scale);
1256  to_update->output_.AddRowSumMat(scale * to_update->learning_rate_,
1257  out_deriv_copy);
1258  } else {
1259  to_update->output_.AddRowSumMat(to_update->learning_rate_,
1260  out_deriv);
1261  }
1262  }
1263  }
1264 }
float BaseFloat
Definition: kaldi-types.h:29
#define KALDI_ASSERT(cond)
Definition: kaldi-error.h:169
Component * Copy ( ) const
virtual

Copies component (deep copy).

Implements Component.

Definition at line 1318 of file nnet-general-component.cc.

References ConstantComponent::ConstantComponent().

1318  {
1319  return new ConstantComponent(*this);
1320 }
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 1347 of file nnet-general-component.cc.

References ConstantComponent::is_updatable_, KALDI_ASSERT, ConstantComponent::output_, and kaldi::VecVec().

1348  {
1350  const ConstantComponent *other =
1351  dynamic_cast<const ConstantComponent*>(&other_in);
1352  KALDI_ASSERT(other != NULL);
1353  return VecVec(output_, other->output_);
1354 }
#define KALDI_ASSERT(cond)
Definition: kaldi-error.h:169
Real VecVec(const VectorBase< Real > &a, const VectorBase< Real > &b)
Returns dot product between v1 and v2.
Definition: kaldi-vector.cc:37
virtual void GetInputIndexes ( const MiscComputationInfo misc_info,
const Index output_index,
std::vector< Index > *  desired_indexes 
) const
inlinevirtual

This function only does something interesting for non-simple Components.

For a given index at the output of the component, tells us what indexes are required at its input (note: "required" encompasses also optionally-required things; it will enumerate all things that we'd like to have). See also IsComputable().

Parameters
[in]misc_infoThis argument is supplied to handle things that the framework can't very easily supply: information like which time indexes are needed for AggregateComponent, which time-indexes are available at the input of a recurrent network, and so on. We will add members to misc_info as needed.
[in]output_indexThe Index at the output of the component, for which we are requesting the list of indexes at the component's input.
[out]desired_indexesA list of indexes that are desired at the input. are to be written to here. By "desired" we mean required or optionally-required.

The default implementation of this function is suitable for any SimpleComponent; it just copies the output_index to a single identical element in input_indexes.

Reimplemented from Component.

Definition at line 657 of file nnet-general-component.h.

659  {
660  desired_indexes->clear(); // requires no inputs.
661  }
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 1202 of file nnet-general-component.cc.

References UpdatableComponent::Info(), ConstantComponent::is_updatable_, ConstantComponent::output_, ConstantComponent::OutputDim(), kaldi::nnet3::PrintParameterStats(), ConstantComponent::Type(), and ConstantComponent::use_natural_gradient_.

1202  {
1203  std::ostringstream stream;
1204  stream << UpdatableComponent::Info()
1205  << ", " << Type()
1206  << ", output-dim=" << OutputDim()
1207  << ", is-updatable=" << std::boolalpha << is_updatable_
1208  << ", use-natural-gradient=" << std::boolalpha
1210  PrintParameterStats(stream, "output", output_, true);
1211  return stream.str();
1212 }
virtual std::string Type() const
Returns a string such as "SigmoidComponent", describing the type of the object.
virtual int32 OutputDim() const
Returns output-dimension of this component.
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 'os' 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
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 1356 of file nnet-general-component.cc.

References VectorBase< Real >::Add(), ConfigLine::GetValue(), ConfigLine::HasUnusedValues(), UpdatableComponent::InitLearningRatesFromConfig(), ConstantComponent::is_updatable_, KALDI_ERR, ConstantComponent::output_, VectorBase< Real >::Scale(), VectorBase< Real >::SetRandn(), ConstantComponent::use_natural_gradient_, and ConfigLine::WholeLine().

1356  {
1357  int32 output_dim = 0;
1359  bool ok = cfl->GetValue("output-dim", &output_dim);
1360  cfl->GetValue("is-updatable", &is_updatable_);
1361  cfl->GetValue("use-natural-gradient", &use_natural_gradient_);
1362  BaseFloat output_mean = 0.0, output_stddev = 0.0;
1363  cfl->GetValue("output-mean", &output_mean);
1364  cfl->GetValue("output-stddev", &output_stddev);
1365  if (!ok || cfl->HasUnusedValues() || output_dim <= 0) {
1366  KALDI_ERR << "Bad initializer " << cfl->WholeLine();
1367  }
1368  Vector<BaseFloat> output(output_dim);
1369  output.SetRandn();
1370  output.Scale(output_stddev);
1371  output.Add(output_mean);
1372  output_ = output;
1373 }
void InitLearningRatesFromConfig(ConfigLine *cfl)
float BaseFloat
Definition: kaldi-types.h:29
#define KALDI_ERR
Definition: kaldi-error.h:127
virtual int32 InputDim ( ) const
inlinevirtual

Returns input-dimension of this component.

Implements Component.

Definition at line 619 of file nnet-general-component.h.

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

619 { return output_.Dim(); }
MatrixIndexT Dim() const
Dimensions.
Definition: cu-vector.h:68
virtual bool IsComputable ( const MiscComputationInfo misc_info,
const Index output_index,
const IndexSet input_index_set,
std::vector< Index > *  used_inputs 
) const
inlinevirtual

This function only does something interesting for non-simple Components, and it exists to make it possible to manage optionally-required inputs.

It tells the user whether a given output index is computable from a given set of input indexes, and if so, says which input indexes will be used in the computation.

Implementations of this function are required to have the property that adding an element to "input_index_set" can only ever change IsComputable from false to true, never vice versa.

Parameters
[in]misc_infoSome information specific to the computation, such as minimum and maximum times for certain components to do adaptation on; it's a place to put things that don't easily fit in the framework.
[in]output_indexThe index that is to be computed at the output of this Component.
[in]input_index_setThe set of indexes that is available at the input of this Component.
[out]used_inputsIf this is non-NULL and the output is computable this will be set to the list of input indexes that will actually be used in the computation.
Returns
Returns true iff this output is computable from the provided inputs.

The default implementation of this function is suitable for any SimpleComponent: it just returns true if output_index is in input_index_set, and if so sets used_inputs to vector containing that one Index.

Reimplemented from Component.

Definition at line 666 of file nnet-general-component.h.

669  {
670  if (used_inputs) used_inputs->clear();
671  return true;
672  }
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 1375 of file nnet-general-component.cc.

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

1375  {
1377  return output_.Dim();
1378 }
MatrixIndexT Dim() const
Dimensions.
Definition: cu-vector.h:68
#define KALDI_ASSERT(cond)
Definition: kaldi-error.h:169
const ConstantComponent& operator= ( const ConstantComponent other)
private
virtual int32 OutputDim ( ) const
inlinevirtual

Returns output-dimension of this component.

Implements Component.

Definition at line 621 of file nnet-general-component.h.

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

Referenced by ConstantComponent::Info().

621 { return output_.Dim(); }
MatrixIndexT Dim() const
Dimensions.
Definition: cu-vector.h:68
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 1341 of file nnet-general-component.cc.

References CuVectorBase< Real >::AddVec(), CuVectorBase< Real >::Dim(), kaldi::kUndefined, ConstantComponent::output_, and CuVectorBase< Real >::SetRandn().

1341  {
1342  CuVector<BaseFloat> temp_output(output_.Dim(), kUndefined);
1343  temp_output.SetRandn();
1344  output_.AddVec(stddev, temp_output);
1345 }
MatrixIndexT Dim() const
Dimensions.
Definition: cu-vector.h:68
void AddVec(Real alpha, const CuVectorBase< Real > &vec, Real beta=1.0)
Definition: cu-vector.cc:1182
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 1225 of file nnet-general-component.cc.

References CuMatrixBase< Real >::CopyRowsFromVec(), and ConstantComponent::output_.

1228  {
1229  out->CopyRowsFromVec(output_);
1230  return NULL;
1231 }
void CopyRowsFromVec(const CuVectorBase< Real > &v)
This function has two modes of operation.
Definition: cu-matrix.cc:2282
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 635 of file nnet-general-component.h.

References ConstantComponent::is_updatable_, and kaldi::nnet3::kUpdatableComponent.

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 1266 of file nnet-general-component.cc.

References kaldi::nnet3::ExpectToken(), UpdatableComponent::is_gradient_, ConstantComponent::is_updatable_, KALDI_ERR, UpdatableComponent::learning_rate_, UpdatableComponent::learning_rate_factor_, UpdatableComponent::max_change_, ConstantComponent::output_, CuVector< Real >::Read(), kaldi::ReadBasicType(), kaldi::ReadToken(), and ConstantComponent::use_natural_gradient_.

1266  {
1267  std::string token;
1268  ReadToken(is, binary, &token);
1269  if (token == "<ConstantComponent>") {
1270  ReadToken(is, binary, &token);
1271  }
1272  if (token == "<LearningRateFactor>") {
1273  ReadBasicType(is, binary, &learning_rate_factor_);
1274  ReadToken(is, binary, &token);
1275  } else {
1276  learning_rate_factor_ = 1.0;
1277  }
1278  if (token == "<IsGradient>") {
1279  ReadBasicType(is, binary, &is_gradient_);
1280  ReadToken(is, binary, &token);
1281  } else {
1282  is_gradient_ = false;
1283  }
1284  if (token == "<MaxChange>") {
1285  ReadBasicType(is, binary, &max_change_);
1286  ReadToken(is, binary, &token);
1287  } else {
1288  max_change_ = 0.0;
1289  }
1290  if (token == "<LearningRate>") {
1291  ReadBasicType(is, binary, &learning_rate_);
1292  ReadToken(is, binary, &token);
1293  } else {
1294  learning_rate_ = 0.001;
1295  }
1296  if (token != "<Output>") {
1297  KALDI_ERR << "Expected token <Output>, got " << token;
1298  }
1299  output_.Read(is, binary);
1300  ExpectToken(is, binary, "<IsUpdatable>");
1301  ReadBasicType(is, binary, &is_updatable_);
1302  ExpectToken(is, binary, "<UseNaturalGradient>");
1303  ReadBasicType(is, binary, &use_natural_gradient_);
1304  ExpectToken(is, binary, "</ConstantComponent>");
1305 }
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
void Read(std::istream &is, bool binary)
I/O.
Definition: cu-vector.cc:911
void ReadToken(std::istream &is, bool binary, std::string *str)
ReadToken gets the next token and puts it in str (exception on failure).
Definition: io-funcs.cc:154
BaseFloat max_change_
configuration value for imposing max-change
static void ExpectToken(const std::string &token, const std::string &what_we_are_parsing, const std::string **next_token)
BaseFloat learning_rate_
learning rate (typically 0.0..0.01)
#define KALDI_ERR
Definition: kaldi-error.h:127
BaseFloat learning_rate_factor_
learning rate factor (normally 1.0, but can be set to another < value so that when < you call SetLear...
bool is_gradient_
True if this component is to be treated as a gradient rather than as parameters.
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 1322 of file nnet-general-component.cc.

References ConstantComponent::is_updatable_, ConstantComponent::output_, CuVectorBase< Real >::Scale(), and CuVectorBase< Real >::SetZero().

1322  {
1323  if (is_updatable_) {
1324  if (scale == 0.0) {
1325  output_.SetZero();
1326  } else {
1327  output_.Scale(scale);
1328  }
1329  }
1330 }
void Scale(Real value)
Definition: cu-vector.cc:1161
void SetZero()
Math operations.
Definition: cu-vector.cc:1044
virtual std::string Type ( ) const
inlinevirtual

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

Implements Component.

Definition at line 634 of file nnet-general-component.h.

Referenced by ConstantComponent::Info().

634 { return "ConstantComponent"; }
void UnVectorize ( const VectorBase< BaseFloat > &  params)
virtual

Converts the parameters from vector form.

Reimplemented from UpdatableComponent.

Definition at line 1384 of file nnet-general-component.cc.

References CuVectorBase< Real >::CopyFromVec(), and ConstantComponent::output_.

1384  {
1385  output_.CopyFromVec(params);
1386 }
void CopyFromVec(const CuVectorBase< Real > &src)
Copy functions; these will crash if the dimension do not match.
Definition: cu-vector.cc:1026
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 1380 of file nnet-general-component.cc.

References VectorBase< Real >::CopyFromVec(), and ConstantComponent::output_.

1380  {
1381  params->CopyFromVec(output_);
1382 }
void CopyFromVec(const VectorBase< Real > &v)
Copy data from another vector (must match own size).
void Write ( std::ostream &  os,
bool  binary 
) const
virtual

Write component to stream.

Implements Component.

Definition at line 1307 of file nnet-general-component.cc.

References ConstantComponent::is_updatable_, ConstantComponent::output_, ConstantComponent::use_natural_gradient_, CuVector< Real >::Write(), kaldi::WriteBasicType(), kaldi::WriteToken(), and UpdatableComponent::WriteUpdatableCommon().

1307  {
1308  WriteUpdatableCommon(os, binary); // Write the opening tag and learning rate
1309  WriteToken(os, binary, "<Output>");
1310  output_.Write(os, binary);
1311  WriteToken(os, binary, "<IsUpdatable>");
1312  WriteBasicType(os, binary, is_updatable_);
1313  WriteToken(os, binary, "<UseNaturalGradient>");
1315  WriteToken(os, binary, "</ConstantComponent>");
1316 }
void Write(std::ostream &is, bool binary) const
Definition: cu-vector.cc:921
void WriteUpdatableCommon(std::ostream &is, bool binary) const
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 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

OnlineNaturalGradient preconditioner_
private

Definition at line 690 of file nnet-general-component.h.

Referenced by ConstantComponent::Backprop().


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