JuliaGaussianProcesses / JuliaGaussianProcesses/KernelFunctions.jl

Revisit Multi-Output Support Naming Conventions

Open
#332 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Julia
Stars
275
Forks
41
PR merge metrics
No merged PRs in 30d

Description

Two new multi-output input types are being added and the PR sparked some debate/discussion surrounding their names and the wider spread naming conventions that have been adopted in KernelFuntions. The main thread discussing these can be found [here].(https://github.com/JuliaGaussianProcesses/KernelFunctions.jl/pull/310#discussion_r661490968).

Some starting points:

  • MO vs MultiOutput. Concise or explicit?
  • Do we like the prefix isotopic? Is it too jargony?

Quote from paper linked above:
In the geostatistics literature, if each output has the same set of inputs the model
is called isotopic

Pros:
It has a specific meaning in this context, clearly identifying what it is
Cons:
Might scare users off, lengthens names

  • Relating to the PR linked above, how do we make these accessible? Less "wordy" helpers? What do we call those?
  • Should composite type field names have more descriptive names?
    eg. kernels, mokernel and weights instead of g, e and A for the slfm
  • the LinearMixingModelKernel is a kernel, not a model. Maybe it should be renamed LinearMixingKernel for eg. I think we've all agreed on this already.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the discussion in PR #310 and the linked thread, then inspect src/mokernels/slfm.jl, especially the composite type fields. The work is complete when the project has a documented, agreed naming convention for multi-output types, helpers, fields, and LinearMixingModelKernel.

Written by the indexing model from the issue text.

Assessment

Tech stack
julia
Domain
machine-learning
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.