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

#include <nnet-simple-component.h>

Inheritance diagram for ElementwiseProductComponent:
Collaboration diagram for ElementwiseProductComponent:

Public Member Functions

void Init (int32 input_dim, int32 output_dim)
 
 ElementwiseProductComponent (int32 input_dim, int32 output_dim)
 
virtual int32 Properties () const
 Return bitmask of the component's properties. More...
 
 ElementwiseProductComponent ()
 
virtual std::string Type () const
 Returns a string such as "SigmoidComponent", describing the type of the object. More...
 
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 > &in_value, const CuMatrixBase< BaseFloat > &out_value, const CuMatrixBase< BaseFloat > &out_deriv, void *memo, Component *to_update, CuMatrixBase< BaseFloat > *in_deriv) const
 Backprop function; depending on which of the arguments 'to_update' and 'in_deriv' are non-NULL, this can compute input-data derivatives and/or perform model update. More...
 
virtual ComponentCopy () const
 Copies component (deep copy). More...
 
virtual void Read (std::istream &is, bool binary)
 Read function (used after we know the type of the Component); accepts input that is missing the token that describes the component type, in case it has already been consumed. More...
 
virtual void Write (std::ostream &os, bool binary) const
 Write component to stream. More...
 
- 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
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 std::string Info () const
 Returns some text-form information about this component, for diagnostics. 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 Attributes

int32 input_dim_
 
int32 output_dim_
 

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

Constructor & Destructor Documentation

ElementwiseProductComponent ( int32  input_dim,
int32  output_dim 
)
inlineexplicit

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

References ElementwiseProductComponent::Init().

156  {
157  Init(input_dim, output_dim);
158  }
void Init(int32 input_dim, int32 output_dim)

Member Function Documentation

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

References CuMatrixBase< Real >::CopyFromMat(), rnnlm::i, ElementwiseProductComponent::input_dim_, rnnlm::j, CuMatrixBase< Real >::MulElements(), CuMatrixBase< Real >::NumRows(), and ElementwiseProductComponent::output_dim_.

280  {
281  if (!in_deriv) return;
282  int32 num_inputs = input_dim_ / output_dim_;
283  for (int32 i = 0; i < num_inputs; i++) {
284  CuSubMatrix<BaseFloat> current_in_deriv(*in_deriv, 0, in_deriv->NumRows(),
285  i * output_dim_,
286  output_dim_);
287  current_in_deriv.CopyFromMat(out_deriv);
288  for (int32 j = 0; j < num_inputs; j++) {
289  if (i == j)
290  continue;
291  CuSubMatrix<BaseFloat> in_value_partition(in_value, 0,
292  in_value.NumRows(),
293  j * output_dim_,
294  output_dim_);
295  current_in_deriv.MulElements(in_value_partition);
296  }
297  }
298 }
MatrixIndexT NumRows() const
Dimensions.
Definition: cu-matrix.h:214
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 244 of file nnet-simple-component.cc.

References ConfigLine::GetValue(), ConfigLine::HasUnusedValues(), ElementwiseProductComponent::Init(), KALDI_ERR, ElementwiseProductComponent::Type(), and ConfigLine::WholeLine().

244  {
245  int32 input_dim = 0;
246  int32 output_dim = 0;
247  bool ok = cfl->GetValue("output-dim", &output_dim) &&
248  cfl->GetValue("input-dim", &input_dim);
249  if (!ok || cfl->HasUnusedValues() || output_dim <= 0)
250  KALDI_ERR << "Invalid initializer for layer of type "
251  << Type() << ": \"" << cfl->WholeLine() << "\"";
252  Init(input_dim, output_dim);
253 }
void Init(int32 input_dim, int32 output_dim)
#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.
virtual int32 InputDim ( ) const
inlinevirtual

Returns input-dimension of this component.

Implements Component.

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

References ElementwiseProductComponent::input_dim_.

virtual int32 OutputDim ( ) const
inlinevirtual

Returns output-dimension of this component.

Implements Component.

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

References ElementwiseProductComponent::output_dim_.

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

References CuMatrixBase< Real >::CopyFromMat(), rnnlm::i, ElementwiseProductComponent::input_dim_, KALDI_ASSERT, CuMatrixBase< Real >::MulElements(), CuMatrixBase< Real >::NumCols(), CuMatrixBase< Real >::NumRows(), and ElementwiseProductComponent::output_dim_.

258  {
260  int32 num_inputs = input_dim_ / output_dim_;
261  for (int32 i = 0; i < num_inputs; i++) {
262  CuSubMatrix<BaseFloat> current_in(in, 0, in.NumRows(),
264  if (i == 0) {
265  out->CopyFromMat(current_in);
266  } else {
267  out->MulElements(current_in);
268  }
269  }
270  return NULL;
271 }
MatrixIndexT NumCols() const
Definition: cu-matrix.h:215
void CopyFromMat(const MatrixBase< OtherReal > &src, MatrixTransposeType trans=kNoTrans)
Definition: cu-matrix.cc:339
MatrixIndexT NumRows() const
Dimensions.
Definition: cu-matrix.h:214
#define KALDI_ASSERT(cond)
Definition: kaldi-error.h:169
void MulElements(const CuMatrixBase< Real > &A)
Multiply two matrices elementwise: C = C .* A.
Definition: cu-matrix.cc:654
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 159 of file nnet-simple-component.h.

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

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

References kaldi::nnet3::ExpectOneOrTwoTokens(), kaldi::nnet3::ExpectToken(), ElementwiseProductComponent::input_dim_, ElementwiseProductComponent::output_dim_, and kaldi::ReadBasicType().

300  {
301  ExpectOneOrTwoTokens(is, binary, "<ElementwiseProductComponent>",
302  "<InputDim>");
303  ReadBasicType(is, binary, &input_dim_);
304  ExpectToken(is, binary, "<OutputDim>");
305  ReadBasicType(is, binary, &output_dim_);
306  ExpectToken(is, binary, "</ElementwiseProductComponent>");
307 }
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 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)
virtual std::string Type ( ) const
inlinevirtual

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

Implements Component.

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

Referenced by ElementwiseProductComponent::InitFromConfig().

163 { return "ElementwiseProductComponent"; }
void Write ( std::ostream &  os,
bool  binary 
) const
virtual

Write component to stream.

Implements Component.

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

References ElementwiseProductComponent::input_dim_, ElementwiseProductComponent::output_dim_, kaldi::WriteBasicType(), and kaldi::WriteToken().

309  {
310  WriteToken(os, binary, "<ElementwiseProductComponent>");
311  WriteToken(os, binary, "<InputDim>");
312  WriteBasicType(os, binary, input_dim_);
313  WriteToken(os, binary, "<OutputDim>");
314  WriteBasicType(os, binary, output_dim_);
315  WriteToken(os, binary, "</ElementwiseProductComponent>");
316 }
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


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