Abstract base-class for neural-net components. More...

#include <nnet-component-itf.h>

Inheritance diagram for Component:

[legend]

Public Member Functions
virtual void *	Propagate (const ComponentPrecomputedIndexes indexes, const CuMatrixBase< BaseFloat > &in, CuMatrixBase< BaseFloat > out) const =0
	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 =0
	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	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	Type () const =0
	Returns a string such as "SigmoidComponent", describing the type of the object. More...

virtual void	InitFromConfig (ConfigLine *cfl)=0
	Initialize, from a ConfigLine object. More...

virtual int32	InputDim () const =0
	Returns input-dimension of this component. More...

virtual int32	OutputDim () const =0
	Returns output-dimension of this component. More...

virtual int32	Properties () const =0
	Return bitmask of the component's properties. More...

virtual Component *	Copy () const =0
	Copies component (deep copy). More...

virtual void	Read (std::istream &is, bool binary)=0
	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 =0
	Write component to stream. 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 ()

Static Public Member Functions
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...

Private Member Functions
	KALDI_DISALLOW_COPY_AND_ASSIGN (Component)

Detailed Description

Abstract base-class for neural-net components.

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

Constructor & Destructor Documentation

◆ Component()

Component ( )

inline

Definition at line 396 of file nnet-component-itf.h.

396 { }

◆ ~Component()

virtual ~Component ( )

inlinevirtual

Definition at line 398 of file nnet-component-itf.h.

References KALDI_DISALLOW_COPY_AND_ASSIGN.

398 { }

Member Function Documentation

◆ Add()

virtual void Add	(	BaseFloat	alpha,
		const Component &	other
	)

inlinevirtual

This virtual function when called by – an UpdatableComponent adds the parameters of another updatable component, times some constant, to the current parameters.

– a NonlinearComponent (or another component that stores stats, like BatchNormComponent)– it relates to adding stats. Otherwise it will normally do nothing.

Reimplemented in CompositeComponent, ScaleAndOffsetComponent, ConstantFunctionComponent, PerElementOffsetComponent, PerElementScaleComponent, PermuteComponent, ClipGradientComponent, LinearComponent, NaturalGradientAffineComponent, ConstantComponent, NonlinearComponent, RepeatedAffineComponent, BlockAffineComponent, TdnnComponent, TdnnComponent, BackpropTruncationComponent, AffineComponent, LstmNonlinearityComponent, TimeHeightConvolutionComponent, TimeHeightConvolutionComponent, BatchNormComponent, ConvolutionComponent, and RestrictedAttentionComponent.

Definition at line 370 of file nnet-component-itf.h.

Referenced by kaldi::nnet3::AddNnet(), kaldi::nnet3::AddNnetComponents(), kaldi::nnet3::ApplyL2Regularization(), BatchNormComponent::Copy(), ClipGradientComponent::Copy(), ScaleAndOffsetComponent::Copy(), ConstantComponent::IsComputable(), LinearComponent::LinearComponent(), NaturalGradientAffineComponent::NaturalGradientAffineComponent(), AffineComponent::Properties(), BackpropTruncationComponent::Properties(), BlockAffineComponent::Properties(), RepeatedAffineComponent::Properties(), PerElementScaleComponent::Properties(), PerElementOffsetComponent::Properties(), ConstantFunctionComponent::Properties(), kaldi::nnet3::TestNnetComponentAddScale(), and CompositeComponent::Type().

370 {};

◆ Backprop()

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

pure 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_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.

Implemented in CompositeComponent, ScaleAndOffsetComponent, ConstantFunctionComponent, PerElementOffsetComponent, PerElementScaleComponent, PermuteComponent, ClipGradientComponent, SumBlockComponent, NoOpComponent, FixedBiasComponent, FixedScaleComponent, SumGroupComponent, SpecAugmentTimeMaskComponent, FixedAffineComponent, LinearComponent, GeneralDropoutComponent, DropoutMaskComponent, LogSoftmaxComponent, SoftmaxComponent, ConstantComponent, RepeatedAffineComponent, BlockAffineComponent, MaxpoolingComponent, BackpropTruncationComponent, TdnnComponent, TdnnComponent, AffineComponent, StatisticsPoolingComponent, RectifiedLinearComponent, LstmNonlinearityComponent, TanhComponent, TimeHeightConvolutionComponent, TimeHeightConvolutionComponent, SigmoidComponent, StatisticsExtractionComponent, BatchNormComponent, ElementwiseProductComponent, ConvolutionComponent, RestrictedAttentionComponent, DropoutComponent, NormalizeComponent, DistributeComponent, and PnormComponent.

