PhysicalSpaceCrossEntropyImportanceSampling¶

class PhysicalSpaceCrossEntropyImportanceSampling(*args)¶

Physical Space Cross-Entropy Importance Sampling.

Parameters:

eventThresholdEvent: Event we are computing the probability of.
activeParameterssequence of integers: List of active parameters indices for the auxiliary distribution.
initialAuxiliaryDistributionParameterssequence of floats: Initial value of active parameters of the auxiliary distribution.
boundsInterval: Bounds on the active parameters of the auxiliary distribution.
auxiliaryDistributionDistribution: Auxiliary distribution for the Cross Entropy Importance Sampling algorithm.
quantileLevelfloat $0<quantileLevel<1$: Intermediate quantile level. The default number can be tweaked with the CrossEntropyImportanceSampling-DefaultQuantileLevel key from ResourceMap.

Methods

`drawProbabilityConvergence`(*args)	Draw the probability convergence at a given level.
`getBlockSize`()	Accessor to the block size.
`getClassName`()	Accessor to the object's name.
`getConvergenceStrategy`()	Accessor to the convergence strategy.
`getEvent`()	Accessor to the event.
`getInputSample`(*args)	Input sample accessor.
`getMaximumCoefficientOfVariation`()	Accessor to the maximum coefficient of variation.
`getMaximumOuterSampling`()	Accessor to the maximum iterations number.
`getMaximumStandardDeviation`()	Accessor to the maximum standard deviation.
`getMaximumTimeDuration`()	Accessor to the maximum duration.
`getName`()	Accessor to the object's name.
`getOptimizationAlgorithm`()	Accessor to the optimization algorithm used to update auxiliary distribution parameters.
`getOutputSample`(*args)	Output sample accessor.
`getQuantileLevel`()	Accessor to the intermediate quantile level.
`getResult`()	Accessor to the intermediate quantile level.
`getStepsNumber`()	Subset steps number accessor.
`getThresholdPerStep`()	Threshold accessor.
`hasName`()	Test if the object is named.
`run`()	Launch simulation.
`setBlockSize`(blockSize)	Accessor to the block size.
`setConvergenceStrategy`(convergenceStrategy)	Accessor to the convergence strategy.
`setKeepSample`(keepSample)	Sample storage accessor.
`setMaximumCoefficientOfVariation`(...)	Accessor to the maximum coefficient of variation.
`setMaximumOuterSampling`(maximumOuterSampling)	Accessor to the maximum iterations number.
`setMaximumStandardDeviation`(...)	Accessor to the maximum standard deviation.
`setMaximumTimeDuration`(maximumTimeDuration)	Accessor to the maximum duration.
`setName`(name)	Accessor to the object's name.
`setOptimizationAlgorithm`(solver)	Accessor to the optimization algorithm used to update auxiliary distribution parameters.
`setProgressCallback`(*args)	Set up a progress callback.
`setQuantileLevel`(quantileLevel)	Accessor to the intermediate quantile level.
`setStopCallback`(*args)	Set up a stop callback.

See also

StandardSpaceCrossEntropyImportanceSampling, CrossEntropyImportanceSampling, CrossEntropyResult

Notes

The following explanations are given for a failure event defined as $g(\vect{X})<T$ with $\vect{X}$ a random vector following a joint PDF $f_\vect{X}$ , $T$ a threshold and $g$ a limit state function, without loss of generality.

The Importance Sampling (IS) probability estimate $\widehat{P}^\text{IS}$ is given by:

$\widehat{P}^\text{IS}=\frac{1}{N} \sum_{i=1}^{N} {\vect{1}}_{g(\vect{x}_i)<T} \frac{f_\vect{X}(\vect{x}_i)}{h(\vect{x}_i)},$

with $h$ the auxiliary PDF of Importance Sampling, $N$ the number of independent samples generated with $h$ and ${\vect{1}}_{g(\vect{x}_i)<T}$ the indicator function of the failure domain.

The optimal density $h_{opt}$ minimizing the variance of the estimator is defined as:

