tesseract::Network Class Reference

#include <network.h>

Inheritance diagram for tesseract::Network:

Public Member Functions
	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	InputShape () const
virtual StaticShape	OutputShape (const StaticShape &input_shape) const
const STRING &	name () const
virtual 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 ()
virtual bool	Serialize (TFile *fp) const
virtual bool	DeSerialize (TFile *fp)
virtual void	Update (float learning_rate, float momentum, float adam_beta, int num_samples)
virtual void	CountAlternators (const Network &other, double *same, double *changed) 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)

Static Public Member Functions
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
double	Random (double range)

Protected Attributes
NetworkType	type_
TrainingState	training_
bool	needs_to_backprop_
int32_t	network_flags_
int32_t	ni_
int32_t	no_
int32_t	num_weights_
STRING	name_
ScrollView *	forward_win_
ScrollView *	backward_win_
TRand *	randomizer_

Static Protected Attributes
static char const *const	kTypeNames [NT_COUNT]

Detailed Description

Definition at line 105 of file network.h.

Constructor & Destructor Documentation

Network() [1/2]

tesseract::Network::Network

(

)

Definition at line 76 of file network.cpp.

    : type_(NT_NONE),
      training_(TS_ENABLED),
      needs_to_backprop_(true),
      network_flags_(0),
      ni_(0),
      no_(0),
      num_weights_(0),
      forward_win_(nullptr),
      backward_win_(nullptr),
      randomizer_(nullptr) {}

Network() [2/2]

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

Definition at line 87 of file network.cpp.

    : type_(type),
      training_(TS_ENABLED),
      needs_to_backprop_(true),
      network_flags_(0),
      ni_(ni),
      no_(no),
      num_weights_(0),
      name_(name),
      forward_win_(nullptr),
      backward_win_(nullptr),
      randomizer_(nullptr) {}

~Network()

tesseract::Network::~Network ( )

virtual

Definition at line 100 of file network.cpp.

                  {
}

Member Function Documentation

Backward()

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

inlinevirtual

Reimplemented in tesseract::LSTM, tesseract::FullyConnected, tesseract::Reversed, tesseract::Series, tesseract::Input, tesseract::Parallel, tesseract::Reconfig, tesseract::Convolve, and tesseract::Maxpool.

Definition at line 273 of file network.h.

                                                {
    tprintf("Must override Network::Backward for type %d\n", type_);
    return false;
  }

CacheXScaleFactor()

virtual void tesseract::Network::CacheXScaleFactor ( int  factor )

inlinevirtual

Reimplemented in tesseract::Plumbing, tesseract::Series, and tesseract::Input.

Definition at line 215 of file network.h.

{}

ClearWindow()

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

static

Definition at line 309 of file network.cpp.

                                                                      {
  if (*window == nullptr) {
    int min_size = MIN(width, height);
    if (min_size < kMinWinSize) {
      if (min_size < 1) min_size = 1;
      width = width * kMinWinSize / min_size;
      height = height * kMinWinSize / min_size;
    }
    width += kXWinFrameSize;
    height += kYWinFrameSize;
    if (width > kMaxWinSize) width = kMaxWinSize;
    if (height > kMaxWinSize) height = kMaxWinSize;
    *window = new ScrollView(window_name, 80, 100, width, height, width, height,
                             tess_coords);
    tprintf("Created window %s of size %d, %d\n", window_name, width, height);
  } else {
    (*window)->Clear();
  }
}

ConvertToInt()

virtual void tesseract::Network::ConvertToInt ( )

inlinevirtual

Reimplemented in tesseract::LSTM, tesseract::FullyConnected, and tesseract::Plumbing.

Definition at line 191 of file network.h.

{}

CountAlternators()

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

inlinevirtual

Reimplemented in tesseract::Plumbing, tesseract::FullyConnected, and tesseract::LSTM.

Definition at line 236 of file network.h.

                                                       {}

CreateFromFile()

Network * tesseract::Network::CreateFromFile ( TFile *  fp )

static

