SG++-Doxygen-Documentation
python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor Class Reference
Inheritance diagram for python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor:

Public Member Functions

def __getattr__ (self, attr)
 
def __init__ (self, builder)
 
def create (self)
 
def withAdaptPoints (self, value)
 
def withAdaptRate (self, value)
 
def withAdaptThreshold (self, value)
 
def withCGSolver (self)
 
def withFilesFoldingPolicy (self)
 
def withGrid (self)
 
def withIdentityOperator (self)
 
def withLambda (self, value)
 
def withLaplaceOperator (self)
 
def withRandomFoldingPolicy (self)
 
def withSequentialFoldingPolicy (self)
 
def withStopPolicy (self)
 
def withStratifiedFoldingPolicy (self)
 

Public Attributes

 dtype
 

Detailed Description

TrainingSpecification Descriptor helps to implement fluid interface pattern
on Python it encapsulates functionality concerning creation of the training
specification

Constructor & Destructor Documentation

◆ __init__()

def python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.__init__ (   self,
  builder 
)
Constructor
@param builder: LearnerBuilder which creates this Descriptor

References python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.__foldingPolicyDescriptor, python.learner.LearnerBuilder.LearnerBuilder.__foldingPolicyDescriptor, python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.__solverDescriptor, python.learner.LearnerBuilder.LearnerBuilder.__solverDescriptor, python.uq.analysis.asgc.ASGCDescriptor.ASGCDescriptor.__specification, python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.__specification, python.learner.LearnerBuilder.LearnerBuilder.SpecificationDescriptor.__specification, python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.__stopPolicyDescriptor, python.learner.LearnerBuilder.LearnerBuilder.__stopPolicyDescriptor, python.uq.learner.builder.InterpolantSpecificationDescriptor.InterpolantSpecificationDescriptor._builder, python.uq.learner.builder.CGSolverDescriptor.CGSolverDescriptor._builder, python.uq.analysis.asgc.ASGCDescriptor.ASGCDescriptor._builder, and python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor._builder.

Member Function Documentation

◆ __getattr__()

def python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.__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
@param attr: String for method name
@return: Method calling in LearnerBuilder

References python.uq.learner.builder.InterpolantSpecificationDescriptor.InterpolantSpecificationDescriptor._builder, python.uq.learner.builder.CGSolverDescriptor.CGSolverDescriptor._builder, python.uq.analysis.asgc.ASGCDescriptor.ASGCDescriptor._builder, and python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor._builder.

◆ create()

def python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.create (   self)

References python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.__foldingPolicyDescriptor, python.learner.LearnerBuilder.LearnerBuilder.__foldingPolicyDescriptor, python.uq.analysis.asgc.ASGCDescriptor.ASGCDescriptor.__specification, python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.__specification, python.learner.LearnerBuilder.LearnerBuilder.SpecificationDescriptor.__specification, python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.__stopPolicyDescriptor, python.learner.LearnerBuilder.LearnerBuilder.__stopPolicyDescriptor, python.uq.learner.builder.InterpolantSpecificationDescriptor.InterpolantSpecificationDescriptor._builder, python.uq.learner.builder.CGSolverDescriptor.CGSolverDescriptor._builder, python.uq.analysis.asgc.ASGCDescriptor.ASGCDescriptor._builder, python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor._builder, sgpp::op_factory.createOperationIdentity(), sgpp::op_factory.createOperationLaplace(), python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.withStopPolicy(), and python.learner.LearnerBuilder.LearnerBuilder.withStopPolicy().

◆ withAdaptPoints()

def python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.withAdaptPoints (   self,
  value 
)
Specifies number of points, which have to be refined in refinement step
@param value: integer for number of points to refine

References python.uq.analysis.asgc.ASGCDescriptor.ASGCDescriptor.__specification, python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.__specification, and python.learner.LearnerBuilder.LearnerBuilder.SpecificationDescriptor.__specification.

◆ withAdaptRate()

