#include <series.h>

Inheritance diagram for tesseract::Series:

Public Member Functions
	Series (const STRING &name)

virtual	~Series ()

virtual StaticShape	OutputShape (const StaticShape &input_shape) const

virtual STRING	spec () const

virtual int	InitWeights (float range, TRand *randomizer)

int	RemapOutputs (int old_no, const std::vector< int > &code_map) override

virtual bool	SetupNeedsBackprop (bool needs_backprop)

virtual int	XScaleFactor () const

virtual void	CacheXScaleFactor (int factor)

virtual void	Forward (bool debug, const NetworkIO &input, const TransposedArray input_transpose, NetworkScratch scratch, NetworkIO *output)

virtual bool	Backward (bool debug, const NetworkIO &fwd_deltas, NetworkScratch scratch, NetworkIO back_deltas)

void	SplitAt (int last_start, Series start, Series end)

void	AppendSeries (Network *src)

Public Member Functions inherited from tesseract::Plumbing
	Plumbing (const STRING &name)

virtual	~Plumbing ()

virtual StaticShape	InputShape () const

virtual bool	IsPlumbingType () const

virtual void	SetEnableTraining (TrainingState state)

virtual void	SetNetworkFlags (uinT32 flags)

virtual void	ConvertToInt ()

virtual void	SetRandomizer (TRand *randomizer)

virtual void	AddToStack (Network *network)

virtual void	DebugWeights ()

const PointerVector< Network > &	stack () const

void	EnumerateLayers (const STRING prefix, GenericVector< STRING > layers) const

Network *	GetLayer (const char *id) const

float	LayerLearningRate (const char *id) const

void	ScaleLayerLearningRate (const char *id, double factor)

float *	LayerLearningRatePtr (const char *id) const

virtual bool	Serialize (TFile *fp) const

virtual bool	DeSerialize (TFile *fp)

void	Update (float learning_rate, float momentum, float adam_beta, int num_samples) override

virtual void	CountAlternators (const Network &other, double same, double changed) const

Public Member Functions inherited from tesseract::Network
	Network ()

	Network (NetworkType type, const STRING &name, int ni, int no)

virtual	~Network ()

NetworkType	type () const

bool	IsTraining () const

bool	needs_to_backprop () const

int	num_weights () const

int	NumInputs () const

int	NumOutputs () const

const STRING &	name () const

bool	TestFlag (NetworkFlags flag) const

void	DisplayForward (const NetworkIO &matrix)

void	DisplayBackward (const NetworkIO &matrix)

Additional Inherited Members
Static Public Member Functions inherited from tesseract::Network
static Network *	CreateFromFile (TFile *fp)

static void	ClearWindow (bool tess_coords, const char window_name, int width, int height, ScrollView *window)

static int	DisplayImage (Pix pix, ScrollView window)

Protected Member Functions inherited from tesseract::Network
double	Random (double range)

Protected Attributes inherited from tesseract::Plumbing
PointerVector< Network >	stack_

GenericVector< float >	learning_rates_

Protected Attributes inherited from tesseract::Network
NetworkType	type_

TrainingState	training_

bool	needs_to_backprop_

inT32	network_flags_

inT32	ni_

inT32	no_

inT32	num_weights_

STRING	name_

ScrollView *	forward_win_

ScrollView *	backward_win_

TRand *	randomizer_

Static Protected Attributes inherited from tesseract::Network
static char const *const	kTypeNames [NT_COUNT]

Detailed Description

Definition at line 27 of file series.h.

Constructor & Destructor Documentation

◆ Series()

tesseract::Series::Series ( const STRING & name )

explicit

Definition at line 29 of file series.cpp.

                                  : Plumbing(name) {
   type_ = NT_SERIES;
 }

◆ ~Series()

tesseract::Series::~Series ( )

virtual

Definition at line 33 of file series.cpp.

33 {

34 }

Member Function Documentation

◆ AppendSeries()

void tesseract::Series::AppendSeries ( Network * src )

