python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerDescriptor Class Reference

Inheritance diagram for python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerDescriptor:

Public Member Functions
def	__init__ (self, builder)
def	withAdaptPoints (self, value)
def	withAdaptRate (self, value)
def	withAdaptThreshold (self, value)
def	withParameters (self, params)
def	withQoI (self, qoi)
def	withRefinement (self)
def	withStartingIterationNumber (self, iteration)
def	withTimeStepsOfInterest (self, ts)
def	withTypesOfKnowledge (self, knowledgeTypes)

Detailed Description

Specification descriptor for ASGCSampler

Constructor & Destructor Documentation

__init__()

def python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerDescriptor.__init__	(		self,
			builder
	)

References python.uq.analysis.asgc.ASGCDescriptor.ASGCDescriptor.__specification, python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.__specification, python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerDescriptor.__specification, python.learner.LearnerBuilder.LearnerBuilder.SpecificationDescriptor.__specification, 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, and python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerDescriptor._builder.

Member Function Documentation

withAdaptPoints()

def python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerDescriptor.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, python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerDescriptor.__specification, and python.learner.LearnerBuilder.LearnerBuilder.SpecificationDescriptor.__specification.

withAdaptRate()

def python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerDescriptor.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, python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerDescriptor.__specification, and python.learner.LearnerBuilder.LearnerBuilder.SpecificationDescriptor.__specification.

withAdaptThreshold()

def python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerDescriptor.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, python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerDescriptor.__specification, and python.learner.LearnerBuilder.LearnerBuilder.SpecificationDescriptor.__specification.

withParameters()

def python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerDescriptor.withParameters	(		self,
			params
	)

Set the parameter setting
@param params: ParameterSet

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

withQoI()

def python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerDescriptor.withQoI	(		self,
			qoi
	)

Define, which quantity of interest we study.
@param qoi: string quantity of interest

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

withRefinement()

def python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerDescriptor.withRefinement

(

self

)

Define if spatially adaptive refinement should be done and how...

References 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, and python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerDescriptor._builder.

withStartingIterationNumber()

def python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerDescriptor.withStartingIterationNumber	(		self,
			iteration
	)

Set the starting iteration number
@param iteration: integer starting iteration number

References 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, and python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerDescriptor._builder.

withTimeStepsOfInterest()

def python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerDescriptor.withTimeStepsOfInterest	(		self,
			ts
	)

Define the time steps in which we are interested in. The learner
just learns those, which are specified here. Moreover, it considers
just this time steps for refinement.
@param ts: list of floats, time steps

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

withTypesOfKnowledge()

def python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerDescriptor.withTypesOfKnowledge	(		self,
			knowledgeTypes
	)

Define for which type of functions the hierarchical coefficients are
computed using the specified learner.
@param knowledgeTypes: list of KnowledgetTypes

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

---

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

• datadriven/python/uq/learner/builder/SimulationLearnerBuilder.py