#include <plumbing.h>

Inheritance diagram for tesseract::Plumbing:

Public Member Functions
	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)

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

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)

Detailed Description

Definition at line 28 of file plumbing.h.

Constructor & Destructor Documentation

◆ Plumbing()

tesseract::Plumbing::Plumbing ( const std::string & name )

explicit

Definition at line 24 of file plumbing.cpp.

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

tesseract::NT_PARALLEL

@ NT_PARALLEL

Definition: network.h:47

tesseract::Network::name

const std::string & name() const

Definition: network.h:140

tesseract::Network::Network

Network()

Definition: network.cpp:80

◆ ~Plumbing()

tesseract::Plumbing::~Plumbing ( )

inlineoverride

Definition at line 32 of file plumbing.h.

                       {
    for (auto data : stack_) {
      delete data;
    }
  }

Member Function Documentation

◆ AddToStack()

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

virtual

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

overridevirtual

Reimplemented from tesseract::Network.

Reimplemented in tesseract::Series.

Definition at line 130 of file plumbing.cpp.

                                           {
  for (auto &i : stack_) {
    i->CacheXScaleFactor(factor);
  }
}

◆ ConvertToInt()

void tesseract::Plumbing::ConvertToInt ( )

overridevirtual

Reimplemented from tesseract::Network.

Definition at line 68 of file plumbing.cpp.

                            {
  for (auto &i : stack_) {
    i->ConvertToInt();
  }
}

◆ CountAlternators()

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

overridevirtual

Reimplemented from tesseract::Network.

Definition at line 258 of file plumbing.cpp.

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

◆ DebugWeights()

void tesseract::Plumbing::DebugWeights ( )

overridevirtual

Implements tesseract::Network.

Definition at line 137 of file plumbing.cpp.

                            {
  for (auto &i : stack_) {
    i->DebugWeights();
  }
}

◆ DeSerialize()

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

overridevirtual

Implements tesseract::Network.

Definition at line 215 of file plumbing.cpp.

                                    {
  for (auto data : stack_) {
    delete data;
  }
  stack_.clear();
  no_ = 0; // We will be modifying this as we AddToStack.
  uint32_t size;
  if (!fp->DeSerialize(&size)) {
    return false;
  }
  for (uint32_t i = 0; i < size; ++i) {
    Network *network = CreateFromFile(fp);
    if (network == nullptr) {
      return false;
    }
    AddToStack(network);
  }
  if ((network_flags_ & NF_LAYER_SPECIFIC_LR) && !fp->DeSerialize(learning_rates_)) {
    return false;
  }
  return true;
}

◆ EnumerateLayers()

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

