IMP logo
IMP Reference Guide  develop.08ecd6469d,2026/04/02
The Integrative Modeling Platform
IMP.pmi.samplers.MonteCarlo Class Reference

Sample using Monte Carlo. More...

Inherits _SamplerBase.

Detailed Description

Sample using Monte Carlo.

Note
This class is only available in Python.

Definition at line 70 of file samplers.py.

Public Member Functions

def __init__
 Setup Monte Carlo sampling. More...
 
def get_nuisance_movers_parameters
 Return a dictionary with the mover parameters for nuisance parameters. More...
 

Constructor & Destructor Documentation

def IMP.pmi.samplers.MonteCarlo.__init__ (   self,
  model,
  objects = None,
  temp = 1.0,
  filterbyname = None,
  score_moved = False,
  use_jax = False 
)

Setup Monte Carlo sampling.

Parameters
modelThe IMP Model
objectsWhat to sample (a list of Movers)
tempThe MC temperature
filterbynameNot used
score_movedIf True, attempt to speed up sampling by caching scoring function terms on particles that didn't move
use_jaxIf set to True, sample the scoring function using JAX instead of IMP's internal C++ implementation (requires that all PMI restraints used have a JAX implementation).

Definition at line 81 of file samplers.py.

Member Function Documentation

def IMP.pmi.samplers.MonteCarlo.get_nuisance_movers_parameters (   self)

Return a dictionary with the mover parameters for nuisance parameters.

Definition at line 142 of file samplers.py.


The documentation for this class was generated from the following file: