SG++-Doxygen-Documentation
python.uq.sampler.asgc.ASGCSamplerStopPolicy.ASGCSamplerStopPolicy Class Reference

The class implements heuristics for testing if the learn process should be finished before learner is overfitted. More...

Inheritance diagram for python.uq.sampler.asgc.ASGCSamplerStopPolicy.ASGCSamplerStopPolicy:

Public Member Functions

def __init__ (self)
 Contructor. More...
 
def fromJson (cls, jsonObject)
 
def getAccuracyLimit (self)
 Returns the accuracy on validation data, that have to be achieved. More...
 
def getAdaptiveIterationLimit (self)
 Returns the maximal number of refinement iterations. More...
 
def getGridSizeLimit (self)
 Returns the maximal grid size. More...
 
def hasGridSizeChanged (self, sampler)
 
def hasLimitReached (self, sampler)
 
def isTrainingComplete (self, sampler)
 Checks if learning process have to be stopped. More...
 
def setAccuracyLimit (self, limit)
 Setter for accuracy limit. More...
 
def setAdaptiveIterationLimit (self, limit)
 
def setGridSizeLimit (self, limit)
 Setter for maximal grid size. More...
 
def toString (self)
 Returns a string that represents the object. More...
 

Detailed Description

The class implements heuristics for testing if the learn process should be finished before learner is overfitted.

The test is made by calling method isTrainingComplete(learner) of the class, which returns True if training process should be finished.

Constructor & Destructor Documentation

◆ __init__()

def python.uq.sampler.asgc.ASGCSamplerStopPolicy.ASGCSamplerStopPolicy.__init__ (   self)

Contructor.

References python.learner.TrainingStopPolicy.TrainingStopPolicy.__accuracyLimit, python.uq.sampler.asgc.ASGCSamplerStopPolicy.ASGCSamplerStopPolicy.__accuracyLimit, python.learner.TrainingStopPolicy.TrainingStopPolicy.__adaptiveIterationLimit, python.uq.sampler.asgc.ASGCSamplerStopPolicy.ASGCSamplerStopPolicy.__adaptiveIterationLimit, python.learner.TrainingStopPolicy.TrainingStopPolicy.__gridSizeLimit, python.uq.sampler.asgc.ASGCSamplerStopPolicy.ASGCSamplerStopPolicy.__gridSizeLimit, python.uq.sampler.asgc.ASGCSamplerStopPolicy.ASGCSamplerStopPolicy.__oldGridSize, and python.learner.TrainingStopPolicy.TrainingStopPolicy.__oldGridSize.

Member Function Documentation

◆ fromJson()

def python.uq.sampler.asgc.ASGCSamplerStopPolicy.ASGCSamplerStopPolicy.fromJson (   cls,
  jsonObject 
)

◆ getAccuracyLimit()

def python.uq.sampler.asgc.ASGCSamplerStopPolicy.ASGCSamplerStopPolicy.getAccuracyLimit (   self)

Returns the accuracy on validation data, that have to be achieved.

Returns
: accuracy on validation data, that have to be achieved

References python.learner.TrainingStopPolicy.TrainingStopPolicy.__accuracyLimit, and python.uq.sampler.asgc.ASGCSamplerStopPolicy.ASGCSamplerStopPolicy.__accuracyLimit.

◆ getAdaptiveIterationLimit()

def python.uq.sampler.asgc.ASGCSamplerStopPolicy.ASGCSamplerStopPolicy.getAdaptiveIterationLimit (   self)

Returns the maximal number of refinement iterations.

Returns
: the maximal number of refinement iterations

References python.learner.TrainingStopPolicy.TrainingStopPolicy.__adaptiveIterationLimit, and python.uq.sampler.asgc.ASGCSamplerStopPolicy.ASGCSamplerStopPolicy.__adaptiveIterationLimit.

◆ getGridSizeLimit()

def python.uq.sampler.asgc.ASGCSamplerStopPolicy.ASGCSamplerStopPolicy.getGridSizeLimit (   self)

Returns the maximal grid size.

Returns
: maximal grid size

References python.learner.TrainingStopPolicy.TrainingStopPolicy.__gridSizeLimit, and python.uq.sampler.asgc.ASGCSamplerStopPolicy.ASGCSamplerStopPolicy.__gridSizeLimit.