def python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.withAdaptRate (   self,
  value 
)
Specifies rate from total number of points on grid, which should be
refined.
@param value: float for rate

References python.uq.analysis.asgc.ASGCDescriptor.ASGCDescriptor.__specification, python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.__specification, and python.learner.LearnerBuilder.LearnerBuilder.SpecificationDescriptor.__specification.

◆ withAdaptThreshold()

def python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.withAdaptThreshold (   self,
  value 
)
Specifies refinement threshold
@param value: float for refinement threshold

References python.uq.analysis.asgc.ASGCDescriptor.ASGCDescriptor.__specification, python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.__specification, and python.learner.LearnerBuilder.LearnerBuilder.SpecificationDescriptor.__specification.

◆ withCGSolver()

def python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.withCGSolver (   self)
Start description of parameters of CG-Solver for learner

References python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.__solverDescriptor, and python.learner.LearnerBuilder.LearnerBuilder.__solverDescriptor.

◆ withFilesFoldingPolicy()

def python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.withFilesFoldingPolicy (   self)
Signals to use N-fold cross validation from a set of files

References python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.__foldingPolicyDescriptor, and python.learner.LearnerBuilder.LearnerBuilder.__foldingPolicyDescriptor.

◆ withGrid()

def python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.withGrid (   self)
Start description of the grid

References python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor._gridDescriptor, and python.uq.learner.builder.LearnerBuilder.LearnerBuilder._gridDescriptor.

◆ withIdentityOperator()

def python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.withIdentityOperator (   self)
Specifies to use identity operator

References python.uq.analysis.asgc.ASGCDescriptor.ASGCDescriptor.__specification, python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.__specification, and python.learner.LearnerBuilder.LearnerBuilder.SpecificationDescriptor.__specification.

◆ withLambda()

def python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.withLambda (   self,
  value 
)
Specifies regression parameter of the learner
@param value: float for regression parameter

References python.uq.analysis.asgc.ASGCDescriptor.ASGCDescriptor.__specification, python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.__specification, and python.learner.LearnerBuilder.LearnerBuilder.SpecificationDescriptor.__specification.

◆ withLaplaceOperator()

def python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.withLaplaceOperator (   self)
Specifies to use laplace operator

References python.uq.analysis.asgc.ASGCDescriptor.ASGCDescriptor.__specification, python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.__specification, and python.learner.LearnerBuilder.LearnerBuilder.SpecificationDescriptor.__specification.

◆ withRandomFoldingPolicy()

def python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.withRandomFoldingPolicy (   self)
Signals to use N-fold cross validation with random folding rule

References python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.__foldingPolicyDescriptor, and python.learner.LearnerBuilder.LearnerBuilder.__foldingPolicyDescriptor.

◆ withSequentialFoldingPolicy()

def python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.withSequentialFoldingPolicy (   self)
Signals to use N-fold cross validation with sequential folding rule

References python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.__foldingPolicyDescriptor, and python.learner.LearnerBuilder.LearnerBuilder.__foldingPolicyDescriptor.

◆ withStopPolicy()

def python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.withStopPolicy (   self)
Start description of parameters of stop-policy for learner

References python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.__stopPolicyDescriptor, python.learner.LearnerBuilder.LearnerBuilder.__stopPolicyDescriptor, python.uq.learner.builder.InterpolantSpecificationDescriptor.InterpolantSpecificationDescriptor._builder, python.uq.learner.builder.CGSolverDescriptor.CGSolverDescriptor._builder, python.uq.analysis.asgc.ASGCDescriptor.ASGCDescriptor._builder, and python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor._builder.

Referenced by python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.create().

◆ withStratifiedFoldingPolicy()

def python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.withStratifiedFoldingPolicy (   self)
Signals to use N-fold cross validation with stratified folding rule

References python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.__foldingPolicyDescriptor, and python.learner.LearnerBuilder.LearnerBuilder.__foldingPolicyDescriptor.

Member Data Documentation

◆ dtype

python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.dtype

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