tesseract::Plumbing Class Reference

#include <plumbing.h>

Inheritance diagram for tesseract::Plumbing:

Public Member Functions
	Plumbing (const STRING &name)
virtual	~Plumbing ()
virtual StaticShape	InputShape () const
virtual STRING	spec () const
virtual bool	IsPlumbingType () const
virtual void	SetEnableTraining (TrainingState state)
virtual void	SetNetworkFlags (uinT32 flags)
virtual int	InitWeights (float range, TRand *randomizer)
int	RemapOutputs (int old_no, const std::vector< int > &code_map) override
virtual void	ConvertToInt ()
virtual void	SetRandomizer (TRand *randomizer)
virtual void	AddToStack (Network *network)
virtual bool	SetupNeedsBackprop (bool needs_backprop)
virtual int	XScaleFactor () const
virtual void	CacheXScaleFactor (int factor)
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
virtual StaticShape	OutputShape (const StaticShape &input_shape) const
const STRING &	name () const
bool	TestFlag (NetworkFlags flag) const
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	DisplayForward (const NetworkIO &matrix)
void	DisplayBackward (const NetworkIO &matrix)

Protected Attributes
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_

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)
Static Protected Attributes inherited from tesseract::Network
static char const *const	kTypeNames [NT_COUNT]

Detailed Description

Definition at line 30 of file plumbing.h.

Constructor & Destructor Documentation

Plumbing()

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

explicit

Definition at line 25 of file plumbing.cpp.

  : Network(NT_PARALLEL, name, 0, 0) {
}

~Plumbing()

tesseract::Plumbing::~Plumbing ( )

virtual

Definition at line 29 of file plumbing.cpp.

                    {
}

Member Function Documentation

AddToStack()

void tesseract::Plumbing::AddToStack ( Network *  network )

virtual

Definition at line 85 of file plumbing.cpp.

                                          {
  if (stack_.empty()) {
    ni_ = network->NumInputs();
    no_ = network->NumOutputs();
  } else if (type_ == NT_SERIES) {
    // ni is input of first, no output of last, others match output to input.
    ASSERT_HOST(no_ == network->NumInputs());
    no_ = network->NumOutputs();
  } else {
    // All parallel types. Output is sum of outputs, inputs all match.
    ASSERT_HOST(ni_ == network->NumInputs());
    no_ += network->NumOutputs();
  }
  stack_.push_back(network);
}

CacheXScaleFactor()

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

virtual

Reimplemented from tesseract::Network.

Reimplemented in tesseract::Series.

Definition at line 129 of file plumbing.cpp.

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

ConvertToInt()

void tesseract::Plumbing::ConvertToInt ( )

virtual

Reimplemented from tesseract::Network.

Definition at line 71 of file plumbing.cpp.

                            {
  for (int i = 0; i < stack_.size(); ++i)
    stack_[i]->ConvertToInt();
}

CountAlternators()

void tesseract::Plumbing::CountAlternators ( const Network &  other, double *  same, double *  changed  ) const

virtual

Reimplemented from tesseract::Network.

Definition at line 237 of file plumbing.cpp.

                                                       {
  ASSERT_HOST(other.type() == type_);
  const Plumbing* plumbing = static_cast<const Plumbing*>(&other);
  ASSERT_HOST(plumbing->stack_.size() == stack_.size());
  for (int i = 0; i < stack_.size(); ++i)
    stack_[i]->CountAlternators(*plumbing->stack_[i], same, changed);
}

DebugWeights()

void tesseract::Plumbing::DebugWeights ( )

virtual

Reimplemented from tesseract::Network.

Definition at line 136 of file plumbing.cpp.

                            {
  for (int i = 0; i < stack_.size(); ++i)
    stack_[i]->DebugWeights();
}

DeSerialize()

bool tesseract::Plumbing::DeSerialize ( TFile *  fp )

virtual

Reimplemented from tesseract::Network.