$h_{opt}=\frac{{\vect{1}}_{g(\vect{x})<T}f_\vect{X}}{P},$

with $P$ the failure probability which is inaccessible in practice since this probability is the quantity of interest and unknown.

The Physical Space Cross-Entropy Importance Sampling algorithm [rubinstein2017] uses a parametric auxiliary distribution $h_\vect{\lambda}$ in order to optimize its parameters to compute the probability of interest with accuracy.

It involves an auxiliary optimization problem to find the auxiliary distribution parameters $\vect{\lambda}$ minimizing the Kullback-Leibler divergence with respect to $h_{opt}$ . The following algorithm is used:

$k=1$ , set the quantile level $\rho \in [0,1]$ and $h_0 = f_{\vect{X}}$
Generate the population $\vect{x}_1^{(k)},...,\vect{x}_N^{(k)}$ according to the PDF $h_{k-1}$ , apply the function $g$ in order to have $y_1^{(k)}=g(\vect{x}_1^{(k)}),...,y_N^{(k)} = g(\vect{x}_N^{(k)})$
Compute the empirical $\rho$ -quantile $q_k=\max(T,y^{(k)}_{\left \lfloor \rho N \right\rfloor})$ using the floor of $\rho N$ .
If $q_k>T$ : go to Step 7
Estimate the auxiliary distribution parameters:

$\vect{\lambda}_{k}= \textrm{argmax}_{\lambda} \frac{1}{N} \sum_{i=1}^{N}{\vect{1}}_{g(\vect{x}_i^{(k)}) \leq q_k} \frac{f_\vect{X}(\vect{x}_i^{(k)})}{h_{\vect{\lambda}_{k-1}}(\vect{x}_i^{(k)})} \log(h_{\vect{\lambda}}(\vect{x}_i^{(k)}))$
$k\leftarrow k+1$ , go to Step 2
Estimate the probability $\widehat{P}^{CE}(g(\vect{\vect{X}})<T)=\frac{1}{N}\displaystyle \sum_{i=1}^{N} \vect{1}_{g(\vect{x}_i^{(k)})<T} \frac{f_\vect{X}(\vect{x}_i^{(k)})}{h_{\vect{\lambda}_{k-1}(\vect{x}_i^{(k)})}}$ .

Default solver for the optimization of auxiliary distribution is LD_LBFGS from NLopt.

Examples

>>> import openturns as ot
>>> ot.RandomGenerator.SetSeed(0)
>>> distribution_R = ot.LogNormalMuSigma(300.0, 30.0, 0.0).getDistribution()
>>> distribution_F = ot.Normal(75e3, 5e3)
>>> marginals = [distribution_R, distribution_F]
>>> distribution = ot.JointDistribution(marginals)
>>> # create the model
>>> model = ot.SymbolicFunction(['R', 'F'], ['R-F/(pi_*100.0)'])   
>>> # create the event 
>>> vect = ot.RandomVector(distribution)
>>> G = ot.CompositeRandomVector(model, vect)
>>> event = ot.ThresholdEvent(G, ot.Less(), 0.0)
>>> distribution_marginR = ot.LogNormalMuSigma().getDistribution()
>>> distribution_marginF = ot.Normal()
>>> aux_marginals = [distribution_marginR, distribution_marginF]
>>> aux_distribution = ot.JointDistribution(aux_marginals)
>>> # definition of auxiliary distribution parameters to be optimized
>>> active_parameters = [0,1,2,3,4]
>>> ### WARNING : native parameters of distribution have to be considered
>>> bounds = ot.Interval([3,0.09,0.,50e3,2e3], [7,0.5,0.5,100e3,10e3])# bounds on the active parameters
>>> initial_theta= [5.70,0.1,0.,75e3,5e3] # initial value of the active parameters
>>> my_IS_physical = ot.PhysicalSpaceCrossEntropyImportanceSampling(event,aux_distribution,active_parameters,initial_theta,bounds,0.3)
>>> my_IS_physical.run()
>>> myResult = my_IS_physical.getResult()

