Commit 9ad9e801 authored by Gregory Ashton's avatar Gregory Ashton
Browse files

Minor updates to the docs

parent 5ce3f353
Pipeline #20304 passed with stages
in 11 minutes and 27 seconds
......@@ -9,6 +9,7 @@ Welcome to tupak's documentation!
:caption: Contents:
Indices and tables
......@@ -2,7 +2,29 @@
.. 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
We also provide a simpler likelihood
.. autoclass:: tupak.likelihood.BasicGravitationalWaveTransient
We provide an empty parent class which can be subclassed for alternative use
.. autoclass:: tupak.likelihood.Likelihood
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment