From 65c2e54ab476e8115e58161029e02f7d28c17445 Mon Sep 17 00:00:00 2001
From: Gregory Ashton <gregory.ashton@ligo.org>
Date: Thu, 31 May 2018 12:20:09 +1000
Subject: [PATCH] Add priors documentation
---
docs/index.txt | 1 +
docs/likelihood.txt | 9 ++-------
docs/samplers.txt | 12 ++++++++----
3 files changed, 11 insertions(+), 11 deletions(-)
diff --git a/docs/index.txt b/docs/index.txt
index 561391e64..f3a6a9c3c 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 aeb9b1ce8..e74608675 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 595c47d15..ecb00f7f9 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
--
GitLab