Referenced by NnetComputer::ExecuteCommand(), kaldi::nnet3::TestSimpleComponentDataDerivative(), kaldi::nnet3::TestSimpleComponentModelDerivative(), and kaldi::nnet3::TestSimpleComponentPropagateProperties().

◆ ConsolidateMemory()

virtual void ConsolidateMemory ( )

inlinevirtual

This virtual function relates to memory management, and avoiding fragmentation.

It is called only once per model, after we do the first minibatch of training. The default implementation does nothing, but it can be overridden by child classes, where it may re-initialize certain quantities that may possibly have been allocated during the forward pass (e.g. certain statistics; OnlineNaturalGradient objects). We use our own CPU-based allocator (see cu-allocator.h) and since it can't do paging since we're not in control of the GPU page table, fragmentation can be a problem. The allocator always tries to put things in 'low-address memory' (i.e. at smaller memory addresses) near the beginning of the block it allocated, to avoid fragmentation; but if permanent things (belonging to the model) are allocated in the forward pass, they can permanently stay in high memory. This function helps to prevent that, by re-allocating those things into low-address memory (It's important that it's called after all the temporary buffers for the forward-backward have been freed, so that there is low-address memory available)).

Reimplemented in ScaleAndOffsetComponent, NaturalGradientPerElementScaleComponent, ConstantFunctionComponent, LinearComponent, NaturalGradientAffineComponent, ConstantComponent, NaturalGradientRepeatedAffineComponent, NonlinearComponent, TdnnComponent, TdnnComponent, LstmNonlinearityComponent, TimeHeightConvolutionComponent, and TimeHeightConvolutionComponent.

Definition at line 394 of file nnet-component-itf.h.

Referenced by kaldi::nnet3::ConsolidateMemory(), ConstantComponent::IsComputable(), LinearComponent::LinearComponent(), NaturalGradientAffineComponent::NaturalGradientAffineComponent(), ScaleAndOffsetComponent::NumParameters(), LstmNonlinearityComponent::Properties(), ConstantFunctionComponent::Properties(), NaturalGradientRepeatedAffineComponent::Type(), and NaturalGradientPerElementScaleComponent::Type().

394 { }

◆ Copy()

virtual Component* Copy ( ) const

pure virtual

Copies component (deep copy).

Implemented in CompositeComponent, ScaleAndOffsetComponent, NaturalGradientPerElementScaleComponent, ConstantFunctionComponent, PerElementOffsetComponent, PerElementScaleComponent, PermuteComponent, ClipGradientComponent, SumBlockComponent, NoOpComponent, FixedBiasComponent, FixedScaleComponent, SumGroupComponent, SpecAugmentTimeMaskComponent, FixedAffineComponent, LinearComponent, GeneralDropoutComponent, NaturalGradientAffineComponent, DropoutMaskComponent, LogSoftmaxComponent, SoftmaxComponent, ConstantComponent, NaturalGradientRepeatedAffineComponent, RepeatedAffineComponent, BlockAffineComponent, MaxpoolingComponent, BackpropTruncationComponent, TdnnComponent, TdnnComponent, AffineComponent, StatisticsPoolingComponent, LstmNonlinearityComponent, RectifiedLinearComponent, TanhComponent, TimeHeightConvolutionComponent, TimeHeightConvolutionComponent, StatisticsExtractionComponent, SigmoidComponent, BatchNormComponent, ElementwiseProductComponent, ConvolutionComponent, RestrictedAttentionComponent, DropoutComponent, DistributeComponent, NormalizeComponent, and PnormComponent.

Referenced by ModelCollapser::GetDiagonallyPreModifiedComponentIndex(), ModelCollapser::GetScaledComponentIndex(), kaldi::nnet3::TestNnetComponentAddScale(), kaldi::nnet3::TestNnetComponentCopy(), kaldi::nnet3::TestNnetComponentUpdatable(), kaldi::nnet3::TestNnetComponentVectorizeUnVectorize(), kaldi::nnet3::TestSimpleComponentModelDerivative(), and kaldi::nnet3::TestSimpleComponentPropagateProperties().