Definition at line 203 of file network.cpp.

                                          {
  Network stub;
  if (!stub.DeSerialize(fp)) return nullptr;
  Network* network = nullptr;
  switch (stub.type_) {
    case NT_CONVOLVE:
      network = new Convolve(stub.name_, stub.ni_, 0, 0);
      break;
    case NT_INPUT:
      network = new Input(stub.name_, stub.ni_, stub.no_);
      break;
    case NT_LSTM:
    case NT_LSTM_SOFTMAX:
    case NT_LSTM_SOFTMAX_ENCODED:
    case NT_LSTM_SUMMARY:
      network =
          new LSTM(stub.name_, stub.ni_, stub.no_, stub.no_, false, stub.type_);
      break;
    case NT_MAXPOOL:
      network = new Maxpool(stub.name_, stub.ni_, 0, 0);
      break;
    // All variants of Parallel.
    case NT_PARALLEL:
    case NT_REPLICATED:
    case NT_PAR_RL_LSTM:
    case NT_PAR_UD_LSTM:
    case NT_PAR_2D_LSTM:
      network = new Parallel(stub.name_, stub.type_);
      break;
    case NT_RECONFIG:
      network = new Reconfig(stub.name_, stub.ni_, 0, 0);
      break;
    // All variants of reversed.
    case NT_XREVERSED:
    case NT_YREVERSED:
    case NT_XYTRANSPOSE:
      network = new Reversed(stub.name_, stub.type_);
      break;
    case NT_SERIES:
      network = new Series(stub.name_);
      break;
    case NT_TENSORFLOW:
#ifdef INCLUDE_TENSORFLOW
      network = new TFNetwork(stub.name_);
#else
      tprintf("TensorFlow not compiled in! -DINCLUDE_TENSORFLOW\n");
      return nullptr;
#endif
      break;
    // All variants of FullyConnected.
    case NT_SOFTMAX:
    case NT_SOFTMAX_NO_CTC:
    case NT_RELU:
    case NT_TANH:
    case NT_LINEAR:
    case NT_LOGISTIC:
    case NT_POSCLIP:
    case NT_SYMCLIP:
      network = new FullyConnected(stub.name_, stub.ni_, stub.no_, stub.type_);
      break;
    default:
      return nullptr;
  }
  network->training_ = stub.training_;
  network->needs_to_backprop_ = stub.needs_to_backprop_;
  network->network_flags_ = stub.network_flags_;
  network->num_weights_ = stub.num_weights_;
  if (!network->DeSerialize(fp)) {
    delete network;
    return nullptr;
  }
  return network;
}

DebugWeights()

virtual void tesseract::Network::DebugWeights ( )

inlinevirtual

Reimplemented in tesseract::Plumbing, tesseract::LSTM, and tesseract::FullyConnected.

Definition at line 218 of file network.h.

                              {
    tprintf("Must override Network::DebugWeights for type %d\n", type_);
  }

DeSerialize()

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

virtual

Reimplemented in tesseract::Plumbing, tesseract::LSTM, tesseract::FullyConnected, tesseract::Reconfig, tesseract::Input, tesseract::Convolve, and tesseract::Maxpool.

Definition at line 172 of file network.cpp.

                                   {
  int8_t data = 0;
  if (fp->FRead(&data, sizeof(data), 1) != 1) return false;
  if (data == NT_NONE) {
    STRING type_name;
    if (!type_name.DeSerialize(fp)) return false;
    for (data = 0; data < NT_COUNT && type_name != kTypeNames[data]; ++data) {
    }
    if (data == NT_COUNT) {
      tprintf("Invalid network layer type:%s\n", type_name.string());
      return false;
    }
  }
  type_ = static_cast<NetworkType>(data);
  if (fp->FRead(&data, sizeof(data), 1) != 1) return false;
  training_ = data == TS_ENABLED ? TS_ENABLED : TS_DISABLED;
  if (fp->FRead(&data, sizeof(data), 1) != 1) return false;
  needs_to_backprop_ = data != 0;
  if (fp->FReadEndian(&network_flags_, sizeof(network_flags_), 1) != 1)
    return false;
  if (fp->FReadEndian(&ni_, sizeof(ni_), 1) != 1) return false;
  if (fp->FReadEndian(&no_, sizeof(no_), 1) != 1) return false;
  if (fp->FReadEndian(&num_weights_, sizeof(num_weights_), 1) != 1)
    return false;
  if (!name_.DeSerialize(fp)) return false;
  return true;
}

DisplayBackward()

void tesseract::Network::DisplayBackward

(

const NetworkIO &

matrix

)

Definition at line 296 of file network.cpp.

                                                     {
#ifndef GRAPHICS_DISABLED  // do nothing if there's no graphics
  Pix* image = matrix.ToPix();
  STRING window_name = name_ + "-back";
  ClearWindow(false, window_name.string(), pixGetWidth(image),
              pixGetHeight(image), &backward_win_);
  DisplayImage(image, backward_win_);
  backward_win_->Update();
#endif  // GRAPHICS_DISABLED
}

DisplayForward()

void tesseract::Network::DisplayForward

