DistributeComponent Class Reference

This Component takes a larger input-dim than output-dim, where the input-dim must be a multiple of the output-dim, and distributes different blocks of the input dimension to different 'x' values. More...

#include <nnet-general-component.h>

Inheritance diagram for DistributeComponent:
Collaboration diagram for DistributeComponent:

Public Member Functions

 DistributeComponent (int32 input_dim, int32 output_dim)
 
 DistributeComponent ()
 
virtual int32 InputDim () const
 Returns input-dimension of this component. More...
 
virtual int32 OutputDim () const
 Returns output-dimension of this component. More...
 
virtual void InitFromConfig (ConfigLine *cfl)
 Initialize, from a ConfigLine object. More...
 
virtual std::string Type () const
 Returns a string such as "SigmoidComponent", describing the type of the object. More...
 
virtual int32 Properties () const
 Return bitmask of the component's properties. More...
 
virtual void * Propagate (const ComponentPrecomputedIndexes *indexes, const CuMatrixBase< BaseFloat > &in, CuMatrixBase< BaseFloat > *out) const
 Propagate function. More...
 
virtual void Backprop (const std::string &debug_info, const ComponentPrecomputedIndexes *indexes, const CuMatrixBase< BaseFloat > &in_value, const CuMatrixBase< BaseFloat > &out_value, const CuMatrixBase< BaseFloat > &out_deriv, void *memo, Component *, 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 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...
 
void Init (int32 input_dim, int32 output_dim)
 
- 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 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...
 
virtual void ConsolidateMemory ()
 This virtual function relates to memory management, and avoiding fragmentation. More...
 
 Component ()
 
virtual ~Component ()
 

Private Member Functions

void ComputeInputIndexAndBlock (const Index &output_index, Index *input_index, int32 *block) const
 
void ComputeInputPointers (const ComponentPrecomputedIndexes *indexes, const CuMatrixBase< BaseFloat > &in, int32 num_output_rows, std::vector< const BaseFloat *> *input_pointers) const
 
void ComputeInputPointers (const ComponentPrecomputedIndexes *indexes, int32 num_output_rows, CuMatrixBase< BaseFloat > *in, std::vector< BaseFloat *> *input_pointers) const
 

Private 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

This Component takes a larger input-dim than output-dim, where the input-dim must be a multiple of the output-dim, and distributes different blocks of the input dimension to different 'x' values.

In the normal case where the input is only valid at x=0, the first block of output goes to x=0, the second block at x=1, and so on. It also supports a more general usage, so in general a value 'x' at the output will map to block 'x % n_blocks' of the dimension blocks of the input, and to an x value 'x / n_blocks' of the input. For negative x values the % and / operations are always rounded down, not towards zero.

The config line is of the form input-dim=xx output-dim=xx where input-dim must be a multiple of the output-dim, and n_blocks is set to input-dim / output-dim.

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

Constructor & Destructor Documentation

◆ DistributeComponent() [1/2]

DistributeComponent ( int32  input_dim,
int32  output_dim 
)
inline

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

References DistributeComponent::Init().

58  {
59  Init(input_dim, output_dim);
60  }
void Init(int32 input_dim, int32 output_dim)

◆ DistributeComponent() [2/2]

Member Function Documentation

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

References DistributeComponent::ComputeInputPointers(), CuMatrixBase< Real >::CopyToRows(), DistributeComponent::input_dim_, CuMatrixBase< Real >::NumRows(), NVTX_RANGE, DistributeComponent::output_dim_, and CuMatrixBase< Real >::SetZero().

Referenced by DistributeComponent::Properties(), StatisticsExtractionComponent::Properties(), StatisticsPoolingComponent::Properties(), BackpropTruncationComponent::Properties(), ConstantComponent::Properties(), GeneralDropoutComponent::Properties(), and SpecAugmentTimeMaskComponent::Properties().

201  {
202  NVTX_RANGE("DistributeComponent::Backprop");
203  if (in_deriv == NULL) return;
204 
205  int32 num_blocks = input_dim_ / output_dim_,
206  num_output_rows = out_deriv.NumRows();
207  if (num_output_rows != in_deriv->NumRows() * num_blocks) {
208  // there could be some 'gaps', i.e. some input values that are not ever
209  // referred to. So we need to zero the input. This would't happen in the
210  // setups I plan to use this for.
211  in_deriv->SetZero();
212  }
213 
214  std::vector<BaseFloat*> input_pointers;
215  ComputeInputPointers(indexes, num_output_rows, in_deriv, &input_pointers);
216  CuArray<BaseFloat*> input_pointers_cuda(input_pointers);
217  out_deriv.CopyToRows(input_pointers_cuda);
218 }
kaldi::int32 int32
#define NVTX_RANGE(name)
Definition: cu-common.h:143
void ComputeInputPointers(const ComponentPrecomputedIndexes *indexes, const CuMatrixBase< BaseFloat > &in, int32 num_output_rows, std::vector< const BaseFloat *> *input_pointers) const

◆ ComputeInputIndexAndBlock()

void ComputeInputIndexAndBlock ( const Index output_index,
Index input_index,
int32 block 
) const
inlineprivate

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

References DistributeComponent::input_dim_, DistributeComponent::output_dim_, and Index::x.

Referenced by DistributeComponent::Copy(), DistributeComponent::GetInputIndexes(), DistributeComponent::IsComputable(), and DistributeComponent::PrecomputeIndexes().

48  {
49  int32 num_blocks = input_dim_ / output_dim_;
50  *input_index = output_index;
51  int32 output_x = output_index.x, input_x;
52  if (output_x >= 0) {
53  input_x = output_x / num_blocks;
54  } else {
55  input_x = (output_x - num_blocks + 1) / num_blocks;
56  }
57  input_index->x = input_x;
58  if (block)
59  *block = output_x - (input_x * num_blocks);
60 }
kaldi::int32 int32

◆ ComputeInputPointers() [1/2]

void ComputeInputPointers ( const ComponentPrecomputedIndexes indexes,
const CuMatrixBase< BaseFloat > &  in,
int32  num_output_rows,
std::vector< const BaseFloat *> *  input_pointers 
) const
inlineprivate

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

References CuMatrixBase< Real >::Data(), rnnlm::i, KALDI_ASSERT, DistributeComponentPrecomputedIndexes::pairs, and CuMatrixBase< Real >::Stride().

Referenced by DistributeComponent::Backprop(), DistributeComponent::Copy(), and DistributeComponent::Propagate().

138  {
139  const DistributeComponentPrecomputedIndexes *indexes =
140  dynamic_cast<const DistributeComponentPrecomputedIndexes*>(indexes_in);
141  KALDI_ASSERT(indexes != NULL && "Invalid pointer type");
142  KALDI_ASSERT(num_output_rows == static_cast<int32>(indexes->pairs.size()));
143  input_pointers->resize(num_output_rows);
144 
145  const BaseFloat *input_data = in.Data();
146  int32 input_stride = in.Stride();
147  const BaseFloat **input_pointers_data = &((*input_pointers)[0]);
148  const std::pair<int32, int32> *pairs_data = &(indexes->pairs[0]);
149  for (int32 i = 0; i < num_output_rows; i++) {
150  input_pointers_data[i] = input_data +
151  pairs_data[i].first * input_stride +
152  pairs_data[i].second;
153  }
154 }
kaldi::int32 int32
float BaseFloat
Definition: kaldi-types.h:29
#define KALDI_ASSERT(cond)
Definition: kaldi-error.h:185

◆ ComputeInputPointers() [2/2]

void ComputeInputPointers ( const ComponentPrecomputedIndexes indexes,
int32  num_output_rows,
CuMatrixBase< BaseFloat > *  in,
std::vector< BaseFloat *> *  input_pointers 
) const
inlineprivate

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

References CuMatrixBase< Real >::Data(), rnnlm::i, KALDI_ASSERT, DistributeComponentPrecomputedIndexes::pairs, and CuMatrixBase< Real >::Stride().

160  {
161  const DistributeComponentPrecomputedIndexes *indexes =
162  dynamic_cast<const DistributeComponentPrecomputedIndexes*>(indexes_in);
163  KALDI_ASSERT(indexes != NULL && "Invalid pointer type");
164  KALDI_ASSERT(num_output_rows == static_cast<int32>(indexes->pairs.size()));
165  input_pointers->resize(num_output_rows);
166 
167  BaseFloat *input_data = in->Data();
168  int32 input_stride = in->Stride();
169  BaseFloat **input_pointers_data = &((*input_pointers)[0]);
170  const std::pair<int32, int32> *pairs_data = &(indexes->pairs[0]);
171  for (int32 i = 0; i < num_output_rows; i++) {
172  input_pointers_data[i] = input_data +
173  pairs_data[i].first * input_stride +
174  pairs_data[i].second;
175  }
176 }
kaldi::int32 int32
float BaseFloat
Definition: kaldi-types.h:29
#define KALDI_ASSERT(cond)
Definition: kaldi-error.h:185

◆ Copy()

◆ GetInputIndexes()

void GetInputIndexes ( const MiscComputationInfo misc_info,
const Index output_index,
std::vector< Index > *  desired_indexes 
) const
virtual

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

References DistributeComponent::ComputeInputIndexAndBlock().

Referenced by DistributeComponent::Copy(), StatisticsExtractionComponent::Copy(), and StatisticsPoolingComponent::Copy().

66  {
67  desired_indexes->resize(1);
68  ComputeInputIndexAndBlock(output_index, &((*desired_indexes)[0]), NULL);
69 }
void ComputeInputIndexAndBlock(const Index &output_index, Index *input_index, int32 *block) const

◆ Init()

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

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

Referenced by DistributeComponent::OutputDim(), StatisticsExtractionComponent::OutputDim(), StatisticsPoolingComponent::OutputDim(), BackpropTruncationComponent::OutputDim(), ConstantComponent::OutputDim(), DropoutMaskComponent::OutputDim(), GeneralDropoutComponent::OutputDim(), and SpecAugmentTimeMaskComponent::OutputDim().

228  {
229  int32 input_dim, output_dim;
230  bool ok = cfl->GetValue("input-dim", &input_dim) &&
231  cfl->GetValue("output-dim", &output_dim);
232  if (!ok || cfl->HasUnusedValues())
233  KALDI_ERR << "Invalid initializer for layer of type "
234  << Type() << ": \"" << cfl->WholeLine() << "\"";
235  else
236  Init(input_dim, output_dim);
237 }
virtual std::string Type() const
Returns a string such as "SigmoidComponent", describing the type of the object.
kaldi::int32 int32
#define KALDI_ERR
Definition: kaldi-error.h:147
void Init(int32 input_dim, int32 output_dim)

◆ InputDim()

virtual int32 InputDim ( ) const
inlinevirtual

Returns input-dimension of this component.

Implements Component.

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

References DistributeComponent::input_dim_.

◆ IsComputable()

bool IsComputable ( const MiscComputationInfo misc_info,
const Index output_index,
const IndexSet input_index_set,
std::vector< Index > *  used_inputs 
) const
virtual

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

References DistributeComponent::ComputeInputIndexAndBlock().

Referenced by DistributeComponent::Copy(), StatisticsExtractionComponent::Copy(), and StatisticsPoolingComponent::Copy().

76  {
77  Index input_index;
78  ComputeInputIndexAndBlock(output_index, &input_index, NULL);
79  if (!input_index_set(input_index))
80  return false;
81  if (used_inputs) {
82  used_inputs->clear();
83  used_inputs->push_back(input_index);
84  }
85  return true;
86 }
void ComputeInputIndexAndBlock(const Index &output_index, Index *input_index, int32 *block) const

◆ OutputDim()

virtual int32 OutputDim ( ) const
inlinevirtual

Returns output-dimension of this component.

Implements Component.

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

References DistributeComponent::InitFromConfig(), and DistributeComponent::output_dim_.

◆ PrecomputeIndexes()

ComponentPrecomputedIndexes * PrecomputeIndexes ( const MiscComputationInfo misc_info,
const std::vector< Index > &  input_indexes,
const std::vector< Index > &  output_indexes,
bool  need_backprop 
) const
virtual

This function must return NULL for simple Components.

Returns a pointer to a class that may contain some precomputed component-specific and computation-specific indexes to be in used in the Propagate and Backprop functions.

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. misc_info may not even ever be used here. We will add members to misc_info as needed.
[in]input_indexesA vector of indexes that explains what time-indexes (and other indexes) each row of the in/in_value/in_deriv matrices given to Propagate and Backprop will mean.
[in]output_indexesA vector of indexes that explains what time-indexes (and other indexes) each row of the out/out_value/out_deriv matrices given to Propagate and Backprop will mean.
[in]need_backpropTrue if we might need to do backprop with this component, so that if any different indexes are needed for backprop then those should be computed too.
Returns
Returns a child-class of class ComponentPrecomputedIndexes, or NULL if this component for does not need to precompute any indexes (e.g. if it is a simple component and does not care about indexes).

Reimplemented from Component.

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

References DistributeComponent::ComputeInputIndexAndBlock(), rnnlm::i, DistributeComponent::input_dim_, KALDI_ERR, DistributeComponent::output_dim_, and DistributeComponentPrecomputedIndexes::pairs.

Referenced by DistributeComponent::Copy(), StatisticsExtractionComponent::Copy(), StatisticsPoolingComponent::Copy(), GeneralDropoutComponent::DeleteMemo(), SpecAugmentTimeMaskComponent::DeleteMemo(), and BackpropTruncationComponent::Properties().

106  { // the bool is 'need_backprop'- unused.
107  unordered_map<Index, int32, IndexHasher> index_to_input_dim;
108  int32 num_input_indexes = input_indexes.size(),
109  num_output_indexes = output_indexes.size();
110  for (int32 i = 0; i < num_input_indexes; i++)
111  index_to_input_dim[input_indexes[i]] = i;
112  DistributeComponentPrecomputedIndexes *ans = new
113  DistributeComponentPrecomputedIndexes;
114  ans->pairs.resize(output_indexes.size());
115 
116  int32 num_blocks = input_dim_ / output_dim_,
117  block_size = input_dim_ / num_blocks;
118 
119  for (int32 i = 0; i < num_output_indexes; i++) {
120  Index input_index;
121  int32 block_index;
122  ComputeInputIndexAndBlock(output_indexes[i], &input_index, &block_index);
123  unordered_map<Index, int32, IndexHasher>::iterator iter =
124  index_to_input_dim.find(input_index);
125  if (iter == index_to_input_dim.end())
126  KALDI_ERR << "Input index not found (code error)";
127  int32 input_row = iter->second;
128  ans->pairs[i] = std::pair<int32,int32>(input_row, block_index * block_size);
129  }
130  return ans;
131 }
void ComputeInputIndexAndBlock(const Index &output_index, Index *input_index, int32 *block) const
kaldi::int32 int32
#define KALDI_ERR
Definition: kaldi-error.h:147

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

References DistributeComponent::ComputeInputPointers(), CuMatrixBase< Real >::CopyRows(), DistributeComponent::input_dim_, KALDI_ASSERT, CuMatrixBase< Real >::NumCols(), CuMatrixBase< Real >::NumRows(), and DistributeComponent::output_dim_.

Referenced by DistributeComponent::Properties(), StatisticsExtractionComponent::Properties(), StatisticsPoolingComponent::Properties(), BackpropTruncationComponent::Properties(), ConstantComponent::Properties(), DropoutMaskComponent::Properties(), GeneralDropoutComponent::Properties(), and SpecAugmentTimeMaskComponent::Properties().

182  {
183  KALDI_ASSERT(indexes != NULL &&
184  in.NumCols() == input_dim_ && out->NumCols() == output_dim_);
185  int32 num_output_rows = out->NumRows();
186  std::vector<const BaseFloat*> input_pointers;
187  ComputeInputPointers(indexes, in, num_output_rows, &input_pointers);
188  CuArray<const BaseFloat*> input_pointers_cuda(input_pointers);
189  out->CopyRows(input_pointers_cuda);
190  return NULL;
191 }
kaldi::int32 int32
#define KALDI_ASSERT(cond)
Definition: kaldi-error.h:185
void ComputeInputPointers(const ComponentPrecomputedIndexes *indexes, const CuMatrixBase< BaseFloat > &in, int32 num_output_rows, std::vector< const BaseFloat *> *input_pointers) const

◆ Properties()

virtual int32 Properties ( ) const
inlinevirtual

Return bitmask of the component's properties.

These properties depend only on the component's type. See enum ComponentProperties.

Implements Component.

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

References DistributeComponent::Backprop(), DistributeComponent::Propagate(), DistributeComponent::Read(), and DistributeComponent::Write().

68 { return 0; }

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

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

Referenced by DropoutMaskComponent::Backprop(), DistributeComponentPrecomputedIndexes::Copy(), StatisticsExtractionComponentPrecomputedIndexes::Copy(), StatisticsPoolingComponentPrecomputedIndexes::Copy(), BackpropTruncationComponentPrecomputedIndexes::Copy(), GeneralDropoutComponentPrecomputedIndexes::Copy(), SpecAugmentTimeMaskComponentPrecomputedIndexes::Copy(), GeneralDropoutComponent::DeleteMemo(), SpecAugmentTimeMaskComponent::DeleteMemo(), DistributeComponent::Properties(), StatisticsExtractionComponent::Properties(), StatisticsPoolingComponent::Properties(), BackpropTruncationComponent::Properties(), and ConstantComponent::Properties().

248  {
249  ExpectOneOrTwoTokens(is, binary, "<DistributeComponent>", "<InputDim>");
250  ReadBasicType(is, binary, &input_dim_);
251  ExpectToken(is, binary, "<OutputDim>");
252  ReadBasicType(is, binary, &output_dim_);
253  ExpectToken(is, binary, "</DistributeComponent>");
254 }
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: text-utils.cc:536
static void ExpectToken(const std::string &token, const std::string &what_we_are_parsing, const std::string **next_token)

◆ Type()

virtual std::string Type ( ) const
inlinevirtual

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

Implements Component.

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

Referenced by DistributeComponent::InitFromConfig().

67 { return "DistributeComponent"; }

◆ Write()

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

Write component to stream.

Implements Component.

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

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

Referenced by DropoutMaskComponent::Backprop(), DistributeComponentPrecomputedIndexes::Copy(), StatisticsExtractionComponentPrecomputedIndexes::Copy(), StatisticsPoolingComponentPrecomputedIndexes::Copy(), BackpropTruncationComponentPrecomputedIndexes::Copy(), GeneralDropoutComponentPrecomputedIndexes::Copy(), SpecAugmentTimeMaskComponentPrecomputedIndexes::Copy(), GeneralDropoutComponent::DeleteMemo(), SpecAugmentTimeMaskComponent::DeleteMemo(), DistributeComponent::Properties(), StatisticsExtractionComponent::Properties(), StatisticsPoolingComponent::Properties(), BackpropTruncationComponent::Properties(), and ConstantComponent::Properties().

239  {
240  WriteToken(os, binary, "<DistributeComponent>");
241  WriteToken(os, binary, "<InputDim>");
242  WriteBasicType(os, binary, input_dim_);
243  WriteToken(os, binary, "<OutputDim>");
244  WriteBasicType(os, binary, output_dim_);
245  WriteToken(os, binary, "</DistributeComponent>");
246 }
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

◆ input_dim_

◆ output_dim_


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