Skip to content

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

@mjp98

Description

@mjp98

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)?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions