Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
bilby
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Iterations
Requirements
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Test cases
Artifacts
Deploy
Releases
Container Registry
Model registry
Operate
Environments
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Issue analytics
Insights
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
lscsoft
bilby
Commits
2b45350c
There was a problem fetching the pipeline summary.
Commit
2b45350c
authored
6 years ago
by
Gregory Ashton
Browse files
Options
Downloads
Patches
Plain Diff
Update documentation for priors
parent
d08e0572
No related branches found
No related tags found
1 merge request
!56
General fix up of priors
Pipeline
#
Changes
1
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
docs/prior.txt
+27
-4
27 additions, 4 deletions
docs/prior.txt
with
27 additions
and
4 deletions
docs/prior.txt
+
27
−
4
View file @
2b45350c
...
...
@@ -4,8 +4,13 @@
Priors
======
The priors object passed to :ref:`run_sampler <run-sampler>` is just a regular
`python dictionary <https://docs.python.org/2/tutorial/datastructures.html#dictionaries>`_.
Defining priors
---------------
Priors refer to the prior probability distributions for each model parameter.
Typically, these are passed into :ref:`run_sampler <run_sampler>` as a regular
`python dictionary
<https://docs.python.org/2/tutorial/datastructures.html#dictionaries>`_.
The keys of the priors objects should reference the model parameters (in
particular, the :code:`parameters` attribute of the :ref:`likelihood`. Each key
...
...
@@ -26,9 +31,27 @@ simple example that sets a uniform prior for :code:`a`, and a fixed value for
Notice, that the :code:`latex_label` is optional, but if given will be used
when generating plots.
We have provided a number of standard priors. Here is a complete list
Default priors
--------------
If any model parameter required by the :ref:`likelihood` are not defined in the
`priors` dictionary passed to :ref:`run_sampler <run_sampler>` then the code
will try to use a default prior. By default, these are setup for a binary black
hole and defined in a file like this
.. literalinclude:: /../tupak/core/prior_files/binary_black_holes.prior
You can define your own default prior and pass a string pointing to that file
to :ref:`run_sampler <run_sampler>`.
Complete list of available prior classes
----------------------------------------
We have provided a number of standard priors. You can define your own by
subclassing the :code:`tupak.prior.Prior` class. Here is the complete list of
those implemented:
.. automodule:: tupak.prior
.. automodule:: tupak.
core.
prior
:members:
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment