#include <series.h>

Inheritance diagram for tesseract::Series:

Public Member Functions
TESS_API	Series (const char *name)

	~Series () override=default

StaticShape	OutputShape (const StaticShape &input_shape) const override

std::string	spec () const override

int	InitWeights (float range, TRand *randomizer) override

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

bool	SetupNeedsBackprop (bool needs_backprop) override

int	XScaleFactor () const override

void	CacheXScaleFactor (int factor) override

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

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

TESS_API void	SplitAt (unsigned last_start, Series start, Series end)

TESS_API void	AppendSeries (Network *src)

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

	~Plumbing () override

StaticShape	InputShape () const override

std::string	spec () const override

bool	IsPlumbingType () const override

void	SetEnableTraining (TrainingState state) override

void	SetNetworkFlags (uint32_t flags) override

int	InitWeights (float range, TRand *randomizer) override

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

void	ConvertToInt () override

void	SetRandomizer (TRand *randomizer) override

virtual void	AddToStack (Network *network)

bool	SetupNeedsBackprop (bool needs_backprop) override

int	XScaleFactor () const override

void	CacheXScaleFactor (int factor) override

void	DebugWeights () override

const std::vector< Network * > &	stack () const

void	EnumerateLayers (const std::string *prefix, std::vector< std::string > &layers) const

Network *	GetLayer (const char *id) const

float	LayerLearningRate (const char *id)

void	ScaleLayerLearningRate (const char *id, double factor)

void	SetLayerLearningRate (const char *id, float learning_rate)

float *	LayerLearningRatePtr (const char *id)

bool	Serialize (TFile *fp) const override

bool	DeSerialize (TFile *fp) override

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

void	CountAlternators (const Network &other, TFloat same, TFloat changed) const override

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

	Network (NetworkType type, const std::string &name, int ni, int no)

virtual	~Network ()=default

NetworkType	type () const

bool	IsTraining () const

bool	needs_to_backprop () const

int	num_weights () const

int	NumInputs () const

int	NumOutputs () const

virtual StaticShape	InputShape () const

virtual StaticShape	OutputShape (const StaticShape &input_shape) const

const std::string &	name () const

virtual std::string	spec () const

bool	TestFlag (NetworkFlags flag) const

virtual bool	IsPlumbingType () const

virtual void	SetEnableTraining (TrainingState state)

virtual void	SetNetworkFlags (uint32_t flags)

virtual int	InitWeights (float range, TRand *randomizer)

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

virtual void	ConvertToInt ()

virtual void	SetRandomizer (TRand *randomizer)

virtual bool	SetupNeedsBackprop (bool needs_backprop)

virtual int	XScaleFactor () const

virtual void	CacheXScaleFactor (int factor)

virtual void	DebugWeights ()=0

virtual bool	Serialize (TFile *fp) const

virtual bool	DeSerialize (TFile *fp)=0

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

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

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

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

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 (Image pix, ScrollView *window)

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

Protected Attributes inherited from tesseract::Plumbing
std::vector< Network * >	stack_

std::vector< float >	learning_rates_

Protected Attributes inherited from tesseract::Network
NetworkType	type_

TrainingState	training_

bool	needs_to_backprop_

int32_t	network_flags_

int32_t	ni_

int32_t	no_

int32_t	num_weights_

std::string	name_

ScrollView *	forward_win_

ScrollView *	backward_win_

TRand *	randomizer_

Detailed Description

Definition at line 26 of file series.h.

Constructor & Destructor Documentation

◆ Series()

tesseract::Series::Series ( const char * name )

explicit

Definition at line 28 of file series.cpp.

                               : Plumbing(name) {
  type_ = NT_SERIES;
}

◆ ~Series()

tesseract::Series::~Series ( )

overridedefault

Member Function Documentation

◆ AppendSeries()

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

Definition at line 192 of file series.cpp.

                                      {
  ASSERT_HOST(src->type() == NT_SERIES);
  auto *src_series = static_cast<Series *>(src);
  for (auto &s : src_series->stack_) {
    AddToStack(s);
    s = nullptr;
  }
  delete src;
}

◆ Backward()

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

overridevirtual

Implements tesseract::Network.

Definition at line 128 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 )

overridevirtual

Reimplemented from tesseract::Plumbing.

Definition at line 100 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
	)

overridevirtual

Implements tesseract::Network.

Definition at line 106 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, nullptr, scratch, i + 1 < stack_size ? buffer2 : output);
    if (i + 1 == stack_size) {
      return;
    }
    stack_[i + 1]->Forward(debug, *buffer2, nullptr, scratch,
                           i + 2 < stack_size ? buffer1 : output);
  }
}

◆ InitWeights()

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

overridevirtual

Reimplemented from tesseract::Plumbing.

Definition at line 46 of file series.cpp.

                                                      {
  num_weights_ = 0;
  tprintf("Num outputs,weights in Series:\n");
  for (auto &i : stack_) {
    int weights = i->InitWeights(range, randomizer);
    tprintf("  %s:%d, %d\n", i->spec().c_str(), 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

overridevirtual

Reimplemented from tesseract::Network.

Definition at line 34 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 60 of file series.cpp.

                                                                   {
  num_weights_ = 0;
  tprintf("Num (Extended) outputs,weights in Series:\n");
  for (auto &i : stack_) {
    int weights = i->RemapOutputs(old_no, code_map);
    tprintf("  %s:%d, %d\n", i->spec().c_str(), 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 )

overridevirtual

Reimplemented from tesseract::Plumbing.

Definition at line 76 of file series.cpp.

                                                   {
  needs_to_backprop_ = needs_backprop;
  for (auto &i : stack_) {
    needs_backprop = i->SetupNeedsBackprop(needs_backprop);
  }
  return needs_backprop;
}

◆ spec()

std::string tesseract::Series::spec ( ) const

inlineoverridevirtual

Reimplemented from tesseract::Plumbing.

Definition at line 37 of file series.h.

                                  {
    std::string spec("[");
    for (auto &it : stack_) {
      spec += it->spec();
    }
    spec += "]";
    return spec;
  }

◆ SplitAt()

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

Definition at line 163 of file series.cpp.

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

◆ XScaleFactor()

int tesseract::Series::XScaleFactor ( ) const

overridevirtual

Reimplemented from tesseract::Plumbing.

Definition at line 90 of file series.cpp.

                               {
  int factor = 1;
  for (auto i : stack_) {
    factor *= i->XScaleFactor();
  }
  return factor;
}

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

/media/home/debian/src/github/tesseract-ocr/tesseract/src/lstm/series.h
/media/home/debian/src/github/tesseract-ocr/tesseract/src/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()