#include <nnet-combined-component.h>
Public Member Functions | |
MaxpoolingComponent () | |
MaxpoolingComponent (const MaxpoolingComponent &component) | |
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... | |
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... | |
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 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 () |
Protected Member Functions | |
void | InputToInputPatches (const CuMatrixBase< BaseFloat > &in, CuMatrix< BaseFloat > *patches) const |
void | InderivPatchesToInderiv (const CuMatrix< BaseFloat > &in_deriv_patches, CuMatrixBase< BaseFloat > *in_deriv) const |
virtual void | Check () const |
Protected Attributes | |
int32 | input_x_dim_ |
int32 | input_y_dim_ |
int32 | input_z_dim_ |
int32 | pool_x_size_ |
int32 | pool_y_size_ |
int32 | pool_z_size_ |
int32 | pool_x_step_ |
int32 | pool_y_step_ |
int32 | pool_z_step_ |
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... | |
Definition at line 488 of file nnet-combined-component.h.
|
inline |
Definition at line 491 of file nnet-combined-component.h.
References ConvolutionComponent::Info(), ConvolutionComponent::InitFromConfig(), ConvolutionComponent::InputDim(), and ConvolutionComponent::OutputDim().
MaxpoolingComponent | ( | const MaxpoolingComponent & | component | ) |
Definition at line 698 of file nnet-combined-component.cc.
|
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 875 of file nnet-combined-component.cc.
References CuMatrixBase< Real >::ColRange(), CuMatrixBase< Real >::EqualElementMask(), MaxpoolingComponent::InderivPatchesToInderiv(), MaxpoolingComponent::InputToInputPatches(), kaldi::kUndefined, CuMatrixBase< Real >::MulElements(), CuMatrixBase< Real >::NumRows(), NVTX_RANGE, MaxpoolingComponent::OutputDim(), MaxpoolingComponent::pool_x_size_, MaxpoolingComponent::pool_y_size_, and MaxpoolingComponent::pool_z_size_.
|
protectedvirtual |
Definition at line 719 of file nnet-combined-component.cc.
References MaxpoolingComponent::input_x_dim_, MaxpoolingComponent::input_y_dim_, MaxpoolingComponent::input_z_dim_, KALDI_ASSERT, MaxpoolingComponent::pool_x_size_, MaxpoolingComponent::pool_x_step_, MaxpoolingComponent::pool_y_size_, MaxpoolingComponent::pool_y_step_, MaxpoolingComponent::pool_z_size_, and MaxpoolingComponent::pool_z_step_.
Referenced by MaxpoolingComponent::InitFromConfig(), and MaxpoolingComponent::Read().
|
inlinevirtual |
Copies component (deep copy).
Implements Component.
Definition at line 525 of file nnet-combined-component.h.
References ConvolutionComponent::InderivPatchesToInderiv(), and ConvolutionComponent::InputToInputPatches().
|
protected |
Definition at line 828 of file nnet-combined-component.cc.
References CuMatrixBase< Real >::AddCols(), MaxpoolingComponent::input_x_dim_, MaxpoolingComponent::input_y_dim_, MaxpoolingComponent::input_z_dim_, KALDI_ASSERT, CuMatrixBase< Real >::NumCols(), MaxpoolingComponent::pool_x_size_, MaxpoolingComponent::pool_x_step_, MaxpoolingComponent::pool_y_size_, MaxpoolingComponent::pool_y_step_, MaxpoolingComponent::pool_z_size_, MaxpoolingComponent::pool_z_step_, and kaldi::nnet3::RearrangeIndexes().
Referenced by MaxpoolingComponent::Backprop().
|
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 953 of file nnet-combined-component.cc.
References MaxpoolingComponent::input_x_dim_, MaxpoolingComponent::input_y_dim_, MaxpoolingComponent::input_z_dim_, MaxpoolingComponent::pool_x_size_, MaxpoolingComponent::pool_x_step_, MaxpoolingComponent::pool_y_size_, MaxpoolingComponent::pool_y_step_, MaxpoolingComponent::pool_z_size_, MaxpoolingComponent::pool_z_step_, and MaxpoolingComponent::Type().
|
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 742 of file nnet-combined-component.cc.
References MaxpoolingComponent::Check(), ConfigLine::GetValue(), ConfigLine::HasUnusedValues(), MaxpoolingComponent::input_x_dim_, MaxpoolingComponent::input_y_dim_, MaxpoolingComponent::input_z_dim_, KALDI_ERR, MaxpoolingComponent::pool_x_size_, MaxpoolingComponent::pool_x_step_, MaxpoolingComponent::pool_y_size_, MaxpoolingComponent::pool_y_step_, MaxpoolingComponent::pool_z_size_, MaxpoolingComponent::pool_z_step_, ConfigLine::UnusedValues(), and ConfigLine::WholeLine().
|
virtual |
Returns input-dimension of this component.
Implements Component.
Definition at line 694 of file nnet-combined-component.cc.
References ConvolutionComponent::input_x_dim_, ConvolutionComponent::input_y_dim_, and ConvolutionComponent::input_z_dim_.
|
protected |
Definition at line 767 of file nnet-combined-component.cc.
References CuMatrixBase< Real >::CopyCols(), MaxpoolingComponent::input_x_dim_, MaxpoolingComponent::input_y_dim_, MaxpoolingComponent::input_z_dim_, KALDI_ASSERT, CuMatrixBase< Real >::NumCols(), MaxpoolingComponent::pool_x_size_, MaxpoolingComponent::pool_x_step_, MaxpoolingComponent::pool_y_size_, MaxpoolingComponent::pool_y_step_, MaxpoolingComponent::pool_z_size_, and MaxpoolingComponent::pool_z_step_.
Referenced by MaxpoolingComponent::Backprop(), and MaxpoolingComponent::Propagate().
|
virtual |
Returns output-dimension of this component.
Implements Component.
Definition at line 711 of file nnet-combined-component.cc.
References MaxpoolingComponent::input_x_dim_, MaxpoolingComponent::input_y_dim_, MaxpoolingComponent::input_z_dim_, MaxpoolingComponent::pool_x_size_, MaxpoolingComponent::pool_x_step_, MaxpoolingComponent::pool_y_size_, MaxpoolingComponent::pool_y_step_, MaxpoolingComponent::pool_z_size_, and MaxpoolingComponent::pool_z_step_.
Referenced by MaxpoolingComponent::Backprop(), and MaxpoolingComponent::Propagate().
|
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 810 of file nnet-combined-component.cc.
References CuMatrixBase< Real >::ColRange(), MaxpoolingComponent::InputToInputPatches(), kaldi::kUndefined, CuMatrixBase< Real >::Max(), CuMatrixBase< Real >::NumRows(), MaxpoolingComponent::OutputDim(), MaxpoolingComponent::pool_x_size_, MaxpoolingComponent::pool_y_size_, MaxpoolingComponent::pool_z_size_, and CuMatrixBase< Real >::Set().
|
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 503 of file nnet-combined-component.h.
References ConvolutionComponent::Backprop(), kaldi::nnet3::kBackpropAdds, kaldi::nnet3::kBackpropNeedsInput, kaldi::nnet3::kBackpropNeedsOutput, kaldi::nnet3::kSimpleComponent, ConvolutionComponent::Propagate(), ConvolutionComponent::Read(), and ConvolutionComponent::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 906 of file nnet-combined-component.cc.
References MaxpoolingComponent::Check(), kaldi::ExpectOneOrTwoTokens(), kaldi::nnet3::ExpectToken(), MaxpoolingComponent::input_x_dim_, MaxpoolingComponent::input_y_dim_, MaxpoolingComponent::input_z_dim_, MaxpoolingComponent::pool_x_size_, MaxpoolingComponent::pool_x_step_, MaxpoolingComponent::pool_y_size_, MaxpoolingComponent::pool_y_step_, MaxpoolingComponent::pool_z_size_, MaxpoolingComponent::pool_z_step_, and kaldi::ReadBasicType().
|
inlinevirtual |
Returns a string such as "SigmoidComponent", describing the type of the object.
Implements Component.
Definition at line 502 of file nnet-combined-component.h.
Referenced by MaxpoolingComponent::Info().
|
virtual |
Write component to stream.
Implements Component.
Definition at line 929 of file nnet-combined-component.cc.
References MaxpoolingComponent::input_x_dim_, MaxpoolingComponent::input_y_dim_, MaxpoolingComponent::input_z_dim_, MaxpoolingComponent::pool_x_size_, MaxpoolingComponent::pool_x_step_, MaxpoolingComponent::pool_y_size_, MaxpoolingComponent::pool_y_step_, MaxpoolingComponent::pool_z_size_, MaxpoolingComponent::pool_z_step_, kaldi::WriteBasicType(), and kaldi::WriteToken().
|
protected |
Definition at line 536 of file nnet-combined-component.h.
Referenced by MaxpoolingComponent::Check(), MaxpoolingComponent::InderivPatchesToInderiv(), MaxpoolingComponent::Info(), MaxpoolingComponent::InitFromConfig(), MaxpoolingComponent::InputToInputPatches(), MaxpoolingComponent::OutputDim(), MaxpoolingComponent::Read(), and MaxpoolingComponent::Write().
|
protected |
Definition at line 538 of file nnet-combined-component.h.
Referenced by MaxpoolingComponent::Check(), MaxpoolingComponent::InderivPatchesToInderiv(), MaxpoolingComponent::Info(), MaxpoolingComponent::InitFromConfig(), MaxpoolingComponent::InputToInputPatches(), MaxpoolingComponent::OutputDim(), MaxpoolingComponent::Read(), and MaxpoolingComponent::Write().
|
protected |
Definition at line 540 of file nnet-combined-component.h.
Referenced by MaxpoolingComponent::Check(), MaxpoolingComponent::InderivPatchesToInderiv(), MaxpoolingComponent::Info(), MaxpoolingComponent::InitFromConfig(), MaxpoolingComponent::InputToInputPatches(), MaxpoolingComponent::OutputDim(), MaxpoolingComponent::Read(), and MaxpoolingComponent::Write().
|
protected |
Definition at line 543 of file nnet-combined-component.h.
Referenced by MaxpoolingComponent::Backprop(), MaxpoolingComponent::Check(), MaxpoolingComponent::InderivPatchesToInderiv(), MaxpoolingComponent::Info(), MaxpoolingComponent::InitFromConfig(), MaxpoolingComponent::InputToInputPatches(), MaxpoolingComponent::OutputDim(), MaxpoolingComponent::Propagate(), MaxpoolingComponent::Read(), and MaxpoolingComponent::Write().
|
protected |
Definition at line 547 of file nnet-combined-component.h.
Referenced by MaxpoolingComponent::Check(), MaxpoolingComponent::InderivPatchesToInderiv(), MaxpoolingComponent::Info(), MaxpoolingComponent::InitFromConfig(), MaxpoolingComponent::InputToInputPatches(), MaxpoolingComponent::OutputDim(), MaxpoolingComponent::Read(), and MaxpoolingComponent::Write().
|
protected |
Definition at line 544 of file nnet-combined-component.h.
Referenced by MaxpoolingComponent::Backprop(), MaxpoolingComponent::Check(), MaxpoolingComponent::InderivPatchesToInderiv(), MaxpoolingComponent::Info(), MaxpoolingComponent::InitFromConfig(), MaxpoolingComponent::InputToInputPatches(), MaxpoolingComponent::OutputDim(), MaxpoolingComponent::Propagate(), MaxpoolingComponent::Read(), and MaxpoolingComponent::Write().
|
protected |
Definition at line 549 of file nnet-combined-component.h.
Referenced by MaxpoolingComponent::Check(), MaxpoolingComponent::InderivPatchesToInderiv(), MaxpoolingComponent::Info(), MaxpoolingComponent::InitFromConfig(), MaxpoolingComponent::InputToInputPatches(), MaxpoolingComponent::OutputDim(), MaxpoolingComponent::Read(), and MaxpoolingComponent::Write().
|
protected |
Definition at line 545 of file nnet-combined-component.h.
Referenced by MaxpoolingComponent::Backprop(), MaxpoolingComponent::Check(), MaxpoolingComponent::InderivPatchesToInderiv(), MaxpoolingComponent::Info(), MaxpoolingComponent::InitFromConfig(), MaxpoolingComponent::InputToInputPatches(), MaxpoolingComponent::OutputDim(), MaxpoolingComponent::Propagate(), MaxpoolingComponent::Read(), and MaxpoolingComponent::Write().
|
protected |
Definition at line 551 of file nnet-combined-component.h.
Referenced by MaxpoolingComponent::Check(), MaxpoolingComponent::InderivPatchesToInderiv(), MaxpoolingComponent::Info(), MaxpoolingComponent::InitFromConfig(), MaxpoolingComponent::InputToInputPatches(), MaxpoolingComponent::OutputDim(), MaxpoolingComponent::Read(), and MaxpoolingComponent::Write().