Skip to content
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

Use tuples in KernelSum and KernelProduct; Make Zygote tests pass for KernelSum and KernelProduct; Improve doctring. #146

Merged
merged 19 commits into from
Aug 7, 2020

Conversation

sharanry
Copy link
Contributor

@sharanry sharanry commented Aug 2, 2020

@willtebbutt
Copy link
Member

This is an excellent opportunity to provide an docstring demonstrating the various ways to construct these kernels / providing advice regarding when to use which options. In particular

  • examples of how to construct a kernel with Tuple of kernels, kernels as separate args, and a vector of kernels.
  • something like: "you should use a Tuple if there aren't many components, but a vector if there are lots"

Preferably the examples would be included as doctests to prevent documentation-regression.

@devmotion
Copy link
Member

I'm wondering if we should remove the weights in KernelSum. They seem a bit redundant since every kernel can be scaled anyways.

@theogf
Copy link
Member

theogf commented Aug 2, 2020

What about what @devmotion was saying about for large collections of kernels, tuples would be inefficient?

@theogf
Copy link
Member

theogf commented Aug 2, 2020

I agree for the weights problem we should remove them

docs/src/userguide.md Outdated Show resolved Hide resolved
src/kernels/kernelsum.jl Outdated Show resolved Hide resolved
src/kernels/kernelsum.jl Outdated Show resolved Hide resolved
src/kernels/kernelsum.jl Outdated Show resolved Hide resolved
src/kernels/kernelsum.jl Outdated Show resolved Hide resolved
src/kernels/kernelsum.jl Outdated Show resolved Hide resolved
src/kernels/kernelproduct.jl Outdated Show resolved Hide resolved
src/kernels/kernelsum.jl Show resolved Hide resolved
src/kernels/kernelsum.jl Show resolved Hide resolved
src/kernels/kernelsum.jl Outdated Show resolved Hide resolved
src/kernels/kernelsum.jl Outdated Show resolved Hide resolved
src/kernels/kernelsum.jl Outdated Show resolved Hide resolved
src/kernels/kernelsum.jl Outdated Show resolved Hide resolved
src/kernels/kernelsum.jl Outdated Show resolved Hide resolved
test/kernels/kernelsum.jl Show resolved Hide resolved
@theogf
Copy link
Member

theogf commented Aug 3, 2020

Maybe it's also the good place to check that Zygote tests are passing!
Edit: I tried the Zygote tests and they seem to pass now.

test/kernels/kernelsum.jl Outdated Show resolved Hide resolved
@sharanry sharanry changed the title Use tuples in KernelSum and KernelProduct Use tuples in KernelSum and KernelProduct; Make Zygote tests pass for KernelSum and KernelProduct; Improve doctring. Aug 3, 2020
src/kernels/kernelproduct.jl Outdated Show resolved Hide resolved
src/kernels/kernelsum.jl Outdated Show resolved Hide resolved
src/kernels/kernelsum.jl Outdated Show resolved Hide resolved
src/kernels/kernelsum.jl Outdated Show resolved Hide resolved
src/kernels/kernelproduct.jl Outdated Show resolved Hide resolved
src/kernels/kernelproduct.jl Outdated Show resolved Hide resolved
src/kernels/kernelproduct.jl Outdated Show resolved Hide resolved
@sharanry
Copy link
Contributor Author

sharanry commented Aug 5, 2020

There seems to be a dependency error with Julia 1.3 build. Any idea what this is about?
https://travis-ci.com/github/JuliaGaussianProcesses/KernelFunctions.jl/jobs/368383076#L341

@devmotion
Copy link
Member

Maybe it was due to https://discourse.julialang.org/t/pkg-downtime-incident/44288

Copy link
Member

@willtebbutt willtebbutt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lightly reviewed for style / docstrings.

src/kernels/kernelproduct.jl Outdated Show resolved Hide resolved
src/kernels/kernelproduct.jl Outdated Show resolved Hide resolved
src/kernels/kernelproduct.jl Outdated Show resolved Hide resolved
src/kernels/kernelproduct.jl Outdated Show resolved Hide resolved
src/kernels/kernelproduct.jl Outdated Show resolved Hide resolved
src/kernels/kernelsum.jl Outdated Show resolved Hide resolved
src/kernels/kernelsum.jl Outdated Show resolved Hide resolved
src/kernels/kernelsum.jl Outdated Show resolved Hide resolved
src/kernels/kernelsum.jl Outdated Show resolved Hide resolved
src/kernels/kernelsum.jl Outdated Show resolved Hide resolved
Copy link
Member

@devmotion devmotion left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, just a final docstring suggestion.

docs/src/kernels.md Outdated Show resolved Hide resolved
Copy link
Member

@willtebbutt willtebbutt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is excellent. Really glad to have it in!

Removing the weight fields is breaking, so could you please bump the minor-version and release :)

@sharanry sharanry merged commit d9ccffa into master Aug 7, 2020
@sharanry sharanry deleted the sharan/use-tuples branch August 7, 2020 18:35
sharanry added a commit that referenced this pull request Aug 7, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants