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>
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 Component * | Copy () 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 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... | |
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 Component * | ReadNew (std::istream &is, bool binary) |
Read component from stream (works out its type). Dies on error. More... | |
static Component * | NewComponentOfType (const std::string &type) |
Returns a new Component of the given type e.g. More... | |
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.
|
inline |
Definition at line 58 of file nnet-general-component.h.
References DistributeComponent::Init().
|
inline |
Definition at line 61 of file nnet-general-component.h.
Referenced by DistributeComponent::Copy().
|
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.
[in] | debug_info | The component name, to be printed out in any warning messages. |
[in] | indexes | A 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_value | The matrix that was given as input to the Propagate function. Will be ignored (and may be empty) if Properties()&kBackpropNeedsInput == 0. |
[in] | out_value | The matrix that was output from the Propagate function. Will be ignored (and may be empty) if Properties()&kBackpropNeedsOutput == 0 |
[in] | out_deriv | The derivative at the output of this component. |
[in] | memo | This 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_update | If 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_deriv | The 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().
|
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().
|
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().
|
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().
|
inlinevirtual |
Copies component (deep copy).
Implements Component.
Definition at line 86 of file nnet-general-component.h.
References DistributeComponent::ComputeInputIndexAndBlock(), DistributeComponent::ComputeInputPointers(), DistributeComponent::DistributeComponent(), DistributeComponent::GetInputIndexes(), DistributeComponent::Init(), DistributeComponent::input_dim_, DistributeComponent::IsComputable(), DistributeComponent::output_dim_, and DistributeComponent::PrecomputeIndexes().
Referenced by DropoutMaskComponent::Backprop(), GeneralDropoutComponent::DeleteMemo(), SpecAugmentTimeMaskComponent::DeleteMemo(), BackpropTruncationComponent::Properties(), and ConstantComponent::Properties().
|
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().
[in] | misc_info | This 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_index | The Index at the output of the component, for which we are requesting the list of indexes at the component's input. |
[out] | desired_indexes | A 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().
Definition at line 221 of file nnet-general-component.cc.
References DistributeComponent::input_dim_, KALDI_ASSERT, and DistributeComponent::output_dim_.
Referenced by BackpropTruncationComponent::BackpropTruncationComponent(), DistributeComponent::Copy(), DistributeComponent::DistributeComponent(), DistributeComponent::InitFromConfig(), and BackpropTruncationComponent::OutputDim().
|
virtual |
Initialize, from a ConfigLine object.
[in] | cfl | A 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().
|
inlinevirtual |
Returns input-dimension of this component.
Implements Component.
Definition at line 62 of file nnet-general-component.h.
References DistributeComponent::input_dim_.
|
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.
[in] | misc_info | Some 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_index | The index that is to be computed at the output of this Component. |
[in] | input_index_set | The set of indexes that is available at the input of this Component. |
[out] | used_inputs | If 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. |
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().
|
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_.
|
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.
[in] | misc_info | This 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_indexes | A 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_indexes | A 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_backprop | True 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. |
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().
|
virtual |
Propagate function.
[in] | indexes | A 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 | The input to this component. Num-columns == InputDim(). |
[out] | out | The 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. |
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().
|
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().
|
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().
|
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().
|
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().
|
private |
Definition at line 128 of file nnet-general-component.h.
Referenced by DistributeComponent::Backprop(), DistributeComponent::ComputeInputIndexAndBlock(), DistributeComponent::Copy(), DistributeComponent::Init(), DistributeComponent::InputDim(), StatisticsExtractionComponent::InputDim(), StatisticsPoolingComponent::InputDim(), StatisticsExtractionComponent::OutputDim(), StatisticsPoolingComponent::OutputDim(), DistributeComponent::PrecomputeIndexes(), DistributeComponent::Propagate(), DistributeComponent::Read(), and DistributeComponent::Write().
|
private |
Definition at line 129 of file nnet-general-component.h.
Referenced by DistributeComponent::Backprop(), DistributeComponent::ComputeInputIndexAndBlock(), DistributeComponent::Copy(), DistributeComponent::Init(), DropoutMaskComponent::InputDim(), DistributeComponent::OutputDim(), DropoutMaskComponent::OutputDim(), DistributeComponent::PrecomputeIndexes(), DistributeComponent::Propagate(), DistributeComponent::Read(), and DistributeComponent::Write().