◆ DeleteMemo()

virtual void DeleteMemo ( void * memo ) const

inlinevirtual

This virtual function only needs to be overwritten by Components that return a non-NULL memo from their Propagate() function.

It's called by NnetComputer in cases where Propagate returns a memo but there will be no backprop to consume it.

Reimplemented in SpecAugmentTimeMaskComponent, GeneralDropoutComponent, BatchNormComponent, and RestrictedAttentionComponent.

Definition at line 376 of file nnet-component-itf.h.

References KALDI_ASSERT.

Referenced by NnetComputer::ExecuteCommand(), NnetComputer::SaveMemo(), kaldi::nnet3::TestSimpleComponentDataDerivative(), kaldi::nnet3::TestSimpleComponentModelDerivative(), and kaldi::nnet3::TestSimpleComponentPropagateProperties().

376 { KALDI_ASSERT(memo == NULL); }

KALDI_ASSERT

#define KALDI_ASSERT(cond)

Definition: kaldi-error.h:185

◆ 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_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 in DropoutMaskComponent, ConstantComponent, TdnnComponent, TdnnComponent, StatisticsPoolingComponent, TimeHeightConvolutionComponent, TimeHeightConvolutionComponent, StatisticsExtractionComponent, RestrictedAttentionComponent, and DistributeComponent.

Definition at line 206 of file nnet-component-itf.cc.

Referenced by ComputationGraphBuilder::AddDependencies(), and kaldi::nnet3::ComputeComputationGraph().

                                                                        {
   input_indexes->resize(1);
   (*input_indexes)[0] = output_index;
 }

◆ Info()

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 in CompositeComponent, ScaleAndOffsetComponent, NaturalGradientPerElementScaleComponent, ConstantFunctionComponent, PerElementOffsetComponent, PerElementScaleComponent, PermuteComponent, ClipGradientComponent, SumBlockComponent, NoOpComponent, FixedBiasComponent, FixedScaleComponent, SpecAugmentTimeMaskComponent, FixedAffineComponent, LinearComponent, GeneralDropoutComponent, NaturalGradientAffineComponent, DropoutMaskComponent, ConstantComponent, NonlinearComponent, RepeatedAffineComponent, UpdatableComponent, BackpropTruncationComponent, BlockAffineComponent, MaxpoolingComponent, TdnnComponent, TdnnComponent, AffineComponent, LstmNonlinearityComponent, TimeHeightConvolutionComponent, TimeHeightConvolutionComponent, BatchNormComponent, DropoutComponent, ConvolutionComponent, RestrictedAttentionComponent, and NormalizeComponent.

Definition at line 199 of file nnet-component-itf.cc.

References ComponentPrecomputedIndexes::Type().

                                 {
   std::stringstream stream;
   stream << Type() << ", input-dim=" << InputDim()
          << ", output-dim=" << OutputDim();
   return stream.str();
 }

◆ InitFromConfig()

virtual void InitFromConfig ( ConfigLine * cfl )

pure virtual

Initialize, from a ConfigLine object.

Parameters

[in] cfl A ConfigLine containing any parameters that are needed for initialization. For example: "dim=100 param-stddev=0.1"

Implemented in CompositeComponent, ScaleAndOffsetComponent, NaturalGradientPerElementScaleComponent, ConstantFunctionComponent, PerElementOffsetComponent, PerElementScaleComponent, PermuteComponent, ClipGradientComponent, SumBlockComponent, NoOpComponent, FixedBiasComponent, FixedScaleComponent, SumGroupComponent, SpecAugmentTimeMaskComponent, FixedAffineComponent, LinearComponent, GeneralDropoutComponent, NaturalGradientAffineComponent, DropoutMaskComponent, ConstantComponent, NonlinearComponent, RepeatedAffineComponent, BlockAffineComponent, MaxpoolingComponent, BackpropTruncationComponent, TdnnComponent, TdnnComponent, AffineComponent, StatisticsPoolingComponent, LstmNonlinearityComponent, TimeHeightConvolutionComponent, TimeHeightConvolutionComponent, StatisticsExtractionComponent, BatchNormComponent, ElementwiseProductComponent, ConvolutionComponent, RestrictedAttentionComponent, DropoutComponent, NormalizeComponent, DistributeComponent, and PnormComponent.

