SG++-Doxygen-Documentation
Loading...
Searching...
No Matches
python.learner.LearnerBuilder.LearnerBuilder.SpecificationDescriptor Class Reference

TrainingSpecification Descriptor helps to implement fluid interface patter on python it encapsulates functionality concerning creation of the training specification. More...

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

Public Member Functions

 __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.
 
 __init__ (self, builder)
 Constructor.
 
 withAdaptPoints (self, value)
 Specifies number of points, which have to be refined in refinement step.
 
 withAdaptRate (self, value)
 Specifies rate from total number of points on grid, which should be refined.
 
 withAdaptThreshold (self, value)
 Specifies refinement threshold.
 
 withIdentityOperator (self)
 Specifies to use identity operator.
 
 withLambda (self, value)
 Specifies regression parameter of the learner.
 
 withLaplaceOperator (self)
 Specifies to use laplace operator.
 
 withVectorizationType (self, vecType)
 

Detailed Description

TrainingSpecification Descriptor helps to implement fluid interface patter on python it encapsulates functionality concerning creation of the training specification.

Constructor & Destructor Documentation

◆ __init__()

python.learner.LearnerBuilder.LearnerBuilder.SpecificationDescriptor.__init__ (   self,
  builder 
)

Constructor.

Parameters
builderLearnerBuilder which creates this Descriptor

References python.learner.LearnerBuilder.LearnerBuilder.GridDescriptor.__builder, python.learner.LearnerBuilder.LearnerBuilder.StopPolicyDescriptor.__builder, python.learner.LearnerBuilder.LearnerBuilder.SpecificationDescriptor.__builder, python.learner.LearnerBuilder.LearnerBuilder.CGSolverDescriptor.__builder, python.learner.LearnerBuilder.LearnerBuilder.FoldingDescriptor.__builder, python.learner.LearnerBuilder.LearnerBuilder.SpecificationDescriptor.__specification, python.uq.analysis.asgc.ASGCDescriptor.ASGCDescriptor.__specification, python.uq.learner.builder.InterpolantSpecificationDescriptor.InterpolantSpecificationDescriptor.__specification, python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.__specification, python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerDescriptor.__specification, python.uq.uq_setting.UQBuilder.UQBuilder.__specification, and python.uq.uq_setting.UQSetting.UQSetting.__specification.

Member Function Documentation

◆ __getattr__()

python.learner.LearnerBuilder.LearnerBuilder.SpecificationDescriptor.__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.SpecificationDescriptor.__builder, python.learner.LearnerBuilder.LearnerBuilder.CGSolverDescriptor.__builder, python.learner.LearnerBuilder.LearnerBuilder.FoldingDescriptor.__builder, python.learner.LearnerBuilder.LearnerBuilder.SpecificationDescriptor.__specification, python.uq.analysis.asgc.ASGCDescriptor.ASGCDescriptor.__specification, python.uq.learner.builder.InterpolantSpecificationDescriptor.InterpolantSpecificationDescriptor.__specification, python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.__specification, python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerDescriptor.__specification, python.uq.uq_setting.UQBuilder.UQBuilder.__specification, python.uq.uq_setting.UQSetting.UQSetting.__specification, and python.learner.LearnerBuilder.LearnerBuilder.getLearner().

◆ withAdaptPoints()

python.learner.LearnerBuilder.LearnerBuilder.SpecificationDescriptor.withAdaptPoints (   self,
  value 
)

Specifies number of points, which have to be refined in refinement step.

Parameters
valueinteger for number of points to refine
Returns
: SpecificationDescriptor itself

References python.learner.LearnerBuilder.LearnerBuilder.SpecificationDescriptor.__specification, python.uq.analysis.asgc.ASGCDescriptor.ASGCDescriptor.__specification, python.uq.learner.builder.InterpolantSpecificationDescriptor.InterpolantSpecificationDescriptor.__specification, python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.__specification, python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerDescriptor.__specification, python.uq.uq_setting.UQBuilder.UQBuilder.__specification, and python.uq.uq_setting.UQSetting.UQSetting.__specification.

◆ withAdaptRate()

python.learner.LearnerBuilder.LearnerBuilder.SpecificationDescriptor.withAdaptRate (   self,
  value 
)

Specifies rate from total number of points on grid, which should be refined.

