UltraNest
4.4.0
Contents:
UltraNest
Installation
Method
Basic usage
Specifying priors
Features
API
Frequently Asked Questions
Contributing
Release Notes
Tutorials:
Time series fitting
Model comparison
Higher-dimensional fitting
Tutorial: intrinsic distribution
Tutorial: fitting a line
Tutorial: distribution with outliers
Bayesian workflow
Warm starting
Debugging techniques
UltraNest
Index
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
|
W
|
Z
A
accumulate_statistics() (ultranest.pathsampler.OtherSamplerProxy method)
adapt_nsteps() (ultranest.stepsampler.StepSampler method)
adapt_proposal_move_distances() (in module ultranest.stepsampler)
adapt_proposal_move_distances_midway() (in module ultranest.stepsampler)
adapt_proposal_summed_distances() (in module ultranest.stepsampler)
adapt_proposal_summed_distances_NN() (in module ultranest.stepsampler)
adapt_proposal_total_distances() (in module ultranest.stepsampler)
adapt_proposal_total_distances_NN() (in module ultranest.stepsampler)
add() (ultranest.netiter.PointPile method)
(ultranest.ordertest.UniformOrderAccumulator method)
(ultranest.plot.PredictionBand method)
(ultranest.samplingpath.ContourSamplingPath method)
(ultranest.samplingpath.SamplingPath method)
(ultranest.store.HDF5PointStore method)
(ultranest.store.NullPointStore method)
(ultranest.store.TextPointStore method)
adjust_accept() (ultranest.pathsampler.SamplingPathSliceSampler method)
(ultranest.pathsampler.SamplingPathStepSampler method)
(ultranest.stepsampler.SliceSampler method)
(ultranest.stepsampler.StepSampler method)
adjust_nsteps() (ultranest.dychmc.DynamicCHMCSampler method)
adjust_outside_region() (ultranest.pathsampler.SamplingPathSliceSampler method)
(ultranest.pathsampler.SamplingPathStepSampler method)
(ultranest.stepsampler.SliceSampler method)
(ultranest.stepsampler.StepSampler method)
adjust_scale() (ultranest.pathsampler.OtherSamplerProxy method)
(ultranest.pathsampler.SamplingPathStepSampler method)
adjust_stepsize() (ultranest.dychmc.DynamicCHMCSampler method)
(ultranest.dyhmc.DynamicHMCSampler method)
advance() (ultranest.popstepsampler.PopulationSliceSampler method)
AffineLayer (class in ultranest.mlfriends)
angle() (in module ultranest.samplingpath)
B
BallSliceSampler() (in module ultranest.stepsampler)
bisect_at() (ultranest.flatnuts.ClockedBisectSampler method)
bounding_ellipsoid() (in module ultranest.mlfriends)
box_line_intersection() (in module ultranest.samplingpath)
BreadthFirstIterator (class in ultranest.netiter)
build_tree() (in module ultranest.dychmc)
(in module ultranest.dyhmc)
(ultranest.flatnuts.ClockedNUTSSampler method)
C
check_gaps() (ultranest.flatnuts.DirectJumper method)
(ultranest.flatnuts.SingleJumper method)
ClockedBisectSampler (class in ultranest.flatnuts)
ClockedNUTSSampler (class in ultranest.flatnuts)
ClockedSimpleStepSampler (class in ultranest.flatnuts)
ClockedStepSampler (class in ultranest.flatnuts)
close() (ultranest.store.FilePointStore method)
(ultranest.store.NullPointStore method)
combine_results() (in module ultranest.netiter)
compute_enlargement() (ultranest.mlfriends.MLFriends method)
(ultranest.mlfriends.RobustEllipsoidRegion method)
(ultranest.mlfriends.SimpleRegion method)
(ultranest.mlfriends.WrappingEllipsoid method)
compute_maxradiussq() (ultranest.mlfriends.MLFriends method)
compute_mean_pair_distance() (in module ultranest.mlfriends)
(ultranest.mlfriends.MLFriends method)
compute_quantile_intervals() (in module ultranest.hotstart)
compute_quantile_intervals_refined() (in module ultranest.hotstart)
continue_sampling() (ultranest.flatnuts.ClockedBisectSampler method)
(ultranest.flatnuts.ClockedStepSampler method)
ContourSamplingPath (class in ultranest.samplingpath)
cornerplot() (in module ultranest.plot)
count_tree() (in module ultranest.netiter)
count_tree_between() (in module ultranest.netiter)
create_ellipsoid() (ultranest.mlfriends.MLFriends method)
(ultranest.mlfriends.SimpleRegion method)
(ultranest.mlfriends.WrappingEllipsoid method)
create_logger() (in module ultranest.utils)
create_new() (ultranest.mlfriends.AffineLayer method)
(ultranest.mlfriends.LocalAffineLayer method)
(ultranest.mlfriends.MaxPrincipleGapAffineLayer method)
(ultranest.mlfriends.ScalingLayer method)
create_problem() (ultranest.dychmc.DynamicCHMCSampler method)
(ultranest.dyhmc.DynamicHMCSampler method)
crop_bracket_at_unit_cube() (in module ultranest.stepsampler)
CubeMHSampler() (in module ultranest.stepsampler)
CubeSliceSampler() (in module ultranest.stepsampler)
D
DirectJumper (class in ultranest.flatnuts)
distances() (in module ultranest.samplingpath)
distributed_work_chunk_size() (in module ultranest.utils)
drop_next_node() (ultranest.netiter.BreadthFirstIterator method)
dump_tree() (in module ultranest.netiter)
DynamicCHMCSampler (class in ultranest.dychmc)
DynamicHMCSampler (class in ultranest.dyhmc)
E
ellipsoid_bracket() (in module ultranest.stepsampler)
estimate_volume() (ultranest.mlfriends.MLFriends method)
(ultranest.mlfriends.RobustEllipsoidRegion method)
eval_at() (ultranest.flatnuts.ClockedStepSampler method)
evolve() (in module ultranest.stepfuncs)
evolve_prepare() (in module ultranest.stepfuncs)
evolve_update() (in module ultranest.stepfuncs)
expand_children_of() (ultranest.netiter.BreadthFirstIterator method)
expand_onestep() (ultranest.flatnuts.ClockedSimpleStepSampler method)
expand_to() (ultranest.flatnuts.ClockedBisectSampler method)
(ultranest.flatnuts.ClockedStepSampler method)
expand_to_step() (ultranest.flatnuts.ClockedSimpleStepSampler method)
extrapolate() (ultranest.samplingpath.ContourSamplingPath method)
(ultranest.samplingpath.SamplingPath method)
extrapolate_ahead() (in module ultranest.samplingpath)
F
far_enough_fraction (ultranest.stepsampler.StepSampler property)
FilePointStore (class in ultranest.store)
FILES_OPENED (ultranest.store.HDF5PointStore attribute)
finalize_chain() (ultranest.stepsampler.StepSampler method)
find_beta_params_dynamic() (in module ultranest.dyhmc)
find_beta_params_static() (in module ultranest.dyhmc)
find_nearby() (in module ultranest.mlfriends)
find_nodes_before() (in module ultranest.netiter)
FlattenedProblem (class in ultranest.dyhmc)
flush() (ultranest.store.FilePointStore method)
(ultranest.store.NullPointStore method)
G
generate_cube_oriented_differential_direction() (in module ultranest.stepsampler)
generate_cube_oriented_direction() (in module ultranest.popstepsampler)
(in module ultranest.stepfuncs)
(in module ultranest.stepsampler)
generate_cube_oriented_direction_scaled() (in module ultranest.popstepsampler)
(in module ultranest.stepfuncs)
generate_differential_direction() (in module ultranest.stepfuncs)
(in module ultranest.stepsampler)
generate_direction() (ultranest.pathsampler.SamplingPathSliceSampler method)
(ultranest.pathsampler.SamplingPathStepSampler method)
generate_mixture_random_direction() (in module ultranest.stepfuncs)
(in module ultranest.stepsampler)
generate_momentum() (in module ultranest.dyhmc)
(ultranest.dyhmc.FlattenedProblem method)
generate_momentum_circle() (in module ultranest.dyhmc)
generate_momentum_flattened() (in module ultranest.dyhmc)
generate_momentum_normal() (in module ultranest.dyhmc)
generate_partial_differential_direction() (in module ultranest.stepsampler)
generate_random_direction() (in module ultranest.popstepsampler)
(in module ultranest.stepfuncs)
(in module ultranest.stepsampler)
generate_region_oriented_direction() (in module ultranest.popstepsampler)
(in module ultranest.stepfuncs)
(in module ultranest.stepsampler)
generate_region_random_direction() (in module ultranest.popstepsampler)
(in module ultranest.stepfuncs)
(in module ultranest.stepsampler)
generate_region_sample_direction() (in module ultranest.stepsampler)
generate_uniform_direction() (in module ultranest.dychmc)
get_auxiliary_contbox_parameterization() (in module ultranest.hotstart)
get_auxiliary_problem() (in module ultranest.hotstart)
get_default_viz_callback() (in module ultranest.viz)
get_extended_auxiliary_independent_problem() (in module ultranest.hotstart)
get_extended_auxiliary_problem() (in module ultranest.hotstart)
get_independent_sample() (ultranest.flatnuts.ClockedSimpleStepSampler method)
get_info_dict() (ultranest.stepsampler.StepSampler method)
get_line() (ultranest.plot.PredictionBand method)
get_point() (ultranest.pathsampler.SamplingPathStepSampler method)
get_sphere_tangent() (in module ultranest.samplingpath)
get_sphere_tangents() (in module ultranest.samplingpath)
getp() (ultranest.netiter.PointPile method)
getu() (ultranest.netiter.PointPile method)
gradient() (ultranest.samplingpath.ContourSamplingPath method)
H
HDF5PointStore (class in ultranest.store)
I
infinite_U_zscore() (in module ultranest.ordertest)
initialize() (ultranest.viz.LivePointsWidget method)
insertion_order_converged (ultranest.netiter.MultiCounter property)
insertion_order_runlength (ultranest.netiter.MultiCounter property)
inside() (ultranest.mlfriends.MLFriends method)
(ultranest.mlfriends.RobustEllipsoidRegion method)
(ultranest.mlfriends.WrappingEllipsoid method)
inside_ellipsoid() (ultranest.mlfriends.MLFriends method)
inside_region() (in module ultranest.stepsampler)
interpolate() (in module ultranest.samplingpath)
(ultranest.samplingpath.ContourSamplingPath method)
(ultranest.samplingpath.SamplingPath method)
IntervalJumper (class in ultranest.flatnuts)
is_affine_transform() (in module ultranest.utils)
is_done() (ultranest.flatnuts.ClockedSimpleStepSampler method)
IslandPopulationRandomLivepointSelector (class in ultranest.stepsampler)
isnotebook() (in module ultranest.viz)
isunitlength() (in module ultranest.samplingpath)
L
leapfrog() (in module ultranest.dyhmc)
line() (ultranest.plot.PredictionBand method)
linear_steps_with_reflection() (in module ultranest.samplingpath)
listify() (in module ultranest.utils)
LivePointsWidget (class in ultranest.viz)
LocalAffineLayer (class in ultranest.mlfriends)
logZ_bs (ultranest.netiter.MultiCounter property)
logz_sequence() (in module ultranest.netiter)
logZerr_bs (ultranest.netiter.MultiCounter property)
logZremain (ultranest.netiter.SingleCounter property)
M
make_eigvals_positive() (in module ultranest.mlfriends)
make_jump() (ultranest.flatnuts.DirectJumper method)
(ultranest.flatnuts.IntervalJumper method)
(ultranest.flatnuts.SingleJumper method)
make_node() (ultranest.netiter.PointPile method)
make_run_dir() (in module ultranest.utils)
MaxPrincipleGapAffineLayer (class in ultranest.mlfriends)
mean_jump_distance (ultranest.stepsampler.StepSampler property)
MHSampler (class in ultranest.stepsampler)
MLFriends (class in ultranest.mlfriends)
modify_Lgrad() (ultranest.dyhmc.FlattenedProblem method)
module
ultranest
ultranest.calibrator
ultranest.dychmc
ultranest.dyhmc
ultranest.flatnuts
ultranest.hotstart
ultranest.integrator
ultranest.mlfriends
ultranest.netiter
ultranest.ordertest
ultranest.pathsampler
ultranest.plot
ultranest.popstepsampler
ultranest.samplingpath
ultranest.solvecompat
ultranest.stepfuncs
ultranest.stepsampler
ultranest.store
ultranest.utils
ultranest.viz
move() (ultranest.dychmc.DynamicCHMCSampler method)
(ultranest.dyhmc.DynamicHMCSampler method)
(ultranest.pathsampler.SamplingPathSliceSampler method)
(ultranest.pathsampler.SamplingPathStepSampler method)
(ultranest.stepsampler.MHSampler method)
(ultranest.stepsampler.SliceSampler method)
(ultranest.stepsampler.StepSampler method)
movei() (ultranest.pathsampler.SamplingPathStepSampler method)
MultiCounter (class in ultranest.netiter)
N
nearest_box_intersection_line() (in module ultranest.samplingpath)
NestedSampler (class in ultranest.integrator)
new_chain() (ultranest.stepsampler.SliceSampler method)
(ultranest.stepsampler.StepSampler method)
next() (ultranest.flatnuts.ClockedBisectSampler method)
(ultranest.flatnuts.ClockedNUTSSampler method)
(ultranest.flatnuts.ClockedStepSampler method)
next_node() (ultranest.netiter.BreadthFirstIterator method)
nicelogger() (in module ultranest.viz)
normalised_kendall_tau_distance() (in module ultranest.utils)
NullPointStore (class in ultranest.store)
O
optimize() (ultranest.mlfriends.AffineLayer method)
(ultranest.mlfriends.ScalingLayer method)
optimize_wrap() (ultranest.mlfriends.ScalingLayer method)
OrthogonalDirectionGenerator (class in ultranest.stepsampler)
OtherSamplerProxy (class in ultranest.pathsampler)
P
passing_node() (ultranest.netiter.MultiCounter method)
(ultranest.netiter.SingleCounter method)
plot() (ultranest.calibrator.ReactiveNestedCalibrator method)
(ultranest.dychmc.DynamicCHMCSampler method)
(ultranest.dyhmc.DynamicHMCSampler method)
(ultranest.integrator.NestedSampler method)
(ultranest.integrator.ReactiveNestedSampler method)
(ultranest.pathsampler.OtherSamplerProxy method)
(ultranest.samplingpath.SamplingPath method)
(ultranest.stepsampler.StepSampler method)
plot_corner() (ultranest.integrator.ReactiveNestedSampler method)
plot_jump_diagnostic_histogram() (ultranest.stepsampler.StepSampler method)
plot_run() (ultranest.integrator.ReactiveNestedSampler method)
plot_trace() (ultranest.integrator.ReactiveNestedSampler method)
PointPile (class in ultranest.netiter)
pop() (ultranest.store.FilePointStore method)
(ultranest.store.NullPointStore method)
PopulationRandomWalkSampler (class in ultranest.popstepsampler)
PopulationSimpleSliceSampler (class in ultranest.popstepsampler)
PopulationSliceSampler (class in ultranest.popstepsampler)
PredictionBand (class in ultranest.plot)
prepare_jump() (ultranest.flatnuts.DirectJumper method)
(ultranest.flatnuts.IntervalJumper method)
(ultranest.flatnuts.SingleJumper method)
print_diagnostic() (ultranest.stepsampler.StepSampler method)
print_results() (ultranest.integrator.NestedSampler method)
(ultranest.integrator.ReactiveNestedSampler method)
print_tree() (in module ultranest.netiter)
pymultinest_solve_compat() (in module ultranest.solvecompat)
Q
quantile() (in module ultranest.utils)
R
ReactiveNestedCalibrator (class in ultranest.calibrator)
ReactiveNestedSampler (class in ultranest.integrator)
read_file() (in module ultranest.integrator)
reflect() (in module ultranest.samplingpath)
(ultranest.pathsampler.SamplingPathStepSampler method)
reflect_at() (ultranest.flatnuts.ClockedStepSampler method)
region_changed() (ultranest.dychmc.DynamicCHMCSampler method)
(ultranest.dyhmc.DynamicHMCSampler method)
(ultranest.popstepsampler.PopulationRandomWalkSampler method)
(ultranest.popstepsampler.PopulationSimpleSliceSampler method)
(ultranest.popstepsampler.PopulationSliceSampler method)
(ultranest.stepsampler.StepSampler method)
RegionBallSliceSampler() (in module ultranest.stepsampler)
RegionMHSampler() (in module ultranest.stepsampler)
RegionSequentialSliceSampler() (in module ultranest.stepsampler)
RegionSliceSampler() (in module ultranest.stepsampler)
resample_equal() (in module ultranest.utils)
reset() (ultranest.flatnuts.ClockedNUTSSampler method)
(ultranest.flatnuts.ClockedSimpleStepSampler method)
(ultranest.netiter.BreadthFirstIterator method)
(ultranest.netiter.MultiCounter method)
(ultranest.netiter.SingleCounter method)
(ultranest.ordertest.UniformOrderAccumulator method)
(ultranest.samplingpath.SamplingPath method)
(ultranest.store.FilePointStore method)
(ultranest.store.NullPointStore method)
reuse_samples() (in module ultranest.hotstart)
reverse() (ultranest.flatnuts.ClockedSimpleStepSampler method)
RobustEllipsoidRegion (class in ultranest.mlfriends)
round_parameterlimits() (in module ultranest.viz)
run() (ultranest.calibrator.ReactiveNestedCalibrator method)
(ultranest.integrator.NestedSampler method)
(ultranest.integrator.ReactiveNestedSampler method)
run_iter() (ultranest.integrator.ReactiveNestedSampler method)
runplot() (in module ultranest.plot)
S
sample() (ultranest.mlfriends.MLFriends method)
(ultranest.mlfriends.RobustEllipsoidRegion method)
sample_chain_point() (ultranest.flatnuts.ClockedNUTSSampler method)
sample_from_boundingbox() (ultranest.mlfriends.MLFriends method)
(ultranest.mlfriends.RobustEllipsoidRegion method)
sample_from_points() (ultranest.mlfriends.MLFriends method)
sample_from_transformed_boundingbox() (ultranest.mlfriends.MLFriends method)
(ultranest.mlfriends.RobustEllipsoidRegion method)
sample_from_wrapping_ellipsoid() (ultranest.mlfriends.MLFriends method)
(ultranest.mlfriends.RobustEllipsoidRegion method)
SamplingPath (class in ultranest.samplingpath)
SamplingPathSliceSampler (class in ultranest.pathsampler)
SamplingPathStepSampler (class in ultranest.pathsampler)
ScalingLayer (class in ultranest.mlfriends)
select_random_livepoint() (in module ultranest.stepsampler)
SequentialDirectionGenerator (class in ultranest.stepsampler)
SequentialRegionDirectionGenerator (class in ultranest.stepsampler)
set_clusterids() (ultranest.mlfriends.ScalingLayer method)
set_gradient() (ultranest.dychmc.DynamicCHMCSampler method)
(ultranest.pathsampler.SamplingPathStepSampler method)
set_lineargs() (ultranest.plot.PredictionBand method)
set_nsteps() (ultranest.flatnuts.ClockedSimpleStepSampler method)
set_shadeargs() (ultranest.plot.PredictionBand method)
set_transformLayer() (ultranest.mlfriends.MLFriends method)
setup_brackets() (ultranest.popstepsampler.PopulationSliceSampler method)
setup_start() (ultranest.popstepsampler.PopulationSliceSampler method)
shade() (ultranest.plot.PredictionBand method)
shift() (ultranest.popstepsampler.PopulationSliceSampler method)
SimpleRegion (class in ultranest.mlfriends)
SingleCounter (class in ultranest.netiter)
SingleJumper (class in ultranest.flatnuts)
SliceSampler (class in ultranest.stepsampler)
SpeedVariableGenerator (class in ultranest.stepsampler)
SpeedVariableRegionSliceSampler() (in module ultranest.stepsampler)
start() (ultranest.pathsampler.SamplingPathStepSampler method)
start_direction() (ultranest.pathsampler.OtherSamplerProxy method)
start_path() (ultranest.pathsampler.SamplingPathStepSampler method)
startup() (ultranest.pathsampler.OtherSamplerProxy method)
status (ultranest.popstepsampler.PopulationSliceSampler property)
step_back() (in module ultranest.stepfuncs)
step_or_reflect() (in module ultranest.dychmc)
StepSampler (class in ultranest.stepsampler)
stop_criterion() (in module ultranest.dychmc)
(in module ultranest.dyhmc)
store_tree() (ultranest.integrator.ReactiveNestedSampler method)
submasks() (in module ultranest.utils)
subtract_nearby() (in module ultranest.mlfriends)
T
terminate_path() (ultranest.pathsampler.SamplingPathStepSampler method)
TextPointStore (class in ultranest.store)
traceplot() (in module ultranest.plot)
transform() (ultranest.mlfriends.AffineLayer method)
(ultranest.mlfriends.ScalingLayer method)
tree_sample() (in module ultranest.dychmc)
(in module ultranest.dyhmc)
TreeNode (class in ultranest.netiter)
U
ultranest
module
ultranest.calibrator
module
ultranest.dychmc
module
ultranest.dyhmc
module
ultranest.flatnuts
module
ultranest.hotstart
module
ultranest.integrator
module
ultranest.mlfriends
module
ultranest.netiter
module
ultranest.ordertest
module
ultranest.pathsampler
module
ultranest.plot
module
ultranest.popstepsampler
module
ultranest.samplingpath
module
ultranest.solvecompat
module
ultranest.stepfuncs
module
ultranest.stepsampler
module
ultranest.store
module
ultranest.utils
module
ultranest.viz
module
UniformOrderAccumulator (class in ultranest.ordertest)
untransform() (ultranest.mlfriends.AffineLayer method)
(ultranest.mlfriends.ScalingLayer method)
unwrap() (ultranest.mlfriends.ScalingLayer method)
update_center() (ultranest.mlfriends.WrappingEllipsoid method)
update_clusters() (in module ultranest.mlfriends)
update_vectorised_slice_sampler() (in module ultranest.stepfuncs)
V
vectorize() (in module ultranest.utils)
verify_gradient() (in module ultranest.utils)
vol_prefactor() (in module ultranest.mlfriends)
(in module ultranest.utils)
W
warmstart_from_similar_file() (in module ultranest.integrator)
within_unit_cube() (in module ultranest.stepfuncs)
wrap() (ultranest.mlfriends.ScalingLayer method)
WrappingEllipsoid (class in ultranest.mlfriends)
Z
zscore (ultranest.ordertest.UniformOrderAccumulator property)