def test_flow(self):
log_pdf = pints.toy.GaussianLogPDF([5, 5], [[4, 1], [1, 3]])
x0 = np.array([2, 2])
# Test initial proposal is first point
mcmc = pints.NoUTurnMCMC(x0)
self.assertTrue(np.all(mcmc.ask() == mcmc._x0))
# Repeated asks
self.assertRaises(RuntimeError, mcmc.ask)
# Tell without ask
mcmc = pints.NoUTurnMCMC(x0)
self.assertRaises(RuntimeError, mcmc.tell, 0)
# Repeated tells should fail
x = mcmc.ask()
mcmc.tell(log_pdf.evaluateS1(x))
self.assertRaises(RuntimeError, mcmc.tell, log_pdf.evaluateS1(x))
# Cannot set delta while running
self.assertRaises(RuntimeError, mcmc.set_delta, 0.5)
# Cannot set number of adpation steps while running
self.assertRaises(RuntimeError, mcmc.set_number_adaption_steps, 500)
# Bad starting point
mcmc = pints.NoUTurnMCMC(x0)
mcmc.ask()
self.assertRaises(ValueError, mcmc.tell,
(float('-inf'), np.array([1, 1])))
def test_method_with_dense_mass(self):
# Create log pdf
log_pdf = pints.toy.GaussianLogPDF([5, 5], [[4, 1], [1, 3]])
# Create mcmc
x0 = np.array([2, 2])
sigma = [[3, 0], [0, 3]]
mcmc = pints.NoUTurnMCMC(x0, sigma)
mcmc.set_use_dense_mass_matrix(True)
# Perform short run
chain = []
for i in range(2 * mcmc.number_adaption_steps()):
x = mcmc.ask()
fx, gr = log_pdf.evaluateS1(x)
reply = mcmc.tell((fx, gr))
if reply is not None:
y, fy, ac = reply
chain.append(y)
recalc = log_pdf.evaluateS1(y)
self.assertEqual(fy[0], recalc[0])
self.assertTrue(np.all(fy[1] == recalc[1]))
chain = np.array(chain)
self.assertGreater(chain.shape[0], 1)
self.assertEqual(chain.shape[1], len(x0))
def test_method(self):
# Create log pdf
log_pdf = pints.toy.GaussianLogPDF([5, 5], [[4, 1], [1, 3]])
# Create mcmc
x0 = np.array([2, 2])
sigma = [[3, 0], [0, 3]]
mcmc = pints.NoUTurnMCMC(x0, sigma)
# This method needs sensitivities
self.assertTrue(mcmc.needs_sensitivities())
# Perform short run, test logging while we are at it
logger = pints.Logger()
logger.set_stream(None)
mcmc._log_init(logger)
chain = []
for i in range(2 * mcmc.number_adaption_steps()):
x = mcmc.ask()
fx, gr = log_pdf.evaluateS1(x)
reply = mcmc.tell((fx, gr))
mcmc._log_write(logger)
if reply is not None:
y, fy, ac = reply
chain.append(y)
recalc = log_pdf.evaluateS1(y)
self.assertEqual(fy[0], recalc[0])
self.assertTrue(np.all(fy[1] == recalc[1]))
chain = np.array(chain)
self.assertGreater(chain.shape[0], 1)
self.assertEqual(chain.shape[1], len(x0))
def test_method_near_boundary(self):
# Create log pdf
log_pdf = pints.UniformLogPrior([0, 0], [1, 1])
# Create mcmc
x0 = np.array([0.999, 0.999])
sigma = [[1, 0], [0, 1]]
mcmc = pints.NoUTurnMCMC(x0, sigma)
# Perform short run
chain = []
for i in range(2 * mcmc.number_adaption_steps()):
x = mcmc.ask()
fx, gr = log_pdf.evaluateS1(x)
reply = mcmc.tell((fx, gr))
if reply is not None:
y, fy, ac = reply
chain.append(y)
recalc = log_pdf.evaluateS1(y)
self.assertEqual(fy[0], recalc[0])
self.assertTrue(np.all(fy[1] == recalc[1]))
chain = np.array(chain)
self.assertGreater(chain.shape[0], 1)
self.assertEqual(chain.shape[1], len(x0))
self.assertGreater(mcmc.divergent_iterations().shape[0], 0)
def test_method_with_dense_mass(self):
# Create log pdf
log_pdf = pints.toy.GaussianLogPDF([5, 5], [[4, 1], [1, 3]])
# Create mcmc
x0 = np.array([2, 2])
sigma = [[3, 0], [0, 3]]
mcmc = pints.NoUTurnMCMC(x0, sigma)
mcmc.set_use_dense_mass_matrix(True)
# Perform short run
chain = []
for i in range(2 * mcmc.number_adaption_steps()):
x = mcmc.ask()
fx, gr = log_pdf.evaluateS1(x)
sample = mcmc.tell((fx, gr))
if sample is not None:
chain.append(sample)
if np.all(sample == x):
self.assertEqual(mcmc.current_log_pdf(), fx)
chain = np.array(chain)
self.assertGreater(chain.shape[0], 1)
self.assertEqual(chain.shape[1], len(x0))
def test_method_near_boundary(self):
# Create log pdf
log_pdf = pints.UniformLogPrior([0, 0], [1, 1])
# Create mcmc
x0 = np.array([0.999, 0.999])
sigma = [[1, 0], [0, 1]]
mcmc = pints.NoUTurnMCMC(x0, sigma)
# Perform short run
chain = []
for i in range(2 * mcmc.number_adaption_steps()):
x = mcmc.ask()
fx, gr = log_pdf.evaluateS1(x)
sample = mcmc.tell((fx, gr))
if sample is not None:
chain.append(sample)
if np.all(sample == x):
self.assertEqual(mcmc.current_log_pdf(), fx)
chain = np.array(chain)
self.assertGreater(chain.shape[0], 1)
self.assertEqual(chain.shape[1], len(x0))
self.assertGreater(mcmc.divergent_iterations().shape[0], 0)
def test_other_setters(self):
# Tests other setters and getters.
x0 = np.array([2, 2])
mcmc = pints.NoUTurnMCMC(x0)
self.assertRaises(ValueError, mcmc.set_hamiltonian_threshold, -0.3)
threshold1 = mcmc.hamiltonian_threshold()
self.assertEqual(threshold1, 10**3)
threshold2 = 10
mcmc.set_hamiltonian_threshold(threshold2)
self.assertEqual(mcmc.hamiltonian_threshold(), threshold2)
def test_set_hyper_parameters(self):
# Tests the parameter interface for this sampler.
x0 = np.array([2, 2])
mcmc = pints.NoUTurnMCMC(x0)
# Test delta parameter
delta = mcmc.delta()
self.assertIsInstance(delta, float)
mcmc.set_delta(0.5)
self.assertEqual(mcmc.delta(), 0.5)
# delta between 0 and 1
self.assertRaises(ValueError, mcmc.set_delta, -0.1)
self.assertRaises(ValueError, mcmc.set_delta, 1.1)
# Test number of adaption steps
n = mcmc.number_adaption_steps()
self.assertIsInstance(n, int)
mcmc.set_number_adaption_steps(100)
self.assertEqual(mcmc.number_adaption_steps(), 100)
# should convert to int
mcmc.set_number_adaption_steps(1.4)
self.assertEqual(mcmc.number_adaption_steps(), 1)
# number_adaption_steps is non-negative
self.assertRaises(ValueError, mcmc.set_number_adaption_steps, -100)
# test max tree depth
mcmc.set_max_tree_depth(20)
self.assertEqual(mcmc.max_tree_depth(), 20)
self.assertRaises(ValueError, mcmc.set_max_tree_depth, -1)
# test use_dense_mass_matrix
mcmc.set_use_dense_mass_matrix(True)
self.assertEqual(mcmc.use_dense_mass_matrix(), True)
# hyper param interface
self.assertEqual(mcmc.n_hyper_parameters(), 1)
mcmc.set_hyper_parameters([300])
self.assertEqual(mcmc.number_adaption_steps(), 300)
# Test when sampler is running
# (Need a MCMC proposal before adaptor is updated, which needs 10
# ask-tell cycles here.)
log_pdf = pints.toy.GaussianLogPDF([5, 5], [[4, 1], [1, 3]])
for _ in range(10):
x = mcmc.ask()
mcmc.tell(log_pdf.evaluateS1(x))
self.assertEqual(mcmc.delta(), 0.5)
self.assertEqual(mcmc.number_adaption_steps(), 300)
self.assertTrue(mcmc.use_dense_mass_matrix())
def test_set_hyper_parameters(self):
# Tests the parameter interface for this sampler.
x0 = np.array([2, 2])
mcmc = pints.NoUTurnMCMC(x0)
# Test delta parameter
delta = mcmc.delta()
self.assertIsInstance(delta, float)
mcmc.set_delta(0.5)
self.assertEqual(mcmc.delta(), 0.5)
# delta between 0 and 1
self.assertRaises(ValueError, mcmc.set_delta, -0.1)
self.assertRaises(ValueError, mcmc.set_delta, 1.1)
# Test number of adaption steps
n = mcmc.number_adaption_steps()
self.assertIsInstance(n, int)
mcmc.set_number_adaption_steps(100)
self.assertEqual(mcmc.number_adaption_steps(), 100)
# should convert to int
mcmc.set_number_adaption_steps(1.4)
self.assertEqual(mcmc.number_adaption_steps(), 1)
# number_adaption_steps is non-negative
self.assertRaises(ValueError, mcmc.set_number_adaption_steps, -100)
# test max tree depth
mcmc.set_max_tree_depth(20)
self.assertEqual(mcmc.max_tree_depth(), 20)
self.assertRaises(ValueError, mcmc.set_max_tree_depth, -1)
# test use_dense_mass_matrix
mcmc.set_use_dense_mass_matrix(True)
self.assertEqual(mcmc.use_dense_mass_matrix(), True)
# hyper param interface
self.assertEqual(mcmc.n_hyper_parameters(), 1)
mcmc.set_hyper_parameters([2])
self.assertEqual(mcmc.number_adaption_steps(), 2)
def test_pickle(self):
# Test I: make sure pickling state does not alter behaviour of sampler
log_pdf = pints.toy.GaussianLogPDF([5, 5], [[4, 1], [1, 3]])
x0 = np.array([2, 2])
# Run sampler until first mcmc step is proposed and accepted
mcmc = pints.NoUTurnMCMC(x0)
np.random.seed(1)
# Needs exactly 15 ask-tell cycles for this seed
for _ in range(15):
reply = log_pdf.evaluateS1(mcmc.ask())
mcmc.tell(reply)
np.random.seed(2)
for _ in range(1):
reply = log_pdf.evaluateS1(mcmc.ask())
ref_proposal1 = mcmc.tell(reply)
for _ in range(6):
reply = log_pdf.evaluateS1(mcmc.ask())
ref_proposal2 = mcmc.tell(reply)
# Repeat the same and pickle the sampler in between MCMC steps
mcmc = pints.NoUTurnMCMC(x0)
np.random.seed(1)
for _ in range(15):
reply = log_pdf.evaluateS1(mcmc.ask())
mcmc.tell(reply)
# Pickle state
mcmc.save_state('temp.pickle')
np.random.seed(2)
for _ in range(1):
reply = log_pdf.evaluateS1(mcmc.ask())
proposal1 = mcmc.tell(reply)
for _ in range(6):
reply = log_pdf.evaluateS1(mcmc.ask())
proposal2 = mcmc.tell(reply)
self.assertTrue(np.all(proposal1[0] == ref_proposal1[0]))
self.assertTrue(np.all(proposal2[0] == ref_proposal2[0]))
# Test II: Make sure that the adaptor from the pickled state
# is the same as the original sampler
mcmc = pints.NoUTurnMCMC(x0)
np.random.seed(1)
for _ in range(15):
reply = log_pdf.evaluateS1(mcmc.ask())
mcmc.tell(reply)
ref_adaptor = mcmc._adaptor
# Load sampler state
loaded_mcmc = mcmc.load_state('temp.pickle')
adaptor = loaded_mcmc._adaptor
self.assertTrue(
np.all(adaptor.final_epsilon() == ref_adaptor.final_epsilon()))
self.assertTrue(
np.all(adaptor.get_epsilon() == ref_adaptor.get_epsilon()))
self.assertTrue(
np.all(adaptor.get_inv_mass_matrix() ==
ref_adaptor.get_inv_mass_matrix()))
self.assertTrue(
np.all(adaptor.get_mass_matrix() == ref_adaptor.get_mass_matrix()))
self.assertEqual(adaptor.target_accept_prob(),
ref_adaptor.target_accept_prob())
self.assertEqual(adaptor.use_dense_mass_matrix(),
ref_adaptor.use_dense_mass_matrix())
self.assertEqual(adaptor.warmup_steps(), ref_adaptor.warmup_steps())
self.assertEqual(adaptor._counter, ref_adaptor._counter)
# Test case III: Check that the loaded sampler proposes the same steps
# as the original sampler when the random seed is controlled
# Make sure that numpy seed is the same
mcmc = pints.NoUTurnMCMC(x0)
np.random.seed(1)
for _ in range(14):
reply = log_pdf.evaluateS1(mcmc.ask())
mcmc.tell(reply)
np.random.uniform()
# Need one cycle of ask-tell to catch up with state prior to pickling
reply = log_pdf.evaluateS1(loaded_mcmc.ask())
loaded_mcmc.tell(reply)
# Propose next steps with loaded sampler
np.random.seed(2)
for _ in range(1):
reply = log_pdf.evaluateS1(loaded_mcmc.ask())
proposal1 = loaded_mcmc.tell(reply)
for _ in range(6):
reply = log_pdf.evaluateS1(loaded_mcmc.ask())
proposal2 = loaded_mcmc.tell(reply)
self.assertTrue(np.all(proposal1[0] == ref_proposal1[0]))
self.assertTrue(np.all(proposal2[0] == ref_proposal2[0]))
# Delete pickled sampler
os.remove('temp.pickle')
