JuliaGaussianProcesses / JuliaGaussianProcesses/LinearMixingModels.jl
Incorrect docstring for `regulariser()` in oilmm.jl
Nobody has claimed this yet.
- Dominant language
- Julia
- Stars
- 5
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
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)?
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by comparing the regulariser docstring and signature in src/oilmm.jl around line 95 with the corresponding definition in src/ilmm.jl around line 171. Check the current API and tests before deciding whether the documentation alone is incorrect or whether the proposed FiniteGP method is needed. Done means the documented arguments accurately describe the supported method and any resulting tests pass.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100