JuliaGaussianProcesses / JuliaGaussianProcesses/KernelFunctions.jl
Revisit Multi-Output Support Naming Conventions
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:
MOvsMultiOutput. 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,mokernelandweightsinstead ofg,eandAfor the slfm - the
LinearMixingModelKernelis a kernel, not a model. Maybe it should be renamedLinearMixingKernelfor eg. I think we've all agreed on this already.
Contributor guide
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 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