From 9ad9e80183444cb311cb4abdf6d5deb409ef2ff0 Mon Sep 17 00:00:00 2001
From: Gregory Ashton <gregory.ashton@ligo.org>
Date: Fri, 25 May 2018 14:26:51 +1000
Subject: [PATCH] Minor updates to the docs
---
docs/index.txt | 1 +
docs/likelihood.txt | 24 +++++++++++++++++++++++-
2 files changed, 24 insertions(+), 1 deletion(-)
diff --git a/docs/index.txt b/docs/index.txt
index ca73c9c9e..277dc890b 100644
--- a/docs/index.txt
+++ b/docs/index.txt
@@ -9,6 +9,7 @@ Welcome to tupak's documentation!
:caption: Contents:
likelihood
+ samplers
Indices and tables
diff --git a/docs/likelihood.txt b/docs/likelihood.txt
index 3caa397e4..aeb9b1ce8 100644
--- a/docs/likelihood.txt
+++ b/docs/likelihood.txt
@@ -2,7 +2,29 @@
Likelihood
==========
-.. automodule:: tupak.likelihood
+`tupak` likelihood objects are used in calculating the likelihood of the data
+for some specific set of parameters. In mathematical notation, the likelihood
+can be generically written as :math:`\mathcal{L}(d| \theta)`. How this is
+coded up will depend on the problem, but `tupak` expects all likelihood
+objects to have a `parameters` attribute (a dictionary of key-value pairs) and
+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:
+
+
+
--
GitLab