JuliaGaussianProcesses / JuliaGaussianProcesses/KernelFunctions.jl

Missing examples in docs

Open
#11 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

good first issue help wanted
Dominant language
Julia
Stars
275
Forks
41
PR merge metrics
No merged PRs in 30d

Description

The examples in the docs is currently lacking, so it would be good to provide some examples.

Currently we have to fill out the following

I have a good knowledge of the first two, but shouldn't be very hard to fix the other ones as well, but will take some time.

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 with the examples page linked in the issue and review the four missing sections: Kernel Ridge Regression, Gaussian Process Regression, Deep Kernel Learning, and Kernel Selection. The work is done when each section contains a suitable working example and all four checklist items are complete.

Written by the indexing model from the issue text.

Assessment

Tech stack
julia
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.