Skip to content

Commit

Permalink
fix in docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
MarcusMNoack committed Dec 15, 2023
1 parent 5e2197c commit 4c414a1
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 15 deletions.
28 changes: 14 additions & 14 deletions fvgp/gp.py
Original file line number Diff line number Diff line change
Expand Up @@ -824,8 +824,8 @@ def set_hyperparameters(self, hps):
"""
Function to set hyperparameters.
Parameters:
-----------
Parameters
----------
hps : np.ndarray
A 1-d numpy array of hyperparameters.
"""
Expand All @@ -838,11 +838,11 @@ def get_hyperparameters(self):
"""
Function to get the current hyperparameters.
Parameters: None
-----------
Parameters
----------
Return:
-------
Return
------
hyperparameters : np.ndarray
"""

Expand All @@ -853,12 +853,12 @@ def get_prior_pdf(self):
"""
Function to get the current prior covariance matrix.
Parameters:
-----------
Parameters
----------
None
Return:
-------
Return
------
A dictionary containing information about the GP prior distribution : dict
"""

Expand Down Expand Up @@ -1743,13 +1743,13 @@ def entropy(self, S):
Function computing the entropy of a normal distribution
res = entropy(S); S is a 2d np.ndarray array, a covariance matrix which is non-singular.
Parameters:
-----------
Parameters
----------
S : np.ndarray
A covariance matrix.
Return:
-------
Return
------
Entropy : float
"""
dim = len(S[0])
Expand Down
2 changes: 1 addition & 1 deletion fvgp/gpMCMC.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
# *the proposal distribution has to receive and return parameters without knowing what they are


class gpMCMC(): # pragma: no cover
class gpMCMC: # pragma: no cover
"""
This class provides allows the user to customize an MCMC via user-defined proposal distributions and a prior.
Expand Down

0 comments on commit 4c414a1

Please sign in to comment.