(

const NetworkIO &

matrix

)

Definition at line 285 of file network.cpp.

                                                    {
#ifndef GRAPHICS_DISABLED  // do nothing if there's no graphics
  Pix* image = matrix.ToPix();
  ClearWindow(false, name_.string(), pixGetWidth(image),
              pixGetHeight(image), &forward_win_);
  DisplayImage(image, forward_win_);
  forward_win_->Update();
#endif  // GRAPHICS_DISABLED
}

DisplayImage()

int tesseract::Network::DisplayImage ( Pix *  pix, ScrollView *  window  )

static

Definition at line 332 of file network.cpp.

                                                      {
  int height = pixGetHeight(pix);
  window->Image(pix, 0, 0);
  pixDestroy(&pix);
  return height;
}

Forward()

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

inlinevirtual

Reimplemented in tesseract::LSTM, tesseract::FullyConnected, tesseract::Reversed, tesseract::Series, tesseract::Input, tesseract::Parallel, tesseract::Reconfig, tesseract::Convolve, and tesseract::Maxpool.

Definition at line 262 of file network.h.

                                                                   {
    tprintf("Must override Network::Forward for type %d\n", type_);
  }

InitWeights()

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

virtual

Reimplemented in tesseract::LSTM, tesseract::FullyConnected, tesseract::Plumbing, and tesseract::Series.

Definition at line 132 of file network.cpp.

                                                       {
  randomizer_ = randomizer;
  return 0;
}

InputShape()

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

inlinevirtual

Reimplemented in tesseract::Input, and tesseract::Plumbing.

Definition at line 127 of file network.h.

                                         {
    StaticShape result;
    return result;
  }

IsPlumbingType()

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

inlinevirtual

Reimplemented in tesseract::Plumbing.

Definition at line 152 of file network.h.

{ return false; }

IsTraining()

bool tesseract::Network::IsTraining ( ) const

inline

Definition at line 115 of file network.h.

{ return training_ == TS_ENABLED; }

name()

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

inline

Definition at line 138 of file network.h.

                             {
    return name_;
  }

needs_to_backprop()

bool tesseract::Network::needs_to_backprop ( ) const

inline

Definition at line 116 of file network.h.

                                 {
    return needs_to_backprop_;
  }

num_weights()

int tesseract::Network::num_weights ( ) const

inline

Definition at line 119 of file network.h.

{ return num_weights_; }

NumInputs()

int tesseract::Network::NumInputs ( ) const

inline

Definition at line 120 of file network.h.

                        {
    return ni_;
  }

NumOutputs()

int tesseract::Network::NumOutputs ( ) const

inline

Definition at line 123 of file network.h.

                         {
    return no_;
  }

OutputShape()

virtual StaticShape tesseract::Network::OutputShape ( const StaticShape &  input_shape ) const

inlinevirtual

Reimplemented in tesseract::LSTM, tesseract::Input, tesseract::Reconfig, tesseract::FullyConnected, tesseract::Parallel, tesseract::Reversed, and tesseract::Series.

Definition at line 133 of file network.h.

                                                                        {
    StaticShape result(input_shape);
    result.set_depth(no_);
    return result;
  }

Random()

double tesseract::Network::Random ( double  range )

protected

Definition at line 278 of file network.cpp.

                                   {
  ASSERT_HOST(randomizer_ != nullptr);
  return randomizer_->SignedRand(range);
}

RemapOutputs()

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

inlinevirtual

Reimplemented in tesseract::LSTM, tesseract::FullyConnected, tesseract::Plumbing, and tesseract::Series.

Definition at line 186 of file network.h.

                                                                       {
    return 0;
  }

Serialize()

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

virtual

Reimplemented in tesseract::Plumbing, tesseract::LSTM, tesseract::FullyConnected, tesseract::Reconfig, tesseract::Input, and tesseract::Convolve.

Definition at line 153 of file network.cpp.

                                       {
  int8_t data = NT_NONE;
  if (fp->FWrite(&data, sizeof(data), 1) != 1) return false;
  STRING type_name = kTypeNames[type_];
  if (!type_name.Serialize(fp)) return false;
  data = training_;
  if (fp->FWrite(&data, sizeof(data), 1) != 1) return false;
  data = needs_to_backprop_;
  if (fp->FWrite(&data, sizeof(data), 1) != 1) return false;
  if (fp->FWrite(&network_flags_, sizeof(network_flags_), 1) != 1) return false;
  if (fp->FWrite(&ni_, sizeof(ni_), 1) != 1) return false;
  if (fp->FWrite(&no_, sizeof(no_), 1) != 1) return false;
  if (fp->FWrite(&num_weights_, sizeof(num_weights_), 1) != 1) return false;
  if (!name_.Serialize(fp)) return false;
  return true;
}