Referenced by kaldi::nnet3::GenerateRandomSimpleComponent(), CompositeComponent::InitFromConfig(), and Nnet::ProcessComponentConfigLine().

◆ InputDim()

virtual int32 InputDim ( ) const

pure virtual

Returns input-dimension of this component.

Implemented in CompositeComponent, ScaleAndOffsetComponent, ConstantFunctionComponent, PerElementOffsetComponent, PerElementScaleComponent, PermuteComponent, ClipGradientComponent, SumBlockComponent, NoOpComponent, FixedBiasComponent, FixedScaleComponent, SumGroupComponent, SpecAugmentTimeMaskComponent, FixedAffineComponent, LinearComponent, GeneralDropoutComponent, DropoutMaskComponent, ConstantComponent, NonlinearComponent, RepeatedAffineComponent, BlockAffineComponent, MaxpoolingComponent, BackpropTruncationComponent, TdnnComponent, TdnnComponent, AffineComponent, StatisticsPoolingComponent, LstmNonlinearityComponent, TimeHeightConvolutionComponent, TimeHeightConvolutionComponent, StatisticsExtractionComponent, BatchNormComponent, ElementwiseProductComponent, ConvolutionComponent, RestrictedAttentionComponent, DropoutComponent, NormalizeComponent, DistributeComponent, and PnormComponent.

Referenced by Nnet::Check(), ComputationChecker::CheckComputationIndexes(), UpdatableComponent::Info(), kaldi::nnet3::TestSimpleComponentDataDerivative(), kaldi::nnet3::TestSimpleComponentModelDerivative(), and kaldi::nnet3::TestSimpleComponentPropagateProperties().

◆ 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_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.

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 in DropoutMaskComponent, ConstantComponent, TdnnComponent, TdnnComponent, StatisticsPoolingComponent, TimeHeightConvolutionComponent, TimeHeightConvolutionComponent, StatisticsExtractionComponent, RestrictedAttentionComponent, and DistributeComponent.

Definition at line 213 of file nnet-component-itf.cc.

Referenced by ComputationGraphBuilder::ComputeComputableInfo(), and ComputationGraphBuilder::PruneDependencies().

                                                                   {
   // the default Component dependency is for an output index to map directly to
   // the same input index, which is required to compute the output.
   if (!input_index_set(output_index))
     return false;
   if (used_inputs) {
     used_inputs->clear();
     used_inputs->push_back(output_index);
   }
   return true;
 }

◆ KALDI_DISALLOW_COPY_AND_ASSIGN()

KALDI_DISALLOW_COPY_AND_ASSIGN ( Component )

private

Referenced by SumGroupComponent::Properties().

◆ NewComponentOfType()

Component * NewComponentOfType ( const std::string & type )

static

Returns a new Component of the given type e.g.

"SoftmaxComponent", or NULL if no such component type exists.

Definition at line 98 of file nnet-component-itf.cc.

References KALDI_ASSERT, and Component::Type().