__init__(*args)¶

drawProbabilityConvergence(*args)¶

Draw the probability convergence at a given level.

Parameters:

levelfloat, optional: The probability convergence is drawn at this given confidence length level. By default level is 0.95.

Returns:

grapha Graph: probability convergence graph

getBlockSize()¶

Accessor to the block size.

Returns:

blockSizeint: Number of simultaneous evaluations of the limit-state function. It is set by default to 1.

getClassName()¶

Accessor to the object’s name.

Returns:

class_namestr: The object class name (object.__class__.__name__).

getConvergenceStrategy()¶

Accessor to the convergence strategy.

Returns:

storage_strategyHistoryStrategy: Storage strategy used to store the values of the probability estimator and its variance during the simulation algorithm.

getEvent()¶

Accessor to the event.

Returns:

eventRandomVector: Event we want to evaluate the probability.

getInputSample(*args)¶

Input sample accessor.

Parameters:

stepint

Iteration index

selectint, optional

Selection flag:

EVENT0 : points not realizing the event are selected
EVENT1 : points realizing the event are selected
BOTH : all points are selected (default)

Returns:

inputSampleSample: Input sample.

getMaximumCoefficientOfVariation()¶

Accessor to the maximum coefficient of variation.

Returns:

coefficientfloat: Maximum coefficient of variation of the simulated sample.

getMaximumOuterSampling()¶

Accessor to the maximum iterations number.

Returns:

outerSamplingint: Maximum number of iterations, each iteration performing a block of evaluations.

getMaximumStandardDeviation()¶

Accessor to the maximum standard deviation.

Returns:

sigmafloat, $\sigma > 0$: Maximum standard deviation of the estimator.

getMaximumTimeDuration()¶

Accessor to the maximum duration.

Returns:

maximumTimeDurationfloat: Maximum optimization duration in seconds.

getName()¶

Accessor to the object’s name.

Returns:

namestr: The name of the object.

getOptimizationAlgorithm()¶

Accessor to the optimization algorithm used to update auxiliary distribution parameters.

Returns:

algorithmOptimizationAlgorithm

getOutputSample(*args)¶

Output sample accessor.

Parameters:

stepint

Iteration index

selectint, optional

Selection flag:

EVENT0 : points not realizing the event are selected
EVENT1 : points realizing the event are selected
BOTH : all points are selected (default)

Returns:

outputSampleSample: Output sample.

getQuantileLevel()¶

Accessor to the intermediate quantile level.

Returns:

quantileLevelfloat: Result of Cross Entropy algorithm.

getResult()¶

Accessor to the intermediate quantile level.

Returns:

CrossEntropyResultCrossEntropyResult: Contains all the results of the Cross Entropy algorithm simulation.

getStepsNumber()¶

Subset steps number accessor.

Returns:

nint: Number of subset steps, including the initial Monte Carlo sampling.

getThresholdPerStep()¶

Threshold accessor.

Returns:

thresholdPoint: Threshold values at each step.

hasName()¶

Test if the object is named.

Returns:

hasNamebool: True if the name is not empty.

run()¶

Launch simulation.

See also

openturns.EventSimulation.setBlockSize
openturns.EventSimulation.setMaximumOuterSampling
openturns.ResourceMap
openturns.SimulationResult

Notes

It launches the simulation and creates a SimulationResult, structure containing all the results obtained after simulation. It computes the probability of occurrence of the given event by computing the empirical mean of a sample of size at most outerSampling * blockSize, this sample being built by blocks of size blockSize. It allows one to use efficiently the distribution of the computation as well as it allows one to deal with a sample size $> 2^{32}$ by a combination of blockSize and outerSampling.

setBlockSize(blockSize)¶

Accessor to the block size.

Parameters:

blockSizeint, $blockSize \geq 1$: Number of simultaneous evaluations of the limit-state function. It is set by default to 1.

Notes

