Skip to main content

sampling

sampling

Sampling strategy implementations for history matching.

Classes

Name Description
GridSampling Grid sampling strategy.
LatinHypercubeSampling Latin Hypercube Sampling strategy.
RandomSampling Random sampling strategy.
SamplingStrategy Abstract base class for parameter space sampling strategies.
SamplingStrategyFactory Factory for creating sampling strategy instances.

GridSampling

sampling.GridSampling(samples_per_dimension=None)

Grid sampling strategy.

Generates samples on a regular grid in parameter space, providing systematic coverage of the space.

Methods

Name Description
generate_samples Generate grid samples.
validate_parameters Validate grid sampling parameters.
generate_samples
sampling.GridSampling.generate_samples(parameter_space, n_samples, seed=None)

Generate grid samples.

validate_parameters
sampling.GridSampling.validate_parameters(**kwargs)

Validate grid sampling parameters.

LatinHypercubeSampling

sampling.LatinHypercubeSampling(criterion='maximin', iterations=5)

Latin Hypercube Sampling strategy.

Generates samples using Latin Hypercube Sampling, which ensures good space-filling properties by dividing each parameter dimension into equally-sized intervals.

Methods

Name Description
generate_samples Generate Latin Hypercube samples.
validate_parameters Validate LHS parameters.
generate_samples
sampling.LatinHypercubeSampling.generate_samples(
    parameter_space,
    n_samples,
    seed=None,
)

Generate Latin Hypercube samples.

validate_parameters
sampling.LatinHypercubeSampling.validate_parameters(**kwargs)

Validate LHS parameters.

RandomSampling

sampling.RandomSampling()

Random sampling strategy.

Generates uniformly random samples within the parameter space bounds.

Methods

Name Description
generate_samples Generate random samples.
generate_samples
sampling.RandomSampling.generate_samples(parameter_space, n_samples, seed=None)

Generate random samples.

SamplingStrategy

sampling.SamplingStrategy()

Abstract base class for parameter space sampling strategies.

Sampling strategies generate parameter samples within a given parameter space for use in history matching iterations.

Methods

Name Description
generate_samples Generate parameter samples within the given parameter space.
get_strategy_name Return human-readable name for this strategy.
validate_parameters Validate strategy-specific parameters.
generate_samples
sampling.SamplingStrategy.generate_samples(
    parameter_space,
    n_samples,
    seed=None,
)

Generate parameter samples within the given parameter space.

Parameters
Name Type Description Default
parameter_space ParameterSpace ParameterSpace defining the bounds required
n_samples int Number of samples to generate required
seed Optional[int] Random seed for reproducibility (optional) None
Returns
Name Type Description
pd.DataFrame DataFrame with columns for each parameter and rows for each sample
get_strategy_name
sampling.SamplingStrategy.get_strategy_name()

Return human-readable name for this strategy.

validate_parameters
sampling.SamplingStrategy.validate_parameters(**kwargs)

Validate strategy-specific parameters.

Override in subclasses to add parameter validation.

Raises
Name Type Description
ValueError If parameters are invalid

SamplingStrategyFactory

sampling.SamplingStrategyFactory()

Factory for creating sampling strategy instances.

Provides a registry-based approach for creating sampling strategies by name, with support for custom strategy registration.

Methods

Name Description
available_strategies Get list of available strategy names.
create Create a sampling strategy by name.
get_strategy_info Get information about a strategy.
register_strategy Register a custom sampling strategy.
available_strategies
sampling.SamplingStrategyFactory.available_strategies()

Get list of available strategy names.

Returns
Name Type Description
list[str] List of registered strategy names
create
sampling.SamplingStrategyFactory.create(strategy_name, **kwargs)

Create a sampling strategy by name.

Parameters
Name Type Description Default
strategy_name str Name of the strategy to create required
**kwargs Strategy-specific parameters {}
Returns
Name Type Description
SamplingStrategy Configured SamplingStrategy instance
Raises
Name Type Description
ValueError If strategy name is unknown
get_strategy_info
sampling.SamplingStrategyFactory.get_strategy_info(strategy_name)

Get information about a strategy.

Parameters
Name Type Description Default
strategy_name str Name of the strategy required
Returns
Name Type Description
Dict[str, str] Dict with strategy information
Raises
Name Type Description
ValueError If strategy name is unknown
register_strategy
sampling.SamplingStrategyFactory.register_strategy(name, strategy_class)

Register a custom sampling strategy.

Parameters
Name Type Description Default
name str Name to register the strategy under required
strategy_class Type[SamplingStrategy] SamplingStrategy subclass to register required
Raises
Name Type Description
TypeError If strategy_class is not a SamplingStrategy subclass