SetEnableTraining()

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

virtual

Reimplemented in tesseract::LSTM, tesseract::FullyConnected, and tesseract::Plumbing.

Definition at line 112 of file network.cpp.

                                                   {
  if (state == TS_RE_ENABLE) {
    // Enable only from temp disabled.
    if (training_ == TS_TEMP_DISABLE) training_ = TS_ENABLED;
  } else if (state == TS_TEMP_DISABLE) {
    // Temp disable only from enabled.
    if (training_ == TS_ENABLED) training_ = state;
  } else {
    training_ = state;
  }
}

SetNetworkFlags()

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

virtual

Reimplemented in tesseract::Plumbing.

Definition at line 126 of file network.cpp.

                                            {
  network_flags_ = flags;
}

SetRandomizer()

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

virtual

Reimplemented in tesseract::Plumbing.

Definition at line 140 of file network.cpp.

                                             {
  randomizer_ = randomizer;
}

SetupNeedsBackprop()

bool tesseract::Network::SetupNeedsBackprop ( bool  needs_backprop )

virtual

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

Definition at line 147 of file network.cpp.

                                                    {
  needs_to_backprop_ = needs_backprop;
  return needs_backprop || num_weights_ > 0;
}

spec()

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

inlinevirtual

Reimplemented in tesseract::LSTM, tesseract::Reconfig, tesseract::Convolve, tesseract::Plumbing, tesseract::FullyConnected, tesseract::Parallel, tesseract::Reversed, tesseract::Series, tesseract::Maxpool, and tesseract::Input.

Definition at line 141 of file network.h.

                              {
    return "?";
  }

TestFlag()

bool tesseract::Network::TestFlag ( NetworkFlags  flag ) const

inline

Definition at line 144 of file network.h.

                                         {
    return (network_flags_ & flag) != 0;
  }

type()

NetworkType tesseract::Network::type ( ) const

inline

Definition at line 112 of file network.h.

                           {
    return type_;
  }

Update()

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

inlinevirtual

Reimplemented in tesseract::Plumbing, tesseract::FullyConnected, and tesseract::LSTM.

Definition at line 231 of file network.h.

                                       {}

XScaleFactor()

virtual int tesseract::Network::XScaleFactor ( ) const

inlinevirtual

Reimplemented in tesseract::Plumbing, tesseract::Series, tesseract::Input, and tesseract::Reconfig.

Definition at line 209 of file network.h.

                                   {
    return 1;
  }

Member Data Documentation

backward_win_

ScrollView* tesseract::Network::backward_win_

protected

Definition at line 310 of file network.h.

forward_win_

ScrollView* tesseract::Network::forward_win_

protected

Definition at line 309 of file network.h.

kTypeNames

char const *const tesseract::Network::kTypeNames

staticprotected

Initial value:

= {
    "Invalid",     "Input",
    "Convolve",    "Maxpool",
    "Parallel",    "Replicated",
    "ParBidiLSTM", "DepParUDLSTM",
    "Par2dLSTM",   "Series",
    "Reconfig",    "RTLReversed",
    "TTBReversed", "XYTranspose",
    "LSTM",        "SummLSTM",
    "Logistic",    "LinLogistic",
    "LinTanh",     "Tanh",
    "Relu",        "Linear",
    "Softmax",     "SoftmaxNoCTC",
    "LSTMSoftmax", "LSTMBinarySoftmax",
    "TensorFlow",
}

Definition at line 314 of file network.h.

name_

STRING tesseract::Network::name_

protected

Definition at line 306 of file network.h.

needs_to_backprop_

bool tesseract::Network::needs_to_backprop_

protected

Definition at line 301 of file network.h.

network_flags_

int32_t tesseract::Network::network_flags_

protected

Definition at line 302 of file network.h.

ni_

int32_t tesseract::Network::ni_

protected

Definition at line 303 of file network.h.

no_

int32_t tesseract::Network::no_

protected

Definition at line 304 of file network.h.

num_weights_

int32_t tesseract::Network::num_weights_

protected

Definition at line 305 of file network.h.

randomizer_

TRand* tesseract::Network::randomizer_

protected

Definition at line 311 of file network.h.

training_

TrainingState tesseract::Network::training_

protected

Definition at line 300 of file network.h.

type_

NetworkType tesseract::Network::type_

protected

Definition at line 299 of file network.h.

---

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

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