Definition at line 144 of file plumbing.cpp.

                                                                                          {
  for (size_t i = 0; i < stack_.size(); ++i) {
    std::string layer_name;
    if (prefix) {
      layer_name = *prefix;
    }
    layer_name += ":" + std::to_string(i);
    if (stack_[i]->IsPlumbingType()) {
      auto *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 161 of file plumbing.cpp.

                                                {
  char *next_id;
  int index = strtol(id, &next_id, 10);
  if (index < 0 || static_cast<unsigned>(index) >= stack_.size()) {
    return nullptr;
  }
  if (stack_[index]->IsPlumbingType()) {
    auto *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
	)

overridevirtual

Reimplemented from tesseract::Network.

Reimplemented in tesseract::Series.

Definition at line 49 of file plumbing.cpp.

                                                        {
  num_weights_ = 0;
  for (auto &i : stack_) {
    num_weights_ += i->InitWeights(range, randomizer);
  }
  return num_weights_;
}

◆ InputShape()

StaticShape tesseract::Plumbing::InputShape ( ) const

inlineoverridevirtual

Reimplemented from tesseract::Network.

Definition at line 39 of file plumbing.h.

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

◆ IsPlumbingType()

bool tesseract::Plumbing::IsPlumbingType ( ) const

inlineoverridevirtual

Reimplemented from tesseract::Network.

Definition at line 48 of file plumbing.h.

                                       {
    return true;
  }

◆ LayerLearningRate()

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

inline

Definition at line 110 of file plumbing.h.

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

◆ LayerLearningRatePtr()

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

Definition at line 176 of file plumbing.cpp.

                                                    {
  char *next_id;
  int index = strtol(id, &next_id, 10);
  if (index < 0 || static_cast<unsigned>(index) >= stack_.size()) {
    return nullptr;
  }
  if (stack_[index]->IsPlumbingType()) {
    auto *plumbing = static_cast<Plumbing *>(stack_[index]);
    ASSERT_HOST(*next_id == ':');
    return plumbing->LayerLearningRatePtr(next_id + 1);
  }
  if (static_cast<unsigned>(index) >= learning_rates_.size()) {
    return nullptr;
  }
  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 59 of file plumbing.cpp.

                                                                     {
  num_weights_ = 0;
  for (auto &i : stack_) {
    num_weights_ += i->RemapOutputs(old_no, code_map);
  }
  return num_weights_;
}

◆ ScaleLayerLearningRate()

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

inline

Definition at line 116 of file plumbing.h.

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

◆ Serialize()

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

overridevirtual

Reimplemented from tesseract::Network.

Definition at line 194 of file plumbing.cpp.

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

◆ SetEnableTraining()

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

overridevirtual

Reimplemented from tesseract::Network.

Definition at line 28 of file plumbing.cpp.

                                                    {
  Network::SetEnableTraining(state);
  for (auto &i : stack_) {
    i->SetEnableTraining(state);
  }
}

◆ SetLayerLearningRate()

void tesseract::Plumbing::SetLayerLearningRate	(	const char *	id,
		float	learning_rate
	)

inline

Definition at line 123 of file plumbing.h.

                                                                 {
    float *lr_ptr = LayerLearningRatePtr(id);
    ASSERT_HOST(lr_ptr != nullptr);
    *lr_ptr = learning_rate;
  }

◆ SetNetworkFlags()

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

overridevirtual

Reimplemented from tesseract::Network.

Definition at line 37 of file plumbing.cpp.

                                             {
  Network::SetNetworkFlags(flags);
  for (auto &i : stack_) {
    i->SetNetworkFlags(flags);
  }
}

◆ SetRandomizer()

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

overridevirtual

Reimplemented from tesseract::Network.

Definition at line 77 of file plumbing.cpp.

                                              {
  for (auto &i : stack_) {
    i->SetRandomizer(randomizer);
  }
}

◆ SetupNeedsBackprop()

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

overridevirtual

Reimplemented from tesseract::Network.

Reimplemented in tesseract::Series.

Definition at line 102 of file plumbing.cpp.

                                                     {
  if (IsTraining()) {
    needs_to_backprop_ = needs_backprop;
    bool retval = needs_backprop;
    for (auto &i : stack_) {
      if (i->SetupNeedsBackprop(needs_backprop)) {
        retval = true;
      }
    }
    return retval;
  }
  // Frozen networks don't do backprop.
  needs_to_backprop_ = false;
  return false;
}

◆ spec()

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

inlineoverridevirtual

Reimplemented from tesseract::Network.

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

Definition at line 42 of file plumbing.h.

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

◆ stack()

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

inline

Definition at line 102 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 240 of file plumbing.cpp.

                                                                                           {
  for (size_t 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

overridevirtual

Reimplemented from tesseract::Network.

Reimplemented in tesseract::Series.

Definition at line 124 of file plumbing.cpp.

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

Member Data Documentation

◆ learning_rates_

std::vector<float> tesseract::Plumbing::learning_rates_

protected

Definition at line 150 of file plumbing.h.

◆ stack_

std::vector<Network *> tesseract::Plumbing::stack_

protected

Definition at line 147 of file plumbing.h.

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

/media/home/debian/src/github/tesseract-ocr/tesseract/src/lstm/plumbing.h
/media/home/debian/src/github/tesseract-ocr/tesseract/src/lstm/plumbing.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Plumbing()

◆ ~Plumbing()

Member Function Documentation

◆ AddToStack()

◆ CacheXScaleFactor()

◆ ConvertToInt()

◆ CountAlternators()

◆ DebugWeights()

◆ DeSerialize()

◆ EnumerateLayers()

◆ GetLayer()

◆ InitWeights()

◆ InputShape()

◆ IsPlumbingType()

◆ LayerLearningRate()

◆ LayerLearningRatePtr()

◆ RemapOutputs()

◆ ScaleLayerLearningRate()

◆ Serialize()

◆ SetEnableTraining()

◆ SetLayerLearningRate()

◆ SetNetworkFlags()

◆ SetRandomizer()

◆ SetupNeedsBackprop()

◆ spec()

◆ stack()

◆ Update()

◆ XScaleFactor()

Member Data Documentation

◆ learning_rates_

◆ stack_