Referenced by python.uq.sampler.asgc.ASGCSamplerStopPolicy.ASGCSamplerStopPolicy.hasLimitReached().

◆ hasGridSizeChanged()

def python.uq.sampler.asgc.ASGCSamplerStopPolicy.ASGCSamplerStopPolicy.hasGridSizeChanged (   self,
  sampler 
)

References python.uq.sampler.asgc.ASGCSamplerStopPolicy.ASGCSamplerStopPolicy.__oldGridSize, and python.learner.TrainingStopPolicy.TrainingStopPolicy.__oldGridSize.

Referenced by python.uq.sampler.asgc.ASGCSamplerStopPolicy.ASGCSamplerStopPolicy.isTrainingComplete().

◆ hasLimitReached()

def python.uq.sampler.asgc.ASGCSamplerStopPolicy.ASGCSamplerStopPolicy.hasLimitReached (   self,
  sampler 
)

References python.learner.TrainingStopPolicy.TrainingStopPolicy.__adaptiveIterationLimit, python.uq.sampler.asgc.ASGCSamplerStopPolicy.ASGCSamplerStopPolicy.__adaptiveIterationLimit, python.uq.sampler.asgc.ASGCSamplerStopPolicy.ASGCSamplerStopPolicy.getGridSizeLimit(), and python.learner.TrainingStopPolicy.TrainingStopPolicy.getGridSizeLimit().

Referenced by python.uq.sampler.asgc.ASGCSamplerStopPolicy.ASGCSamplerStopPolicy.isTrainingComplete().

◆ isTrainingComplete()

def python.uq.sampler.asgc.ASGCSamplerStopPolicy.ASGCSamplerStopPolicy.isTrainingComplete (   self,
  sampler 
)

Checks if learning process have to be stopped.

Parameters
samplerLearner object
Returns
: boolean value, true if learning has to stop, false otherwise

References python.uq.sampler.asgc.ASGCSamplerStopPolicy.ASGCSamplerStopPolicy.__oldGridSize, python.learner.TrainingStopPolicy.TrainingStopPolicy.__oldGridSize, python.uq.sampler.asgc.ASGCSamplerStopPolicy.ASGCSamplerStopPolicy.hasGridSizeChanged(), python.learner.TrainingStopPolicy.TrainingStopPolicy.hasGridSizeChanged(), python.uq.sampler.asgc.ASGCSamplerStopPolicy.ASGCSamplerStopPolicy.hasLimitReached(), and python.learner.TrainingStopPolicy.TrainingStopPolicy.hasLimitReached().

◆ setAccuracyLimit()

def python.uq.sampler.asgc.ASGCSamplerStopPolicy.ASGCSamplerStopPolicy.setAccuracyLimit (   self,
  limit 
)

Setter for accuracy limit.

Parameters
limitdouble accuracy on validation data, that have to be achieved

References python.learner.TrainingStopPolicy.TrainingStopPolicy.__accuracyLimit, and python.uq.sampler.asgc.ASGCSamplerStopPolicy.ASGCSamplerStopPolicy.__accuracyLimit.

◆ setAdaptiveIterationLimit()

def python.uq.sampler.asgc.ASGCSamplerStopPolicy.ASGCSamplerStopPolicy.setAdaptiveIterationLimit (   self,
  limit 
)

References python.learner.TrainingStopPolicy.TrainingStopPolicy.__adaptiveIterationLimit, and python.uq.sampler.asgc.ASGCSamplerStopPolicy.ASGCSamplerStopPolicy.__adaptiveIterationLimit.

◆ setGridSizeLimit()

def python.uq.sampler.asgc.ASGCSamplerStopPolicy.ASGCSamplerStopPolicy.setGridSizeLimit (   self,
  limit 
)

Setter for maximal grid size.

Parameters
limitinteger maximal grid size

References python.learner.TrainingStopPolicy.TrainingStopPolicy.__gridSizeLimit, and python.uq.sampler.asgc.ASGCSamplerStopPolicy.ASGCSamplerStopPolicy.__gridSizeLimit.

◆ toString()

def python.uq.sampler.asgc.ASGCSamplerStopPolicy.ASGCSamplerStopPolicy.toString (   self)

Returns a string that represents the object.

Returns
A string that represents the object. )

References create_dataset.type.


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