Skip to content

Commit

Permalink
mcmc in api docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Marcus Noack authored and Marcus Noack committed Jun 17, 2024
1 parent d6a1055 commit ef26827
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 2 deletions.
6 changes: 6 additions & 0 deletions docs/source/api/gpMCMC.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# gpMCMC

```{eval-rst}
.. autoclass:: fvgp.gpMCMC
:members:
1 change: 1 addition & 0 deletions docs/source/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ caption: API
api/overview.md
api/GP.md
api/fvGP.md
api/gpMCMC.md
api/logging.md
```

Expand Down
6 changes: 4 additions & 2 deletions fvgp/gpMCMC.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@ class gpMCMC:
Parameters
----------
log_likelihood_function : Callable
The log of the likelihood to be sampled. Function of the form def likelihood(x,args) that return a scalar.
log_likelihood_function : callable
The log of the likelihood to be sampled. Function of the form def likelihood(x,args) that returns a scalar.
prior_function : callable
Function to query for the prior probability of form: func(x, obj), where
x is the current vector and obj is this gpMCMC object instance.
Expand Down Expand Up @@ -250,6 +250,8 @@ def __init__(self,
but update the `ProposalDistribution.prop_args` attribute. Note, any
adapt function will have to be well thought through.
Most adapt functions will not lead to a stationary final distributions. Use with caution.
auto_accept : bool, optional
Indicates whether to auto-accept the jump.
prop_args : Any, optional
Arguments that will be available as obj attribute in `proposal_dist`and `adapt_callable`.
Expand Down

0 comments on commit ef26827

Please sign in to comment.