diff --git a/docs/source/api/gpMCMC.md b/docs/source/api/gpMCMC.md new file mode 100644 index 0000000..e7f4ab7 --- /dev/null +++ b/docs/source/api/gpMCMC.md @@ -0,0 +1,6 @@ +# gpMCMC + +```{eval-rst} +.. autoclass:: fvgp.gpMCMC + :members: + diff --git a/docs/source/index.md b/docs/source/index.md index 10630c7..7dbdc4b 100644 --- a/docs/source/index.md +++ b/docs/source/index.md @@ -13,6 +13,7 @@ caption: API api/overview.md api/GP.md api/fvGP.md +api/gpMCMC.md api/logging.md ``` diff --git a/fvgp/gpMCMC.py b/fvgp/gpMCMC.py index 2cc204f..ec5fba6 100644 --- a/fvgp/gpMCMC.py +++ b/fvgp/gpMCMC.py @@ -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. @@ -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`.