Definition at line 200 of file plumbing.cpp.

                                    {
  stack_.truncate(0);
  no_ = 0;  // We will be modifying this as we AddToStack.
  inT32 size;
  if (fp->FReadEndian(&size, sizeof(size), 1) != 1) return false;
  for (int i = 0; i < size; ++i) {
    Network* network = CreateFromFile(fp);
    if (network == NULL) return false;
    AddToStack(network);
  }
  if ((network_flags_ & NF_LAYER_SPECIFIC_LR) &&
      !learning_rates_.DeSerialize(fp)) {
    return false;
  }
  return true;
}

EnumerateLayers()

void tesseract::Plumbing::EnumerateLayers	(	const STRING *	prefix,
		GenericVector< STRING > *	layers
	)		const

Definition at line 142 of file plumbing.cpp.

                                                                    {
  for (int i = 0; i < stack_.size(); ++i) {
    STRING layer_name;
    if (prefix) layer_name = *prefix;
    layer_name.add_str_int(":", i);
    if (stack_[i]->IsPlumbingType()) {
      Plumbing* plumbing = static_cast<Plumbing*>(stack_[i]);
      plumbing->EnumerateLayers(&layer_name, layers);
    } else {
      layers->push_back(layer_name);
    }
  }
}

GetLayer()

Network * tesseract::Plumbing::GetLayer

(

const char *

id

)

const

Definition at line 158 of file plumbing.cpp.

                                                {
  char* next_id;
  int index = strtol(id, &next_id, 10);
  if (index < 0 || index >= stack_.size()) return NULL;
  if (stack_[index]->IsPlumbingType()) {
    Plumbing* plumbing = static_cast<Plumbing*>(stack_[index]);
    ASSERT_HOST(*next_id == ':');
    return plumbing->GetLayer(next_id + 1);
  }
  return stack_[index];
}

InitWeights()

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

virtual

Reimplemented from tesseract::Network.

Reimplemented in tesseract::Series.

Definition at line 53 of file plumbing.cpp.

                                                        {
  num_weights_ = 0;
  for (int i = 0; i < stack_.size(); ++i)
    num_weights_ += stack_[i]->InitWeights(range, randomizer);
  return num_weights_;
}

InputShape()

virtual StaticShape tesseract::Plumbing::InputShape ( ) const

inlinevirtual

Reimplemented from tesseract::Network.

Definition at line 37 of file plumbing.h.

{ return stack_[0]->InputShape(); }

IsPlumbingType()

virtual bool tesseract::Plumbing::IsPlumbingType ( ) const

inlinevirtual

Reimplemented from tesseract::Network.

Definition at line 44 of file plumbing.h.

{ return true; }

LayerLearningRate()

float tesseract::Plumbing::LayerLearningRate ( const char *  id ) const

inline

Definition at line 105 of file plumbing.h.

                                                {
    const float* lr_ptr = LayerLearningRatePtr(id);
    ASSERT_HOST(lr_ptr != NULL);
    return *lr_ptr;
  }

LayerLearningRatePtr()

float * tesseract::Plumbing::LayerLearningRatePtr

(

const char *

id

)

const

Definition at line 171 of file plumbing.cpp.

                                                          {
  char* next_id;
  int index = strtol(id, &next_id, 10);
  if (index < 0 || index >= stack_.size()) return NULL;
  if (stack_[index]->IsPlumbingType()) {
    Plumbing* plumbing = static_cast<Plumbing*>(stack_[index]);
    ASSERT_HOST(*next_id == ':');
    return plumbing->LayerLearningRatePtr(next_id + 1);
  }
  if (index < 0 || index >= learning_rates_.size()) return NULL;
  return &learning_rates_[index];
}

RemapOutputs()

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

overridevirtual

Reimplemented from tesseract::Network.

Reimplemented in tesseract::Series.

Definition at line 62 of file plumbing.cpp.

                                                                     {
  num_weights_ = 0;
  for (int i = 0; i < stack_.size(); ++i) {
    num_weights_ += stack_[i]->RemapOutputs(old_no, code_map);
  }
  return num_weights_;
}

ScaleLayerLearningRate()

void tesseract::Plumbing::ScaleLayerLearningRate ( const char *  id, double  factor  )

inline

Definition at line 111 of file plumbing.h.

                                                             {
    float* lr_ptr = LayerLearningRatePtr(id);
    ASSERT_HOST(lr_ptr != NULL);
    *lr_ptr *= factor;
  }

Serialize()

