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

#include <nnet-simple-component.h>

Inheritance diagram for DropoutComponent:
Collaboration diagram for DropoutComponent:

Public Member Functions

void Init (int32 dim, BaseFloat dropout_proportion=0.0, bool dropout_per_frame=false)
 
 DropoutComponent (int32 dim, BaseFloat dropout=0.0, bool dropout_per_frame=false)
 
 DropoutComponent ()
 
 DropoutComponent (const DropoutComponent &other)
 
virtual int32 Properties () const
 Return bitmask of the component's properties. More...
 
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 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 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 std::string Info () const
 Returns some text-form information about this component, for diagnostics. More...
 
void SetDropoutProportion (BaseFloat dropout_proportion)
 
BaseFloat DropoutProportion () const
 
- Public Member Functions inherited from RandomComponent
void ResetGenerator ()
 
void SetTestMode (bool test_mode)
 
 RandomComponent ()
 
 RandomComponent (const RandomComponent &other)
 
- 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 void Scale (BaseFloat scale)
 This virtual function when called by. 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 ()
 

Private Attributes

int32 dim_
 
BaseFloat dropout_proportion_
 dropout-proportion is the proportion that is dropped out, e.g. More...
 
bool dropout_per_frame_
 

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 Attributes inherited from RandomComponent
CuRand< BaseFloatrandom_generator_
 
bool test_mode_
 

Detailed Description

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

Constructor & Destructor Documentation

DropoutComponent ( int32  dim,
BaseFloat  dropout = 0.0,
bool  dropout_per_frame = false 
)
inline

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

References DropoutComponent::Init().

95  {
96  Init(dim, dropout, dropout_per_frame);
97  }
void Init(int32 dim, BaseFloat dropout_proportion=0.0, bool dropout_per_frame=false)
DropoutComponent ( )
inline

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

Referenced by DropoutComponent::Copy().

99  : dim_(0), dropout_proportion_(0.0),
100  dropout_per_frame_(false) { }
BaseFloat dropout_proportion_
dropout-proportion is the proportion that is dropped out, e.g.
DropoutComponent ( const DropoutComponent other)

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

91  :
92  RandomComponent(other),
93  dim_(other.dim_),
94  dropout_proportion_(other.dropout_proportion_),
95  dropout_per_frame_(other.dropout_per_frame_) { }
BaseFloat dropout_proportion_
dropout-proportion is the proportion that is dropped out, e.g.

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

References KALDI_ASSERT, CuMatrixBase< Real >::NumCols(), CuMatrixBase< Real >::NumRows(), and CuMatrixBase< Real >::SetMatMatDivMat().

183  {
184  KALDI_ASSERT(in_value.NumRows() == out_value.NumRows() &&
185  in_value.NumCols() == out_value.NumCols());
186 
187  KALDI_ASSERT(in_value.NumRows() == out_deriv.NumRows() &&
188  in_value.NumCols() == out_deriv.NumCols());
189  in_deriv->SetMatMatDivMat(out_deriv, out_value, in_value);
190 }
MatrixIndexT NumCols() const
Definition: cu-matrix.h:196
void SetMatMatDivMat(const CuMatrixBase< Real > &A, const CuMatrixBase< Real > &B, const CuMatrixBase< Real > &C)
*this = a * b / c (by element; when c = 0, *this = a) *this can be an alias of a, b or c safely and g...
Definition: cu-matrix.cc:1056
MatrixIndexT NumRows() const
Dimensions.
Definition: cu-matrix.h:195
#define KALDI_ASSERT(cond)
Definition: kaldi-error.h:169
Component * Copy ( ) const
virtual

Copies component (deep copy).

Implements Component.

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

References DropoutComponent::DropoutComponent().

97  {
98  DropoutComponent *ans = new DropoutComponent(*this);
99  return ans;
100 }
BaseFloat DropoutProportion ( ) const
inline

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

References DropoutComponent::dropout_proportion_.

Referenced by ModelCollapser::CollapseComponentsDropout().

141 { return dropout_proportion_; }
BaseFloat dropout_proportion_
dropout-proportion is the proportion that is dropped out, e.g.
std::string Info ( ) const
virtual

Returns some text-form information about this component, for diagnostics.

Starts with the type of the component. E.g. "SigmoidComponent dim=900", although most components will have much more info.

Reimplemented from Component.

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

References DropoutComponent::dim_, DropoutComponent::dropout_per_frame_, DropoutComponent::dropout_proportion_, and DropoutComponent::Type().

128  {
129  std::ostringstream stream;
130  stream << Type() << ", dim=" << dim_
131  << ", dropout-proportion=" << dropout_proportion_
132  << ", dropout-per-frame=" << (dropout_per_frame_ ? "true" : "false");
133  return stream.str();
134 }
virtual std::string Type() const
Returns a string such as "SigmoidComponent", describing the type of the object.
BaseFloat dropout_proportion_
dropout-proportion is the proportion that is dropped out, e.g.
void Init ( int32  dim,
BaseFloat  dropout_proportion = 0.0,
bool  dropout_per_frame = false 
)

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

