diff --git a/dev/api/index.html b/dev/api/index.html index 4e132b8..519edfb 100644 --- a/dev/api/index.html +++ b/dev/api/index.html @@ -457,6 +457,7 @@ }); +
GitHub

API

Temper samplers

MCMCTempering.tempered — Function
tempered(sampler, inverse_temperatures; kwargs...)
 OR
 tempered(sampler, num_temps; swap_strategy=ReversibleSwap(), kwargs...)

Return a tempered version of sampler using the provided inverse_temperatures or inverse temperatures generated from num_temps and the swap_strategy.

Arguments

  • sampler is an algorithm or sampler object to be used for underlying sampling and to apply tempering to
  • The temperature schedule can be defined either explicitly or just as an integer number of temperatures, i.e. as:
    • inverse_temperatures containing a sequence of 'inverse temperatures' {β₀, ..., βₙ} where 0 ≤ βₙ < ... < β₁ < β₀ = 1 OR
    • num_temps, specifying the integer number of inverse temperatures to include in a generated inverse_temperatures

Keyword arguments

  • swap_strategy::AbstractSwapStrategy specifies the method for swapping inverse temperatures between chains
  • steps_per_swap::Integer steps are carried out between each attempt at a swap

See also

source
MCMCTempering.TemperedSampler — Type
TemperedSampler <: AbstractMCMC.AbstractSampler

A TemperedSampler struct wraps a sampler upon which to apply the Parallel Tempering algorithm.

Fields

  • sampler: sampler(s) used to target the tempered distributions

  • chain_to_beta: collection of inverse temperatures β; β[i] correponds i-th tempered model

  • swapstrategy: strategy to use for swapping

  • adapt: boolean flag specifying whether or not to adapt

  • adaptation_states: adaptation parameters

source

Under the hood, MCMCTempering.TemperedSampler is actually just a "fancy" representation of a composition (represented using a MCMCTempering.CompositionSampler) of a MCMCTempering.MultiSampler and a MCMCTempering.SwapSampler.

Roughly speaking, the implementation of AbstractMCMC.step for MCMCTempering.TemperedSampler is basically

# 1. Construct the tempered models.
diff --git a/dev/getting-started/index.html b/dev/getting-started/index.html
index 1d972cb..993e917 100644
--- a/dev/getting-started/index.html
+++ b/dev/getting-started/index.html
@@ -457,6 +457,7 @@
     });
 
 
+
 
GitHub
Getting started: a simple Mixture of Gaussians example
Suppose we have a mixture of Gaussians, e.g. something like
using Distributions
 target_distribution = MixtureModel(
     Normal,
diff --git a/dev/index.html b/dev/index.html
index eaf1610..8b6705a 100644
--- a/dev/index.html
+++ b/dev/index.html
@@ -457,5 +457,6 @@
     });
 
 
+
 
GitHub
MCMCTempering.jl
Tempering methods and more for Markov chain Monte Carlo methods.
MCMCTempering provides implementations of different ways to define tempered samplers and models, in addition to other ways of composing and mixing samplers.