Update README.md #446
Merged
Update README.md #446
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
st--
commented
Apr 13, 2022
Comment on lines
+14
to
+19
| **KernelFunctions.jl** is a general purpose [kernel](https://en.wikipedia.org/wiki/Positive-definite_kernel) package. | ||
| It provides a flexible framework for creating kernel functions and manipulating them, and an extensive collection of implementations. | ||
| The main goals of this package are: | ||
| - **Flexibility**: operations between kernels should be fluid and easy without breaking, with a user-friendly API. | ||
| - **Plug-and-play**: being model-agnostic; including the kernels before/after other steps should be straightforward. To interoperate well with generic packages for handling parameters like [ParameterHandling.jl](https://github.com/invenia/ParameterHandling.jl/) and FluxML's [Functors.jl](https://github.com/FluxML/Functors.jl/). | ||
| - **Automatic Differentiation compatibility**: all kernel functions which _ought_ to be differentiable using AD packages like [ForwardDiff.jl](https://github.com/JuliaDiff/ForwardDiff.jl) or [Zygote.jl](https://github.com/FluxML/Zygote.jl) _should_ be. |
There was a problem hiding this comment.
Copied this over from https://github.com/JuliaGaussianProcesses/KernelFunctions.jl/blob/master/docs/src/index.md and edited it slightly. If you're happy with this I'll also "back-port" it to docs/src/index.md.
Codecov Report
@@ Coverage Diff @@
## master #446 +/- ##
=======================================
Coverage 93.16% 93.16%
=======================================
Files 52 52
Lines 1259 1259
=======================================
Hits 1173 1173
Misses 86 86 Continue to review full report at Codecov.
|
willtebbutt
approved these changes
Apr 13, 2022
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Improve links to other packages, addressing #407