bool tesseract::Plumbing::Serialize ( TFile *  fp ) const

virtual

Reimplemented from tesseract::Network.

Definition at line 185 of file plumbing.cpp.

                                        {
  if (!Network::Serialize(fp)) return false;
  inT32 size = stack_.size();
  // Can't use PointerVector::Serialize here as we need a special DeSerialize.
  if (fp->FWrite(&size, sizeof(size), 1) != 1) return false;
  for (int i = 0; i < size; ++i)
    if (!stack_[i]->Serialize(fp)) return false;
  if ((network_flags_ & NF_LAYER_SPECIFIC_LR) &&
      !learning_rates_.Serialize(fp)) {
    return false;
  }
  return true;
}

SetEnableTraining()

void tesseract::Plumbing::SetEnableTraining ( TrainingState  state )

virtual

Reimplemented from tesseract::Network.

Definition at line 34 of file plumbing.cpp.

                                                    {
  Network::SetEnableTraining(state);
  for (int i = 0; i < stack_.size(); ++i)
    stack_[i]->SetEnableTraining(state);
}

SetNetworkFlags()

void tesseract::Plumbing::SetNetworkFlags ( uinT32  flags )

virtual

Reimplemented from tesseract::Network.

Definition at line 42 of file plumbing.cpp.

                                           {
  Network::SetNetworkFlags(flags);
  for (int i = 0; i < stack_.size(); ++i)
    stack_[i]->SetNetworkFlags(flags);
}

SetRandomizer()

void tesseract::Plumbing::SetRandomizer ( TRand *  randomizer )

virtual

Reimplemented from tesseract::Network.

Definition at line 79 of file plumbing.cpp.

                                              {
  for (int i = 0; i < stack_.size(); ++i)
    stack_[i]->SetRandomizer(randomizer);
}

SetupNeedsBackprop()

bool tesseract::Plumbing::SetupNeedsBackprop ( bool  needs_backprop )

virtual

Reimplemented from tesseract::Network.

Reimplemented in tesseract::Series.

Definition at line 103 of file plumbing.cpp.

                                                     {
  if (IsTraining()) {
    needs_to_backprop_ = needs_backprop;
    bool retval = needs_backprop;
    for (int i = 0; i < stack_.size(); ++i) {
      if (stack_[i]->SetupNeedsBackprop(needs_backprop)) retval = true;
    }
    return retval;
  }
  // Frozen networks don't do backprop.
  needs_to_backprop_ = false;
  return false;
}

spec()

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

inlinevirtual

Reimplemented from tesseract::Network.

Reimplemented in tesseract::Parallel, tesseract::Reversed, and tesseract::Series.

Definition at line 38 of file plumbing.h.

                              {
    return "Sub-classes of Plumbing must implement spec()!";
  }

stack()

const PointerVector<Network>& tesseract::Plumbing::stack ( ) const

inline

Definition at line 96 of file plumbing.h.

                                              {
    return stack_;
  }

Update()

void tesseract::Plumbing::Update ( float  learning_rate, float  momentum, float  adam_beta, int  num_samples  )

overridevirtual

Reimplemented from tesseract::Network.

Definition at line 219 of file plumbing.cpp.

                                       {
  for (int i = 0; i < stack_.size(); ++i) {
    if (network_flags_ & NF_LAYER_SPECIFIC_LR) {
      if (i < learning_rates_.size())
        learning_rate = learning_rates_[i];
      else
        learning_rates_.push_back(learning_rate);
    }
    if (stack_[i]->IsTraining()) {
      stack_[i]->Update(learning_rate, momentum, adam_beta, num_samples);
    }
  }
}

XScaleFactor()

int tesseract::Plumbing::XScaleFactor ( ) const

virtual

Reimplemented from tesseract::Network.

Reimplemented in tesseract::Series.

Definition at line 123 of file plumbing.cpp.

                                 {
  return stack_[0]->XScaleFactor();
}

Member Data Documentation

learning_rates_

GenericVector<float> tesseract::Plumbing::learning_rates_

protected

Definition at line 139 of file plumbing.h.

stack_

PointerVector<Network> tesseract::Plumbing::stack_

protected

Definition at line 136 of file plumbing.h.

---

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

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