quantax.sampler.Metropolis#

class quantax.sampler.Metropolis#

Bases: Sampler

Abstract class for metropolis samplers. The samples are equally distributed on different machines.

__init__(state: State, nsamples: int, reweight: float = 2.0, thermal_steps: int | None = None, sweep_steps: int | None = None, initial_spins: Array | None = None)#
Parameters:

  • state – The state used for computing the wave function and probability.

  • nsamples – Number of samples generated per iteration. It should be a multiple of the total number of machines to allow samples to be equally distributed on different machines.

  • reweight – The reweight factor n defining the sample probability \(|\psi|^n\), default to 2.0.

  • thermal_steps – The number of thermalization steps in the beginning of each Markov chain, default to be 20 * fock state length.

  • sweep_steps – The number of steps for generating new samples, default to be 2 * fock state length.

  • initial_spins – The initial spins for every Markov chain before the thermalization steps, default to be random spins.

property is_balanced: bool#

Whether the sampler has balanced proposal rate \(P(s'|s) = P(s|s')\), default to True

property nflips: int | None#

The number of flips in new proposal.

reset() → None#

Reset all Markov chains to initial_spins and thermalize them

sweep(nsweeps: int | None = None) → Samples#

Generate new samples

Parameters:

nsweeps – Number of sweeps for generating the new samples, default to be self._sweep_steps

property nsamples: int#

Number of samples generated per iteration

property reweight: float#

The reweight factor n defining the sample probability \(|\psi|^n\)

property state: State#

The state used for computing the wave function and probability