diff --git a/docs/index.txt b/docs/index.txt index 561391e6480a2767c963b69b1e3d952b4cde4a62..f3a6a9c3cbd6a88095b0abf289109d7cccaf17b7 100644 --- a/docs/index.txt +++ b/docs/index.txt @@ -11,6 +11,7 @@ Welcome to tupak's documentation! basics-of-parameter-estimation compact-binary-coalescence-parameter-estimation tupak-output + prior likelihood samplers writing-documentation diff --git a/docs/likelihood.txt b/docs/likelihood.txt index aeb9b1ce8e851acbbc8e871502c1ecbd1fed17f2..e746086759ba84be78ec711c187abcbd322a9f01 100644 --- a/docs/likelihood.txt +++ b/docs/likelihood.txt @@ -1,3 +1,5 @@ +.. _likelihood: + ========== Likelihood ========== @@ -12,19 +14,12 @@ a `log_likelihood()` method. The default likelihood we use in the examples is `GravitationalWaveTransient`: .. autoclass:: tupak.likelihood.GravitationalWaveTransient - :members: We also provide a simpler likelihood .. autoclass:: tupak.likelihood.BasicGravitationalWaveTransient - :members: We provide an empty parent class which can be subclassed for alternative use cases .. autoclass:: tupak.likelihood.Likelihood - :members: - - - - diff --git a/docs/samplers.txt b/docs/samplers.txt index 595c47d1599f57c496ede801c9c5233298351cc6..ecb00f7f94eb31aa37197559115fb0882129c0c2 100644 --- a/docs/samplers.txt +++ b/docs/samplers.txt @@ -1,7 +1,11 @@ -========== -Samplers -========== +.. run_sampler: -Given a `likelihood` and `prior`, we can run parameter estimation using `run_sampler` +======== +Sampling +======== + +Given a :ref:`likelihood` and :ref:`priors`, we can run parameter estimation using the +`run_sampler` function. This can be accessed via :code:`tupak.run_sampler` or +:code:`tupak.sampler.run_sampler`. Here is the detailed API: .. autofunction:: tupak.sampler.run_sampler