If the function supports batch evaluations this parameter can be set to the number of available CPUs to benefit from parallel execution (multithreading, multiprocessing, …); except for the Directional Sampling, where we recommend to set it to 1. It also decides the frequency of the stopping criteria and progress callbacks update as they are called once the whole block of fonction evaluations is completed.

setConvergenceStrategy(convergenceStrategy)¶

Accessor to the convergence strategy.

Parameters:

storage_strategyHistoryStrategy: Storage strategy used to store the values of the probability estimator and its variance during the simulation algorithm.

setKeepSample(keepSample)¶

Sample storage accessor.

Parameters:

keepsamplebool: Whether to keep the working samples at each iteration.

setMaximumCoefficientOfVariation(maximumCoefficientOfVariation)¶

Accessor to the maximum coefficient of variation.

Parameters:

coefficientfloat: Maximum coefficient of variation of the simulated sample.

setMaximumOuterSampling(maximumOuterSampling)¶

Accessor to the maximum iterations number.

Parameters:

outerSamplingint: Maximum number of iterations, each iteration performing a block of evaluations.

setMaximumStandardDeviation(maximumStandardDeviation)¶

Accessor to the maximum standard deviation.

Parameters:

sigmafloat, $\sigma > 0$: Maximum standard deviation of the estimator.

setMaximumTimeDuration(maximumTimeDuration)¶

Accessor to the maximum duration.

Parameters:

maximumTimeDurationfloat: Maximum optimization duration in seconds.

setName(name)¶

Accessor to the object’s name.

Parameters:

namestr: The name of the object.

setOptimizationAlgorithm(solver)¶

Accessor to the optimization algorithm used to update auxiliary distribution parameters.

Parameters:

algorithmOptimizationAlgorithm

setProgressCallback(*args)¶

Set up a progress callback.

Can be used to programmatically report the progress of a simulation.

Parameters:

callbackcallable: Takes a float as argument as percentage of progress.

Examples

>>> import sys
>>> import openturns as ot
>>> experiment = ot.MonteCarloExperiment()
>>> X = ot.RandomVector(ot.Normal())
>>> Y = ot.CompositeRandomVector(ot.SymbolicFunction(['X'], ['1.1*X']), X)
>>> event = ot.ThresholdEvent(Y, ot.Less(), -2.0)
>>> algo = ot.ProbabilitySimulationAlgorithm(event, experiment)
>>> algo.setMaximumOuterSampling(100)
>>> algo.setMaximumCoefficientOfVariation(-1.0)
>>> def report_progress(progress):
...     sys.stderr.write('-- progress=' + str(progress) + '%\n')
>>> algo.setProgressCallback(report_progress)
>>> algo.run()

setQuantileLevel(quantileLevel)¶

Accessor to the intermediate quantile level.

Parameters:

quantileLevelfloat: Intermediate quantile level, must belong to the interval (0,1).

setStopCallback(*args)¶

Set up a stop callback.

Can be used to programmatically stop a simulation.

Parameters:

callbackcallable: Returns an int deciding whether to stop or continue.

Examples

Stop a Monte Carlo simulation algorithm using a time limit

>>> import openturns as ot
>>> experiment = ot.MonteCarloExperiment()
>>> X = ot.RandomVector(ot.Normal())
>>> Y = ot.CompositeRandomVector(ot.SymbolicFunction(['X'], ['1.1*X']), X)
>>> event = ot.ThresholdEvent(Y, ot.Less(), -2.0)
>>> algo = ot.ProbabilitySimulationAlgorithm(event, experiment)
>>> algo.setMaximumOuterSampling(10000000)
>>> algo.setMaximumCoefficientOfVariation(-1.0)
>>> algo.setMaximumTimeDuration(0.1)
>>> algo.run()

Examples using the class¶

Cross Entropy Importance Sampling

OpenTURNS

An Open source initiative for the Treatment of Uncertainties, Risks'N Statistics

Table of Contents

Previous topic

Next topic

This Page

PhysicalSpaceCrossEntropyImportanceSampling¶

Examples using the class¶