Parameters
valuefloat for rate
Returns
: SpecificationDescriptor itself

References python.learner.LearnerBuilder.LearnerBuilder.SpecificationDescriptor.__specification, python.uq.analysis.asgc.ASGCDescriptor.ASGCDescriptor.__specification, python.uq.learner.builder.InterpolantSpecificationDescriptor.InterpolantSpecificationDescriptor.__specification, python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.__specification, python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerDescriptor.__specification, python.uq.uq_setting.UQBuilder.UQBuilder.__specification, and python.uq.uq_setting.UQSetting.UQSetting.__specification.

◆ withAdaptThreshold()

python.learner.LearnerBuilder.LearnerBuilder.SpecificationDescriptor.withAdaptThreshold (   self,
  value 
)

Specifies refinement threshold.

Parameters
valuefloat for refinement threshold
Returns
: SpecificationDescriptor itself

References python.learner.LearnerBuilder.LearnerBuilder.SpecificationDescriptor.__specification, python.uq.analysis.asgc.ASGCDescriptor.ASGCDescriptor.__specification, python.uq.learner.builder.InterpolantSpecificationDescriptor.InterpolantSpecificationDescriptor.__specification, python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.__specification, python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerDescriptor.__specification, python.uq.uq_setting.UQBuilder.UQBuilder.__specification, and python.uq.uq_setting.UQSetting.UQSetting.__specification.

◆ withIdentityOperator()

python.learner.LearnerBuilder.LearnerBuilder.SpecificationDescriptor.withIdentityOperator (   self)

Specifies to use identity operator.

Returns
: SpecificationDescriptor itself

References python.learner.LearnerBuilder.LearnerBuilder.SpecificationDescriptor.__specification, python.uq.analysis.asgc.ASGCDescriptor.ASGCDescriptor.__specification, python.uq.learner.builder.InterpolantSpecificationDescriptor.InterpolantSpecificationDescriptor.__specification, python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.__specification, python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerDescriptor.__specification, python.uq.uq_setting.UQBuilder.UQBuilder.__specification, and python.uq.uq_setting.UQSetting.UQSetting.__specification.

◆ withLambda()

python.learner.LearnerBuilder.LearnerBuilder.SpecificationDescriptor.withLambda (   self,
  value 
)

Specifies regression parameter of the learner.

Parameters
valuefloat for regression parameter
Returns
: SpecificationDescriptor itself

References python.learner.LearnerBuilder.LearnerBuilder.SpecificationDescriptor.__specification, python.uq.analysis.asgc.ASGCDescriptor.ASGCDescriptor.__specification, python.uq.learner.builder.InterpolantSpecificationDescriptor.InterpolantSpecificationDescriptor.__specification, python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.__specification, python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerDescriptor.__specification, python.uq.uq_setting.UQBuilder.UQBuilder.__specification, and python.uq.uq_setting.UQSetting.UQSetting.__specification.

◆ withLaplaceOperator()

python.learner.LearnerBuilder.LearnerBuilder.SpecificationDescriptor.withLaplaceOperator (   self)

Specifies to use laplace operator.

Returns
: SpecificationDescriptor itself

References python.learner.LearnerBuilder.LearnerBuilder.SpecificationDescriptor.__specification, python.uq.analysis.asgc.ASGCDescriptor.ASGCDescriptor.__specification, python.uq.learner.builder.InterpolantSpecificationDescriptor.InterpolantSpecificationDescriptor.__specification, python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.__specification, python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerDescriptor.__specification, python.uq.uq_setting.UQBuilder.UQBuilder.__specification, and python.uq.uq_setting.UQSetting.UQSetting.__specification.

◆ withVectorizationType()

python.learner.LearnerBuilder.LearnerBuilder.SpecificationDescriptor.withVectorizationType (   self,
  vecType 
)

References python.learner.LearnerBuilder.LearnerBuilder.SpecificationDescriptor.__specification, python.uq.analysis.asgc.ASGCDescriptor.ASGCDescriptor.__specification, python.uq.learner.builder.InterpolantSpecificationDescriptor.InterpolantSpecificationDescriptor.__specification, python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.__specification, python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerDescriptor.__specification, python.uq.uq_setting.UQBuilder.UQBuilder.__specification, and python.uq.uq_setting.UQSetting.UQSetting.__specification.


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