EngineBuilder#
- class liesel.goose.builder.EngineBuilder(seed, num_chains)[source]#
Bases:
object
The
EngineBuilder
is used to construct an MCMC Engine.Currently, the
EngineBuilder
builds an object of the classEngine
.By default, every position key associated with an MCMC kernel is tracked. This behavior can be adjusted with the fields
positions_included
andpositions_excluded
.- Parameters:
Methods
add_kernel
(kernel)Adds a
Kernel
.add_quantity_generator
(generator)Adds a
QuantityGenerator
.build
()Builds the MCMC engine with the provided setup.
set_duration
(warmup_duration, posterior_duration)Sets epochs using the
stan_epochs()
function.set_engine_seed
(seed)Sets a seed used to initialize the MCMC engine.
set_epochs
(epochs)Sets epochs.
set_initial_values
(model_state[, ...])Sets the initial model state.
set_jitter_fns
(jitter_fns)Set the jittering functions.
set_model
(model)Sets the model interface for all kernels and quantity generators.
Attributes
The seed for the engine's pseudo-random number generation.
Tuple of epoch configurations.
Jittering functions.
Tuple of all Kernels that are present in the builder.
Model state.
Tuple of all quantity generators present in the builder.
List of additional position keys that should be tracked.
List of position keys that should not be tracked.