Definition at line 193 of file series.cpp.

                                       {
   ASSERT_HOST(src->type() == NT_SERIES);
   Series* src_series = static_cast<Series*>(src);
   for (int s = 0; s < src_series->stack_.size(); ++s) {
     AddToStack(src_series->stack_[s]);
     src_series->stack_[s] = NULL;
   }
   delete src;
 }

◆ Backward()

bool tesseract::Series::Backward	(	bool	debug,
		const NetworkIO &	fwd_deltas,
		NetworkScratch *	scratch,
		NetworkIO *	back_deltas
	)

virtual

Reimplemented from tesseract::Network.

Definition at line 132 of file series.cpp.

                                               {
   if (!IsTraining()) return false;
   int stack_size = stack_.size();
   ASSERT_HOST(stack_size > 1);
   // Revolving intermediate buffers.
   NetworkScratch::IO buffer1(fwd_deltas, scratch);
   NetworkScratch::IO buffer2(fwd_deltas, scratch);
   // Run each network in reverse order, giving the back_deltas output of n as
   // the fwd_deltas input to n-1, with the 0 network providing the real output.
   if (!stack_.back()->IsTraining() ||
       !stack_.back()->Backward(debug, fwd_deltas, scratch, buffer1))
     return false;
   for (int i = stack_size - 2; i >= 0; i -= 2) {
     if (!stack_[i]->IsTraining() ||
         !stack_[i]->Backward(debug, *buffer1, scratch,
                              i > 0 ? buffer2 : back_deltas))
       return false;
     if (i == 0) return needs_to_backprop_;
     if (!stack_[i - 1]->IsTraining() ||
         !stack_[i - 1]->Backward(debug, *buffer2, scratch,
                                  i > 1 ? buffer1 : back_deltas))
       return false;
   }
   return needs_to_backprop_;
 }

◆ CacheXScaleFactor()

void tesseract::Series::CacheXScaleFactor ( int factor )

virtual

Reimplemented from tesseract::Plumbing.

Definition at line 104 of file series.cpp.

                                          {
   stack_[0]->CacheXScaleFactor(factor);
 }

◆ Forward()

void tesseract::Series::Forward	(	bool	debug,
		const NetworkIO &	input,
		const TransposedArray *	input_transpose,
		NetworkScratch *	scratch,
		NetworkIO *	output
	)

virtual

Reimplemented from tesseract::Network.

Definition at line 110 of file series.cpp.

                                                                  {
   int stack_size = stack_.size();
   ASSERT_HOST(stack_size > 1);
   // Revolving intermediate buffers.
   NetworkScratch::IO buffer1(input, scratch);
   NetworkScratch::IO buffer2(input, scratch);
   // Run each network in turn, giving the output of n as the input to n + 1,
   // with the final network providing the real output.
   stack_[0]->Forward(debug, input, input_transpose, scratch, buffer1);
   for (int i = 1; i < stack_size; i += 2) {
     stack_[i]->Forward(debug, *buffer1, NULL, scratch,
                        i + 1 < stack_size ? buffer2 : output);
     if (i + 1 == stack_size) return;
     stack_[i + 1]->Forward(debug, *buffer2, NULL, scratch,
                            i + 2 < stack_size ? buffer1 : output);
   }
 }

◆ InitWeights()

int tesseract::Series::InitWeights	(	float	range,
		TRand *	randomizer
	)

virtual

Reimplemented from tesseract::Plumbing.

Definition at line 50 of file series.cpp.

                                                       {
   num_weights_ = 0;
   tprintf("Num outputs,weights in Series:\n");
   for (int i = 0; i < stack_.size(); ++i) {
     int weights = stack_[i]->InitWeights(range, randomizer);
     tprintf("  %s:%d, %d\n",
             stack_[i]->spec().string(), stack_[i]->NumOutputs(), weights);
     num_weights_ += weights;
   }
   tprintf("Total weights = %d\n", num_weights_);
   return num_weights_;
 }

◆ OutputShape()

StaticShape tesseract::Series::OutputShape ( const StaticShape & input_shape ) const

