NnetExample Struct Reference

NnetExample is the input data and corresponding label (or labels) for one or more frames of input, used for standard cross-entropy training of neural nets (and possibly for other objective functions). More...

#include <nnet-example.h>

Collaboration diagram for NnetExample:

Public Member Functions
void	Write (std::ostream &os, bool binary) const
void	Read (std::istream &is, bool binary)
	NnetExample ()
	NnetExample (const NnetExample &other)
void	Swap (NnetExample *other)
void	Compress ()
	Compresses any (input) features that are not sparse. More...
bool	operator== (const NnetExample &other) const
	Caution: this operator == is not very efficient. More...

Public Attributes
std::vector< NnetIo >	io
	"io" contains the input and output. More...

Detailed Description

NnetExample is the input data and corresponding label (or labels) for one or more frames of input, used for standard cross-entropy training of neural nets (and possibly for other objective functions).

Definition at line 111 of file nnet-example.h.

Constructor & Destructor Documentation

NnetExample() [1/2]

NnetExample ( )

inline

Definition at line 121 of file nnet-example.h.

{ }

NnetExample() [2/2]

NnetExample ( const NnetExample &  other )

inline

Definition at line 123 of file nnet-example.h.

: io(other.io) { }

Member Function Documentation

Compress()

void Compress

(

)

Compresses any (input) features that are not sparse.

Definition at line 130 of file nnet-example.cc.

Referenced by kaldi::nnet3::ProcessFile(), and kaldi::nnet3::WriteExamples().

                           {
  std::vector<NnetIo>::iterator iter = io.begin(), end = io.end();
  // calling features.Compress() will do nothing if they are sparse or already
  // compressed.
  for (; iter != end; ++iter)
    iter->features.Compress();
}

operator==()

bool operator== ( const NnetExample &  other ) const

inline

Caution: this operator == is not very efficient.

It's only used in testing code.

Definition at line 132 of file nnet-example.h.

References NnetExample::io.

{ return io == other.io; }

Read()

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

Definition at line 116 of file nnet-example.cc.

References kaldi::nnet3::ExpectToken(), rnnlm::i, KALDI_ERR, NnetIo::Read(), and kaldi::ReadBasicType().

Referenced by kaldi::nnet3::UnitTestNnetExample().

                                                  {
  ExpectToken(is, binary, "<Nnet3Eg>");
  ExpectToken(is, binary, "<NumIo>");
  int32 size;
  ReadBasicType(is, binary, &size);
  if (size <= 0 || size > 1000000)
    KALDI_ERR << "Invalid size " << size;
  io.resize(size);
  for (int32 i = 0; i < size; i++)
    io[i].Read(is, binary);
  ExpectToken(is, binary, "</Nnet3Eg>");
}

Swap()

void Swap ( NnetExample *  other )

inline

Definition at line 125 of file nnet-example.h.

References NnetExample::io.

{ io.swap(other->io); }

Write()

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

Definition at line 103 of file nnet-example.cc.

References rnnlm::i, KALDI_ASSERT, NnetIo::Write(), kaldi::WriteBasicType(), and kaldi::WriteToken().

Referenced by kaldi::nnet3::UnitTestNnetExample(), and kaldi::nnet3::UnitTestNnetMergeExamples().

                                                         {
  // Note: weight, label, input_frames and spk_info are members.  This is a
  // struct.
  WriteToken(os, binary, "<Nnet3Eg>");
  WriteToken(os, binary, "<NumIo>");
  int32 size = io.size();
  KALDI_ASSERT(size > 0 && "Writing empty nnet example");
  WriteBasicType(os, binary, size);
  for (int32 i = 0; i < size; i++)
    io[i].Write(os, binary);
  WriteToken(os, binary, "</Nnet3Eg>");
}

Member Data Documentation

io

std::vector<NnetIo> io

"io" contains the input and output.

In principle there can be multiple types of both input and output, with different names. The order is irrelevant.

Definition at line 116 of file nnet-example.h.

Referenced by NnetLdaStatsAccumulator::AccStats(), NnetLdaStatsAccumulator::AccStatsFromOutput(), NnetComputerFromEg::Compute(), NnetComputeProb::Compute(), kaldi::nnet3::ContainsSingleExample(), kaldi::nnet3::ExampleApproxEqual(), kaldi::nnet3::FilterExample(), kaldi::nnet3::GenerateSimpleNnetTrainingExample(), kaldi::nnet3::GetComputationRequest(), kaldi::nnet3::GetNnetExampleSize(), main(), kaldi::nnet3::MergeChainExamples(), kaldi::nnet3::MergeDiscriminativeExamples(), kaldi::nnet3::MergeIo(), kaldi::nnet3::NumOutputIndexes(), NnetExampleStructureCompare::operator()(), NnetExample::operator==(), kaldi::nnet3::PerturbImageInNnetExample(), kaldi::nnet3::ProcessFile(), NnetComputeProb::ProcessOutputs(), NnetTrainer::ProcessOutputs(), kaldi::nnet3::RenameOutputs(), kaldi::nnet3::ScaleSupervisionWeight(), kaldi::nnet3::ShiftExampleTimes(), NnetExample::Swap(), NnetTrainer::TrainInternal(), NnetTrainer::TrainInternalBackstitch(), and kaldi::nnet3::WriteExamples().

---

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

• nnet3/nnet-example.h
• nnet3/nnet-example.cc