move to KernelFunctions style literate.jl #185
Conversation
| Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c" | ||
| StatsFuns = "4c63d2b9-4356-54db-8cca-17b64c39e42c" | ||
|
|
||
| [compat] |
There was a problem hiding this comment.
NB- KernelFunctions.jl includes a line julia = "1.3", do we want to add a line like that here, or remove it there, and should it be 1.3 or just julia = "1", or julia = "1.6"?
There was a problem hiding this comment.
It should be 1.3 for the main project.toml. It means we do not support lower versions of Julia.
For the docs we could add it, but it's not particularly necessary.
There was a problem hiding this comment.
I would personally prefer to not include a julia bound, and let the examples inherit it from whatever the bound the bound is on the current version of AbstractGPs.
| # [Literate.jl](https://github.com/fredrikekre/Literate.jl) from the | ||
| # [Julia source file](@__REPO_ROOT_URL__/examples/@__NAME__/script.jl). | ||
| #md # The corresponding notebook can be viewed in [nbviewer](@__NBVIEWER_ROOT_URL__/examples/@__NAME__.ipynb).* | ||
| #nb # The rendered HTML can be viewed [in the docs](https://juliagaussianprocesses.github.io/AbstractGPs.jl/dev/examples/@__NAME__/).* |
There was a problem hiding this comment.
The one line changed from KernelFunctions.jl
|
|
||
| # Print `@debug` statements (https://github.com/JuliaDocs/Documenter.jl/issues/955) | ||
| if haskey(ENV, "GITHUB_ACTIONS") | ||
| ENV["JULIA_DEBUG"] = "Documenter" |
There was a problem hiding this comment.
Now handled by .github/workflows/docs.yml
docs/make.jl
Outdated
| strict=true, | ||
| checkdocs=:exports, | ||
| doctestfilters=[ | ||
| r"{([a-zA-Z0-9]+,\s?)+[a-zA-Z0-9]+}", | ||
| r"(Array{[a-zA-Z0-9]+,\s?1}|Vector{[a-zA-Z0-9]+})", | ||
| r"(Array{[a-zA-Z0-9]+,\s?2}|Matrix{[a-zA-Z0-9]+})", |
Codecov Report
@@ Coverage Diff @@
## master #185 +/- ##
=======================================
Coverage 97.98% 97.98%
=======================================
Files 10 10
Lines 348 348
=======================================
Hits 341 341
Misses 7 7 Continue to review full report at Codecov.
|
There was a problem hiding this comment.
This is fantastic -- thanks for sorting it out.
The Manifest for the example needs updating -- presently it assumes that AbstractGPs is located at .. -- the fix is just to dev ../.. to update the Manifest.
Additionally, the optimisation example at the end of the script seems to be a bit unstable -- I was getting cholesky errors when I ran it locally. Would you mind adding some jitter to the pseudo-points while we're here? Specifically, making line 395 something like
return -elbo(fx, y, f(logistic.(params[3:end]), 1e-6))fixes the problem for me.
… included in the docs
…stractGPs.jl into st/literate_jl
Copying over the new notebooks setup from KernelFunctions.jl with independent environments for each example.