Referenced by kaldi::nnet3::GenerateRandomSimpleComponent(), CompositeComponent::InitFromConfig(), and Nnet::ProcessComponentConfigLine().

                                                                         {
   Component *ans = NULL;
   if (component_type == "SigmoidComponent") {
     ans = new SigmoidComponent();
   } else if (component_type == "TanhComponent") {
     ans = new TanhComponent();
   } else if (component_type == "SoftmaxComponent") {
     ans = new SoftmaxComponent();
   } else if (component_type == "LogSoftmaxComponent") {
     ans = new LogSoftmaxComponent();
   } else if (component_type == "RectifiedLinearComponent") {
     ans = new RectifiedLinearComponent();
   } else if (component_type == "NormalizeComponent") {
     ans = new NormalizeComponent();
   } else if (component_type == "PnormComponent") {
     ans = new PnormComponent();
   } else if (component_type == "AffineComponent") {
     ans = new AffineComponent();
   } else if (component_type == "LinearComponent") {
     ans = new LinearComponent();
   } else if (component_type == "NaturalGradientAffineComponent") {
     ans = new NaturalGradientAffineComponent();
   } else if (component_type == "PerElementScaleComponent") {
     ans = new PerElementScaleComponent();
   } else if (component_type == "NaturalGradientPerElementScaleComponent") {
     ans = new NaturalGradientPerElementScaleComponent();
   } else if (component_type == "PerElementOffsetComponent") {
     ans = new PerElementOffsetComponent();
   } else if (component_type == "SumGroupComponent") {
     ans = new SumGroupComponent();
   } else if (component_type == "FixedAffineComponent") {
     ans = new FixedAffineComponent();
   } else if (component_type == "FixedScaleComponent") {
     ans = new FixedScaleComponent();
   } else if (component_type == "FixedBiasComponent") {
     ans = new FixedBiasComponent();
   } else if (component_type == "NoOpComponent") {
     ans = new NoOpComponent();
   } else if (component_type == "ClipGradientComponent") {
     ans = new ClipGradientComponent();
   } else if (component_type == "ElementwiseProductComponent") {
     ans = new ElementwiseProductComponent();
   } else if (component_type == "ConvolutionComponent") {
     ans = new ConvolutionComponent();
   } else if (component_type == "TdnnComponent") {
     ans = new TdnnComponent();
   } else if (component_type == "MaxpoolingComponent") {
     ans = new MaxpoolingComponent();
   } else if (component_type == "PermuteComponent") {
     ans = new PermuteComponent();
   } else if (component_type == "DistributeComponent") {
     ans = new DistributeComponent();
   } else if (component_type == "CompositeComponent") {
     ans = new CompositeComponent();
   } else if (component_type == "RepeatedAffineComponent") {
     ans = new RepeatedAffineComponent();
   } else if (component_type == "BlockAffineComponent") {
     ans = new BlockAffineComponent();
   } else if (component_type == "NaturalGradientRepeatedAffineComponent") {
     ans = new NaturalGradientRepeatedAffineComponent();
   } else if (component_type == "StatisticsExtractionComponent") {
     ans = new StatisticsExtractionComponent();
   } else if (component_type == "StatisticsPoolingComponent") {
     ans = new StatisticsPoolingComponent();
   } else if (component_type == "ConstantFunctionComponent") {
     ans = new ConstantFunctionComponent();
   } else if (component_type == "ConstantComponent") {
     ans = new ConstantComponent();
   } else if (component_type == "DropoutComponent") {
     ans = new DropoutComponent();
   } else if (component_type == "DropoutMaskComponent") {
     ans = new DropoutMaskComponent();
   } else if (component_type == "GeneralDropoutComponent") {
     ans = new GeneralDropoutComponent();
   } else if (component_type == "SpecAugmentTimeMaskComponent") {
     ans = new SpecAugmentTimeMaskComponent();
   } else if (component_type == "BackpropTruncationComponent") {
     ans = new BackpropTruncationComponent();
   } else if (component_type == "LstmNonlinearityComponent") {
     ans = new LstmNonlinearityComponent();
   } else if (component_type == "BatchNormComponent") {
     ans = new BatchNormComponent();
   } else if (component_type == "TimeHeightConvolutionComponent") {
     ans = new TimeHeightConvolutionComponent();
   } else if (component_type == "RestrictedAttentionComponent") {
     ans = new RestrictedAttentionComponent();
   } else if (component_type == "SumBlockComponent") {
     ans = new SumBlockComponent();
   } else if (component_type == "GruNonlinearityComponent") {
     ans = new GruNonlinearityComponent();
   } else if (component_type == "OutputGruNonlinearityComponent") {
     ans = new OutputGruNonlinearityComponent();
   } else if (component_type == "ScaleAndOffsetComponent") {
     ans = new ScaleAndOffsetComponent();
   }
   if (ans != NULL) {
     KALDI_ASSERT(component_type == ans->Type());
   }
   return ans;
 }

◆ OutputDim()

virtual int32 OutputDim ( ) const

pure virtual

Returns output-dimension of this component.

Implemented in CompositeComponent, ScaleAndOffsetComponent, ConstantFunctionComponent, PerElementOffsetComponent, PerElementScaleComponent, PermuteComponent, ClipGradientComponent, SumBlockComponent, NoOpComponent, FixedBiasComponent, FixedScaleComponent, SumGroupComponent, SpecAugmentTimeMaskComponent, FixedAffineComponent, LinearComponent, GeneralDropoutComponent, DropoutMaskComponent, ConstantComponent, NonlinearComponent, RepeatedAffineComponent, BlockAffineComponent, MaxpoolingComponent, BackpropTruncationComponent, TdnnComponent, TdnnComponent, AffineComponent, StatisticsPoolingComponent, LstmNonlinearityComponent, TimeHeightConvolutionComponent, TimeHeightConvolutionComponent, StatisticsExtractionComponent, BatchNormComponent, ElementwiseProductComponent, ConvolutionComponent, RestrictedAttentionComponent, DropoutComponent, NormalizeComponent, DistributeComponent, and PnormComponent.