References DropoutComponent::dim_, DropoutComponent::dropout_per_frame_, and DropoutComponent::dropout_proportion_.

Referenced by DropoutComponent::DropoutComponent(), and DropoutComponent::InitFromConfig().

103  {
104  dropout_proportion_ = dropout_proportion;
105  dropout_per_frame_ = dropout_per_frame;
106  dim_ = dim;
107 }
BaseFloat dropout_proportion_
dropout-proportion is the proportion that is dropped out, e.g.
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 109 of file nnet-simple-component.cc.

References ConfigLine::GetValue(), ConfigLine::HasUnusedValues(), DropoutComponent::Init(), KALDI_ERR, RandomComponent::test_mode_, DropoutComponent::Type(), and ConfigLine::WholeLine().

109  {
110  int32 dim = 0;
111  BaseFloat dropout_proportion = 0.0;
112  bool dropout_per_frame = false;
113  test_mode_ = false;
114  bool ok = cfl->GetValue("dim", &dim) &&
115  cfl->GetValue("dropout-proportion", &dropout_proportion);
116  cfl->GetValue("dropout-per-frame", &dropout_per_frame);
117  // It only makes sense to set test-mode in the config for testing purposes.
118  cfl->GetValue("test-mode", &test_mode_);
119  // for this stage, dropout is hard coded in
120  // normal mode if not declared in config
121  if (!ok || cfl->HasUnusedValues() || dim <= 0 ||
122  dropout_proportion < 0.0 || dropout_proportion > 1.0)
123  KALDI_ERR << "Invalid initializer for layer of type "
124  << Type() << ": \"" << cfl->WholeLine() << "\"";
125  Init(dim, dropout_proportion, dropout_per_frame);
126 }
float BaseFloat
Definition: kaldi-types.h:29
#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.
void Init(int32 dim, BaseFloat dropout_proportion=0.0, bool dropout_per_frame=false)
virtual int32 InputDim ( ) const
inlinevirtual

Returns input-dimension of this component.

Implements Component.

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

References DropoutComponent::dim_.

virtual int32 OutputDim ( ) const
inlinevirtual

Returns output-dimension of this component.

Implements Component.

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

References DropoutComponent::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 136 of file nnet-simple-component.cc.

References CuMatrixBase< Real >::Add(), CuMatrixBase< Real >::ApplyHeaviside(), CuMatrixBase< Real >::CopyColsFromVec(), CuMatrixBase< Real >::CopyFromMat(), DropoutComponent::dim_, DropoutComponent::dropout_per_frame_, DropoutComponent::dropout_proportion_, KALDI_ASSERT, kaldi::kUndefined, CuMatrixBase< Real >::MulElements(), CuMatrixBase< Real >::NumCols(), CuMatrixBase< Real >::NumRows(), RandomComponent::random_generator_, kaldi::RandUniform(), CuMatrixBase< Real >::Scale(), and RandomComponent::test_mode_.

138  {
139  KALDI_ASSERT(out->NumRows() == in.NumRows() && out->NumCols() == in.NumCols()
140  && in.NumCols() == dim_);
141 
142  BaseFloat dropout = dropout_proportion_;
143  KALDI_ASSERT(dropout >= 0.0 && dropout <= 1.0);
144  if (test_mode_) {
145  out->CopyFromMat(in);
146  out->Scale(1.0 - dropout);
147  return NULL;
148  }
149  if (!dropout_per_frame_) {
150  // This const_cast is only safe assuming you don't attempt
151  // to use multi-threaded code with the GPU.
152  const_cast<CuRand<BaseFloat>&>(random_generator_).RandUniform(out);
153 
154  out->Add(-dropout); // now, a proportion "dropout" will be <0.0
155  // apply the function (x>0?1:0). Now, a proportion
156  // "dropout" will be zero and (1 - dropout) will be 1.0.
157  out->ApplyHeaviside();
158 
159  out->MulElements(in);
160  } else {
161  // randomize the dropout matrix by row,
162  // i.e. [[1,1,1,1],[0,0,0,0],[0,0,0,0],[1,1,1,1],[0,0,0,0]]
163  CuMatrix<BaseFloat> tmp(1, out->NumRows(), kUndefined);
164  // This const_cast is only safe assuming you don't attempt
165  // to use multi-threaded code with the GPU.
166  const_cast<CuRand<BaseFloat>&>(random_generator_).RandUniform(&tmp);
167  tmp.Add(-dropout);
168  tmp.ApplyHeaviside();
169  out->CopyColsFromVec(tmp.Row(0));
170  out->MulElements(in);
171  }
172  return NULL;
173 }
void CopyColsFromVec(const CuVectorBase< Real > &v)
Copies vector into matrix, column-by-column.
Definition: cu-matrix.cc:2212
float RandUniform(struct RandomState *state=NULL)
Returns a random number strictly between 0 and 1.
Definition: kaldi-math.h:151
void Scale(Real value)
Definition: cu-matrix.cc:608
MatrixIndexT NumCols() const
Definition: cu-matrix.h:196
void CopyFromMat(const MatrixBase< OtherReal > &src, MatrixTransposeType trans=kNoTrans)
Definition: cu-matrix.cc:337
float BaseFloat
Definition: kaldi-types.h:29
MatrixIndexT NumRows() const
Dimensions.
Definition: cu-matrix.h:195
#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:652
void ApplyHeaviside()
For each element, sets x = (x > 0 ? 1.0 : 0.0).
Definition: cu-matrix.cc:2307
void Add(Real value)
Definition: cu-matrix.cc:546
CuRand< BaseFloat > random_generator_
BaseFloat dropout_proportion_
dropout-proportion is the proportion that is dropped out, e.g.
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 194 of file nnet-simple-component.cc.

