Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Incorrect docstring for regulariser() in oilmm.jl #53

Open
mjp98 opened this issue Dec 6, 2022 · 1 comment
Open

Incorrect docstring for regulariser() in oilmm.jl #53

mjp98 opened this issue Dec 6, 2022 · 1 comment

Comments

@mjp98
Copy link

mjp98 commented Dec 6, 2022

The docstring for regulariser(...) in oilmm.jl does not match the function signature used:

  """
      regulariser(fx, y)
  Computes the regularisation term of the logpdf.
  See e.g. appendix A.4 of [1] - Bruinsma et al 2020.
  """
  function regulariser(
      H::Orthogonal{T},
      σ²::T,
      Y::AbstractMatrix{T},
  ) where {T<:Real}

This function signature in the docstring matches that of regulariser(...) in ilmm.jl.

Perhaps it would be worth adding a new method for regulariser(fx::FiniteGP{<:OILMM}, y)?

@willtebbutt
Copy link
Member

That sounds like an excellent idea. You can probably just remove this method, and replace it with your proposed method.

In fact, it might make sense to replace y with Y::AbstractMatrix{<:Real} (or something like that) in both cases.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants