SG++-Doxygen-Documentation
python.learner.LearnerBuilder.LearnerBuilder.StopPolicyDescriptor Class Reference

TrainingStopPolicy Descriptor helps to implement fluid interface patter on python it encapsulates functionality concerning creation of the training stop policy. More...

Inheritance diagram for python.learner.LearnerBuilder.LearnerBuilder.StopPolicyDescriptor:

Public Member Functions

def __getattr__ (self, attr)
 Overrides built-in method if method called is not a object method of this Descriptor, most probably it's a method of LearnerBuilder so it tries to call the method from our builder. More...
 
def __init__ (self, builder)
 Constructor. More...
 
def withAccuracyLimit (self, limit)
 Defines the accuracy for test data, which have to be arrived. More...
 
def withAdaptiveIterationLimit (self, limit)
 Defines the maximal number of refinement steps limit. More...
 
def withEpochsLimit (self, limit)
 Defines the maximal number of epochs MSE of test data can constantly increase. More...
 
def withGridSizeLimit (self, limit)
 Defines the maximal number of points on grid. More...
 
def withMSELimit (self, limit)
 Defines the MSE for test data, which have to be arrived. More...
 

Detailed Description

TrainingStopPolicy Descriptor helps to implement fluid interface patter on python it encapsulates functionality concerning creation of the training stop policy.

Constructor & Destructor Documentation

◆ __init__()

def python.learner.LearnerBuilder.LearnerBuilder.StopPolicyDescriptor.__init__ (   self,
  builder 
)

Constructor.

Parameters
builderLearnerBuilder which creates this Descriptor

References python.learner.LearnerBuilder.LearnerBuilder.GridDescriptor.__builder, python.learner.LearnerBuilder.LearnerBuilder.StopPolicyDescriptor.__builder, and python.learner.LearnerBuilder.LearnerBuilder.StopPolicyDescriptor.__policy.

Member Function Documentation

◆ __getattr__()

def python.learner.LearnerBuilder.LearnerBuilder.StopPolicyDescriptor.__getattr__ (   self,
  attr 
)

Overrides built-in method if method called is not a object method of this Descriptor, most probably it's a method of LearnerBuilder so it tries to call the method from our builder.

Parameters
attrString for method name
Returns
: Method calling in LearnerBuilder

References python.learner.LearnerBuilder.LearnerBuilder.GridDescriptor.__builder, python.learner.LearnerBuilder.LearnerBuilder.StopPolicyDescriptor.__builder, python.learner.LearnerBuilder.LearnerBuilder.StopPolicyDescriptor.__policy, and python.learner.LearnerBuilder.LearnerBuilder.getLearner().

◆ withAccuracyLimit()

def python.learner.LearnerBuilder.LearnerBuilder.StopPolicyDescriptor.withAccuracyLimit (   self,
  limit 
)

Defines the accuracy for test data, which have to be arrived.

Parameters
limitfloat for accuracy
Returns
: StopPolicyDescriptor itself

References python.learner.LearnerBuilder.LearnerBuilder.StopPolicyDescriptor.__policy.

◆ withAdaptiveIterationLimit()

def python.learner.LearnerBuilder.LearnerBuilder.StopPolicyDescriptor.withAdaptiveIterationLimit (   self,
  limit 
)

Defines the maximal number of refinement steps limit.

Parameters
limitinteger for maximal number of refinement steps
Returns
: StopPolicyDescriptor itself

References python.learner.LearnerBuilder.LearnerBuilder.StopPolicyDescriptor.__policy.

◆ withEpochsLimit()

def python.learner.LearnerBuilder.LearnerBuilder.StopPolicyDescriptor.withEpochsLimit (   self,
  limit 
)

Defines the maximal number of epochs MSE of test data can constantly increase.

Parameters
limitinteger for maximal number of epochs
Returns
: StopPolicyDescriptor itself

References python.learner.LearnerBuilder.LearnerBuilder.StopPolicyDescriptor.__policy.

◆ withGridSizeLimit()

def python.learner.LearnerBuilder.LearnerBuilder.StopPolicyDescriptor.withGridSizeLimit (   self,
  limit 
)

Defines the maximal number of points on grid.

Parameters
limitinteger for maximal number of points on grid
Returns
: StopPolicyDescriptor itself

References python.learner.LearnerBuilder.LearnerBuilder.StopPolicyDescriptor.__policy.

◆ withMSELimit()

def python.learner.LearnerBuilder.LearnerBuilder.StopPolicyDescriptor.withMSELimit (   self,
  limit 
)

Defines the MSE for test data, which have to be arrived.

Parameters
limitfloat for MSE
Returns
: StopPolicyDescriptor itself

References python.learner.LearnerBuilder.LearnerBuilder.StopPolicyDescriptor.__policy.


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