References DropoutComponent::dim_, DropoutComponent::dropout_per_frame_, DropoutComponent::dropout_proportion_, kaldi::nnet3::ExpectToken(), KALDI_ASSERT, kaldi::ReadBasicType(), kaldi::ReadToken(), and RandomComponent::test_mode_.

194  {
195  std::string token;
196  ReadToken(is, binary, &token);
197  if (token == "<DropoutComponent>") {
198  ReadToken(is, binary, &token);
199  }
200  KALDI_ASSERT(token == "<Dim>");
201  ReadBasicType(is, binary, &dim_); // read dimension.
202  ReadToken(is, binary, &token);
203  KALDI_ASSERT(token == "<DropoutProportion>");
204  ReadBasicType(is, binary, &dropout_proportion_); // read dropout rate
205  ReadToken(is, binary, &token);
206  if (token == "<DropoutPerFrame>") {
207  ReadBasicType(is, binary, &dropout_per_frame_); // read dropout mode
208  ReadToken(is, binary, &token);
209  } else {
210  dropout_per_frame_ = false;
211  }
212  if (token == "<TestMode>") {
213  ReadBasicType(is, binary, &test_mode_); // read test mode
214  ExpectToken(is, binary, "</DropoutComponent>");
215  } else {
216  test_mode_ = false;
217  KALDI_ASSERT(token == "</DropoutComponent>");
218  }
219 }
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 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
static void ExpectToken(const std::string &token, const std::string &what_we_are_parsing, const std::string **next_token)
#define KALDI_ASSERT(cond)
Definition: kaldi-error.h:169
BaseFloat dropout_proportion_
dropout-proportion is the proportion that is dropped out, e.g.
void SetDropoutProportion ( BaseFloat  dropout_proportion)
inline

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

References DropoutComponent::dropout_proportion_.

Referenced by kaldi::nnet3::ReadEditConfig(), and kaldi::nnet3::SetDropoutProportion().

137  {
138  dropout_proportion_ = dropout_proportion;
139  }
BaseFloat dropout_proportion_
dropout-proportion is the proportion that is dropped out, e.g.
virtual std::string Type ( ) const
inlinevirtual

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

Implements Component.

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

Referenced by DropoutComponent::Info(), and DropoutComponent::InitFromConfig().

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

Write component to stream.

Implements Component.

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

References DropoutComponent::dim_, DropoutComponent::dropout_per_frame_, DropoutComponent::dropout_proportion_, RandomComponent::test_mode_, kaldi::WriteBasicType(), and kaldi::WriteToken().

221  {
222  WriteToken(os, binary, "<DropoutComponent>");
223  WriteToken(os, binary, "<Dim>");
224  WriteBasicType(os, binary, dim_);
225  WriteToken(os, binary, "<DropoutProportion>");
226  WriteBasicType(os, binary, dropout_proportion_);
227  WriteToken(os, binary, "<DropoutPerFrame>");
228  WriteBasicType(os, binary, dropout_per_frame_);
229  WriteToken(os, binary, "<TestMode>");
230  WriteBasicType(os, binary, test_mode_);
231  WriteToken(os, binary, "</DropoutComponent>");
232 }
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
BaseFloat dropout_proportion_
dropout-proportion is the proportion that is dropped out, e.g.

Member Data Documentation

BaseFloat dropout_proportion_
private

dropout-proportion is the proportion that is dropped out, e.g.

if 0.1, we set 10% to zero value.

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

Referenced by DropoutComponent::DropoutProportion(), DropoutComponent::Info(), DropoutComponent::Init(), DropoutComponent::Propagate(), DropoutComponent::Read(), DropoutComponent::SetDropoutProportion(), and DropoutComponent::Write().


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