-
Notifications
You must be signed in to change notification settings - Fork 32
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Example notebook: Gaussian process priors #316
Conversation
Some high-level comment/idea: Since this is not how we want users to create or work with Gaussian processes, I think it would be nice to have to both the "naive"/basic KernelFunctions approach and the AbstractGP-based implementation together in an example to avoid any incorrect impressions and so that users know how they should do it. However, if both AbstractGPs and KernelFunctions are part of the example, I think the example fits better into either the AbstractGPs repo or the JuliaGaussianProcesses webpage. Otherwise we use packages that depend on KernelFunctions and hence introduce a circular dependency that makes it difficult to update the example without delay if there are breaking changes in KernelFunctions. |
How about leaving this example in KernelFunctions but clarifying all you're saying in an intro paragraph and linking to the corresponding "proper" example in AbstractGPs docs? |
This should definitely be done if the example is added to KernelFunctions. My worry is that people do not notice and read the paragraph and just copy whatever code there is on this page about Gaussian processes. I assume this is less of a problem with the "correct" code is on the same page as well. |
It might be helpful if you expand on what you're worried about so we can discuss likelihood, impact, and mitigations:)? |
I am worried that they copy and use the code but are not aware of how one is supposed to work with Gaussian processes. |
In my opinion it would be sufficient to add one of those hint things that you can add in documenter saying something along the lines of "this is an illustrative example, you should probably be using an AbstractGP of some kind or another if you actually want to do something with a GP" |
…tions.jl into st/examples--gaussian-process-priors
On the other hand, we can always link to AbstractGPs or the JuliaGaussianProcesses webpage from the documentation, so the example would still be discoverable from the KernelFunctions docs even if it is part of AbstractGPs or the webpage. |
…iaGaussianProcesses/KernelFunctions.jl into st/examples--gaussian-process-priors
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. Just a quick clarification.
No description provided.