virtual

Reimplemented from tesseract::Network.

Definition at line 38 of file series.cpp.

                                                                     {
   StaticShape result(input_shape);
   int stack_size = stack_.size();
   for (int i = 0; i < stack_size; ++i) {
     result = stack_[i]->OutputShape(result);
   }
   return result;
 }

◆ RemapOutputs()

int tesseract::Series::RemapOutputs	(	int	old_no,
		const std::vector< int > &	code_map
	)

overridevirtual

Reimplemented from tesseract::Plumbing.

Definition at line 65 of file series.cpp.

                                                                    {
   num_weights_ = 0;
   tprintf("Num (Extended) outputs,weights in Series:\n");
   for (int i = 0; i < stack_.size(); ++i) {
     int weights = stack_[i]->RemapOutputs(old_no, code_map);
     tprintf("  %s:%d, %d\n", stack_[i]->spec().string(),
             stack_[i]->NumOutputs(), weights);
     num_weights_ += weights;
   }
   tprintf("Total weights = %d\n", num_weights_);
   no_ = stack_.back()->NumOutputs();
   return num_weights_;
 }

◆ SetupNeedsBackprop()

bool tesseract::Series::SetupNeedsBackprop ( bool needs_backprop )

virtual

Reimplemented from tesseract::Plumbing.

Definition at line 82 of file series.cpp.

                                                    {
   needs_to_backprop_ = needs_backprop;
   for (int i = 0; i < stack_.size(); ++i)
     needs_backprop = stack_[i]->SetupNeedsBackprop(needs_backprop);
   return needs_backprop;
 }

◆ spec()

virtual STRING tesseract::Series::spec ( ) const

inlinevirtual

Reimplemented from tesseract::Plumbing.

Definition at line 37 of file series.h.

                               {
     STRING spec("[");
     for (int i = 0; i < stack_.size(); ++i)
       spec += stack_[i]->spec();
     spec += "]";
     return spec;
   }

◆ SplitAt()

void tesseract::Series::SplitAt	(	int	last_start,
		Series **	start,
		Series **	end
	)

Definition at line 163 of file series.cpp.

                                                                  {
   *start = NULL;
   *end = NULL;
   if (last_start < 0 || last_start >= stack_.size()) {
     tprintf("Invalid split index %d must be in range [0,%d]!\n",
             last_start, stack_.size() - 1);
     return;
   }
   Series* master_series = new Series("MasterSeries");
   Series* boosted_series = new Series("BoostedSeries");
   for (int s = 0; s <= last_start; ++s) {
     if (s + 1 == stack_.size() && stack_[s]->type() == NT_SOFTMAX) {
       // Change the softmax to a tanh.
       FullyConnected* fc = static_cast<FullyConnected*>(stack_[s]);
       fc->ChangeType(NT_TANH);
     }
     master_series->AddToStack(stack_[s]);
     stack_[s] = NULL;
   }
   for (int s = last_start + 1; s < stack_.size(); ++s) {
     boosted_series->AddToStack(stack_[s]);
     stack_[s] = NULL;
   }
   *start = master_series;
   *end = boosted_series;
   delete this;
 }

◆ XScaleFactor()

int tesseract::Series::XScaleFactor ( ) const

virtual

Reimplemented from tesseract::Plumbing.

Definition at line 95 of file series.cpp.

                                {
   int factor = 1;
   for (int i = 0; i < stack_.size(); ++i)
       factor *= stack_[i]->XScaleFactor();
   return factor;
 }

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

/home/stweil/src/github/tesseract-ocr/tesseract/lstm/series.h
/home/stweil/src/github/tesseract-ocr/tesseract/lstm/series.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Series()

◆ ~Series()

Member Function Documentation

◆ AppendSeries()

◆ Backward()

◆ CacheXScaleFactor()

◆ Forward()

◆ InitWeights()

◆ OutputShape()

◆ RemapOutputs()

◆ SetupNeedsBackprop()

◆ spec()

◆ SplitAt()

◆ XScaleFactor()