SG++-Doxygen-Documentation
python.controller.InfoToGraph.InfoToGraph Class Reference

This class processes the information about the current state of the learning process and presents it in form of a graph. More...

Inheritance diagram for python.controller.InfoToGraph.InfoToGraph:

Public Member Functions

def __init__ (self, learnerFilename="learner_progress.eps", solverFilename="solver_progress.eps")
 Constuctor. More...
 
def handleLearningEvent (self, subject, status)
 Handles events from Learner. More...
 
def handleSolvingEvent (self, subject, status)
 Handles events from Linear Solver. More...
 

Static Public Attributes

int LEARNER_FIGURE = 1
 The constant figure ID of the plot with learner information. More...
 
int SOLVER_FIGURE = 2
 The constant figure ID of the plot with solver information. More...
 

Detailed Description

This class processes the information about the current state of the learning process and presents it in form of a graph.

In order to use this class the matplotlib library is required.

Constructor & Destructor Documentation

◆ __init__()

def python.controller.InfoToGraph.InfoToGraph.__init__ (   self,
  learnerFilename = "learner_progress.eps",
  solverFilename = "solver_progress.eps" 
)

Constuctor.

Parameters
learnerFilenamefile name where learner progress information has to be stored (eps file)
solverFilenamefile name where solver progress information has to be stored (eps file)

References python.controller.InfoToGraph.InfoToGraph.__learnerFigure, python.controller.InfoToGraph.InfoToGraph.__learnerFilename, python.controller.InfoToGraph.InfoToGraph.__learnerTestResiduum, python.controller.InfoToGraph.InfoToGraph.__learnerTrainResiduum, python.controller.InfoToGraph.InfoToGraph.__solverFigure, python.controller.InfoToGraph.InfoToGraph.__solverFilename, python.controller.InfoToGraph.InfoToGraph.__solverResiduum, python.controller.InfoToGraph.InfoToGraph.LEARNER_FIGURE, and python.controller.InfoToGraph.InfoToGraph.SOLVER_FIGURE.

Member Function Documentation

◆ handleLearningEvent()

def python.controller.InfoToGraph.InfoToGraph.handleLearningEvent (   self,
  subject,
  status 
)

Handles events from Learner.

Parameters
subjectLearner object
statusEvent Status of type LearnerEvents

References python.controller.InfoToGraph.InfoToGraph.__learnerFilename, python.controller.InfoToGraph.InfoToGraph.__learnerGridSize, python.controller.InfoToGraph.InfoToGraph.__learnerTestResiduum, python.controller.InfoToGraph.InfoToGraph.__learnerTrainResiduum, and python.controller.InfoToGraph.InfoToGraph.LEARNER_FIGURE.

◆ handleSolvingEvent()

def python.controller.InfoToGraph.InfoToGraph.handleSolvingEvent (   self,
  subject,
  status 
)

Handles events from Linear Solver.

Parameters
subjectLinear Solver object
statusEvent Status of type LinearSolverEvents

References python.controller.InfoToGraph.InfoToGraph.__solverFilename, python.controller.InfoToGraph.InfoToGraph.__solverResiduum, and python.controller.InfoToGraph.InfoToGraph.SOLVER_FIGURE.

Member Data Documentation

◆ LEARNER_FIGURE

int python.controller.InfoToGraph.InfoToGraph.LEARNER_FIGURE = 1
static

The constant figure ID of the plot with learner information.

Referenced by python.controller.InfoToGraph.InfoToGraph.__init__(), and python.controller.InfoToGraph.InfoToGraph.handleLearningEvent().

◆ SOLVER_FIGURE

int python.controller.InfoToGraph.InfoToGraph.SOLVER_FIGURE = 2
static

The constant figure ID of the plot with solver information.

Referenced by python.controller.InfoToGraph.InfoToGraph.__init__(), and python.controller.InfoToGraph.InfoToGraph.handleSolvingEvent().


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