Referenced by ComputationChecker::CheckComputationIndexes(), NetworkNode::Dim(), UpdatableComponent::Info(), kaldi::nnet3::TestSimpleComponentDataDerivative(), kaldi::nnet3::TestSimpleComponentModelDerivative(), and kaldi::nnet3::TestSimpleComponentPropagateProperties().

◆ PrecomputeIndexes()

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

inlinevirtual

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_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.

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 in SpecAugmentTimeMaskComponent, GeneralDropoutComponent, TdnnComponent, TdnnComponent, BackpropTruncationComponent, StatisticsPoolingComponent, TimeHeightConvolutionComponent, TimeHeightConvolutionComponent, StatisticsExtractionComponent, RestrictedAttentionComponent, and DistributeComponent.

Definition at line 302 of file nnet-component-itf.h.

References ComponentPrecomputedIndexes::Copy(), ComponentPrecomputedIndexes::Read(), ComponentPrecomputedIndexes::ReadNew(), ComponentPrecomputedIndexes::Type(), and ComponentPrecomputedIndexes::Write().

Referenced by ComputationExpander::ComputePrecomputedIndexes(), kaldi::nnet3::GetPrecomputedIndexes(), and Compiler::SetUpPrecomputedIndexes().

306 { return NULL; }

◆ Propagate()

virtual void* Propagate	(	const ComponentPrecomputedIndexes *	indexes,
		const CuMatrixBase< BaseFloat > &	in,
		CuMatrixBase< BaseFloat > *	out
	)		const

pure virtual

Propagate function.

Parameters

