Skip to content

Commit

Permalink
Updated method documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
JasperMartins committed Nov 13, 2024
1 parent bbd4a1c commit 0ccf0c9
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions bilby/core/prior/dict.py
Original file line number Diff line number Diff line change
Expand Up @@ -490,7 +490,7 @@ def normalize_constraint_factor(self, keys, nrepeats=10, sampling_chunk=10000, r
Parameters
==========
keys : list, tuple
keys: list, tuple
The set of keys in the prior dict to perform the integration for. Must contain all keys that the constraint
depends on. For joint priors, the full distribution is sampled. Joint prior keys not present in 'keys' are
marginalized.
Expand Down Expand Up @@ -521,11 +521,11 @@ def normalize_constraint_factor(self, keys, nrepeats=10, sampling_chunk=10000, r
Notes
=====
.. seealso::
Scipy's :scipy:stats:qmc:`Halton` class
Documentation of the quasi-random number generator :scipy:stats:qmc:`Halton` used for the quasi-monte
carlo integration of the normalization factor.
Scipy's :scipy:integrate:`qmc_quad` method
Documentation of the quasi-monte carlo integration scheme native to scipy.
:py:class:`scipy.stats.qmc.Halton`
Documentation of the quasi-random number generator used for the quasi-monte carlo-based method
to integrate the normalization factor.
:py:func:`scipy.integrate.qmc_quad`
Documentation of the scipy-native quasi-monte carlo integration scheme.
The implementation, particularly the error estimate, motivates this implementation.
(The error estimate was re-implemented to also apply for the 'from_samples' method.)
Expand Down

0 comments on commit 0ccf0c9

Please sign in to comment.