[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.

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.

Implemented in CompositeComponent, ScaleAndOffsetComponent, ConstantFunctionComponent, PerElementOffsetComponent, PerElementScaleComponent, PermuteComponent, ClipGradientComponent, SumBlockComponent, NoOpComponent, FixedBiasComponent, FixedScaleComponent, SumGroupComponent, SpecAugmentTimeMaskComponent, FixedAffineComponent, LinearComponent, GeneralDropoutComponent, DropoutMaskComponent, LogSoftmaxComponent, SoftmaxComponent, ConstantComponent, RepeatedAffineComponent, BlockAffineComponent, MaxpoolingComponent, BackpropTruncationComponent, TdnnComponent, TdnnComponent, AffineComponent, StatisticsPoolingComponent, RectifiedLinearComponent, LstmNonlinearityComponent, TanhComponent, TimeHeightConvolutionComponent, TimeHeightConvolutionComponent, SigmoidComponent, StatisticsExtractionComponent, BatchNormComponent, ElementwiseProductComponent, ConvolutionComponent, RestrictedAttentionComponent, DropoutComponent, NormalizeComponent, DistributeComponent, and PnormComponent.

Referenced by NnetComputer::ExecuteCommand(), FixedBiasComponent::OutputDim(), kaldi::nnet3::TestSimpleComponentDataDerivative(), kaldi::nnet3::TestSimpleComponentModelDerivative(), and kaldi::nnet3::TestSimpleComponentPropagateProperties().

◆ Properties()

virtual int32 Properties ( ) const

pure virtual

Return bitmask of the component's properties.

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

Implemented in CompositeComponent, ScaleAndOffsetComponent, ConstantFunctionComponent, PerElementOffsetComponent, PerElementScaleComponent, PermuteComponent, ClipGradientComponent, SumBlockComponent, NoOpComponent, FixedBiasComponent, FixedScaleComponent, SumGroupComponent, SpecAugmentTimeMaskComponent, FixedAffineComponent, LinearComponent, GeneralDropoutComponent, DropoutMaskComponent, LogSoftmaxComponent, SoftmaxComponent, ConstantComponent, RepeatedAffineComponent, BlockAffineComponent, MaxpoolingComponent, BackpropTruncationComponent, TdnnComponent, TdnnComponent, AffineComponent, StatisticsPoolingComponent, RectifiedLinearComponent, LstmNonlinearityComponent, TanhComponent, TimeHeightConvolutionComponent, TimeHeightConvolutionComponent, SigmoidComponent, StatisticsExtractionComponent, BatchNormComponent, ElementwiseProductComponent, ConvolutionComponent, RestrictedAttentionComponent, DropoutComponent, NormalizeComponent, DistributeComponent, and PnormComponent.

Referenced by Compiler::AddBackwardStepComponent(), Compiler::AddForwardStepComponent(), kaldi::nnet3::AddNnetComponents(), kaldi::nnet3::ApplyL2Regularization(), ComputationChecker::CheckComputationIndexes(), kaldi::nnet3::ComponentDotProducts(), kaldi::nnet3::ComputeCommandAttributes(), Compiler::ComputeDerivNeeded(), ModelUpdateConsolidator::ConsolidateModelUpdate(), ModelUpdateConsolidator::ConsolidateUpdateForComponent(), NnetComputer::DebugAfterExecute(), NnetComputer::DebugBeforeExecute(), kaldi::nnet3::DotProduct(), NnetComputer::ExecuteCommand(), kaldi::nnet3::FreezeNaturalGradient(), kaldi::nnet3::GetPrecomputedIndexes(), Compiler::GetStrideType(), CompositeComponent::InitFromConfig(), VariableMergingOptimizer::MergeVariables(), DerivativeTimeLimiter::ModifyCommand(), kaldi::nnet3::NnetParametersAreIdentical(), kaldi::nnet3::NumParameters(), kaldi::nnet3::NumUpdatableComponents(), kaldi::nnet3::PerturbParams(), MaxChangeStats::Print(), kaldi::nnet3::PrintVectorPerUpdatableComponent(), ComputationStepsComputer::ProcessComponentStep(), kaldi::nnet3::SetLearningRate(), kaldi::nnet3::SetNnetAsGradient(), kaldi::nnet3::TestNnetComponentUpdatable(), kaldi::nnet3::TestNnetComponentVectorizeUnVectorize(), kaldi::nnet3::TestSimpleComponentDataDerivative(), kaldi::nnet3::TestSimpleComponentModelDerivative(), kaldi::nnet3::TestSimpleComponentPropagateProperties(), kaldi::nnet3::UnVectorizeNnet(), kaldi::nnet3::UpdateNnetWithMaxChange(), and kaldi::nnet3::VectorizeNnet().

◆ Read()

virtual void Read	(	std::istream &	is,
		bool	binary
	)

pure 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.

Implemented in CompositeComponent, ScaleAndOffsetComponent, NaturalGradientPerElementScaleComponent, ConstantFunctionComponent, PerElementOffsetComponent, PerElementScaleComponent, PermuteComponent, ClipGradientComponent, SumBlockComponent, NoOpComponent, FixedBiasComponent, FixedScaleComponent, SumGroupComponent, SpecAugmentTimeMaskComponent, FixedAffineComponent, LinearComponent, GeneralDropoutComponent, NaturalGradientAffineComponent, DropoutMaskComponent, ConstantComponent, NonlinearComponent, RepeatedAffineComponent, BlockAffineComponent, MaxpoolingComponent, BackpropTruncationComponent, TdnnComponent, TdnnComponent, AffineComponent, StatisticsPoolingComponent, LstmNonlinearityComponent, TimeHeightConvolutionComponent, TimeHeightConvolutionComponent, StatisticsExtractionComponent, BatchNormComponent, ElementwiseProductComponent, ConvolutionComponent, RestrictedAttentionComponent, DropoutComponent, NormalizeComponent, DistributeComponent, and PnormComponent.

Referenced by Component::ReadNew().

◆ ReadNew()

Component * ReadNew	(	std::istream &	is,
		bool	binary
	)

static

Read component from stream (works out its type). Dies on error.

Definition at line 84 of file nnet-component-itf.cc.

References KALDI_ERR, Component::Read(), and kaldi::ReadToken().

Referenced by Nnet::Read(), CompositeComponent::Read(), and kaldi::nnet3::TestNnetComponentIo().

                                                          {
   std::string token;
   ReadToken(is, binary, &token); // e.g. "<SigmoidComponent>".
   token.erase(0, 1); // erase "<".
   token.erase(token.length()-1); // erase ">".
   Component *ans = NewComponentOfType(token);
   if (!ans)
     KALDI_ERR << "Unknown component type " << token;
   ans->Read(is, binary);
   return ans;
 }

◆ ReorderIndexes()

virtual void ReorderIndexes	(	std::vector< Index > *	input_indexes,
		std::vector< Index > *	output_indexes
	)		const

inlinevirtual

This function only does something interesting for non-simple Components.

It provides an opportunity for a Component to reorder the or pad the indexes at its input and output. This might be useful, for instance, if a component requires a particular ordering of the indexes that doesn't correspond to their natural ordering. Components that might modify the indexes are required to return the kReordersIndexes flag in their Properties(). The ReorderIndexes() function is now allowed to insert blanks into the indexes. The 'blanks' must be of the form (n,kNoTime,x), where the marker kNoTime (a very negative number) is there where the 't' indexes normally live. The reason we don't just have, say, (-1,-1,-1), relates to the need to preserve a regular pattern over the 'n' indexes so that 'shortcut compilation' (c.f. ExpandComputation()) can work correctly

Parameters

[in,out]	Indexes	at the input of the Component.
[in,out]	Indexes	at the output of the Component

Reimplemented in TdnnComponent, TdnnComponent, StatisticsPoolingComponent, TimeHeightConvolutionComponent, TimeHeightConvolutionComponent, StatisticsExtractionComponent, and RestrictedAttentionComponent.

Definition at line 272 of file nnet-component-itf.h.

Referenced by StatisticsExtractionComponent::Copy(), StatisticsPoolingComponent::Copy(), kaldi::nnet3::GetPrecomputedIndexes(), and ComputationStepsComputer::ProcessComponentStep().

273 {}

◆ Scale()

virtual void Scale ( BaseFloat scale )

inlinevirtual

This virtual function when called on – an UpdatableComponent scales the parameters by "scale" when called by an UpdatableComponent.

– a Nonlinear component (or another component that stores stats, like BatchNormComponent)– it relates to scaling activation stats, not parameters. Otherwise it will normally do nothing.

Reimplemented in CompositeComponent, ScaleAndOffsetComponent, ConstantFunctionComponent, PerElementOffsetComponent, PerElementScaleComponent, PermuteComponent, ClipGradientComponent, LinearComponent, NaturalGradientAffineComponent, ConstantComponent, NonlinearComponent, RepeatedAffineComponent, BlockAffineComponent, TdnnComponent, TdnnComponent, BackpropTruncationComponent, AffineComponent, LstmNonlinearityComponent, TimeHeightConvolutionComponent, TimeHeightConvolutionComponent, BatchNormComponent, ConvolutionComponent, and RestrictedAttentionComponent.

Definition at line 360 of file nnet-component-itf.h.

Referenced by BatchNormComponent::Copy(), ClipGradientComponent::Copy(), ScaleAndOffsetComponent::Copy(), ConstantComponent::IsComputable(), LinearComponent::LinearComponent(), NaturalGradientAffineComponent::NaturalGradientAffineComponent(), AffineComponent::Properties(), BackpropTruncationComponent::Properties(), BlockAffineComponent::Properties(), RepeatedAffineComponent::Properties(), PerElementScaleComponent::Properties(), PerElementOffsetComponent::Properties(), ConstantFunctionComponent::Properties(), kaldi::nnet3::ScaleNnet(), kaldi::nnet3::TestNnetComponentAddScale(), kaldi::nnet3::TestNnetComponentUpdatable(), kaldi::nnet3::TestNnetComponentVectorizeUnVectorize(), kaldi::nnet3::TestSimpleComponentModelDerivative(), and CompositeComponent::Type().

360 {};

◆ StoreStats()

virtual void StoreStats	(	const CuMatrixBase< BaseFloat > &	in_value,
		const CuMatrixBase< BaseFloat > &	out_value,
		void *	memo
	)

inlinevirtual

This function may store stats on average activation values, and for some component types, the average value of the derivative of the nonlinearity.

It only does something for those components that have nonzero Properties()&kStoresStats.

Parameters

[in]	in_value	The input to the Propagate() function. Note: if the component sets the flag kPropagateInPlace, this should not be used; the empty matrix will be provided here if in-place propagation was used.
[in]	out_value	The output of the Propagate() function.
[in]	memo	The 'memo' returned by the Propagate() function; this will usually be NULL.