-
-
Notifications
You must be signed in to change notification settings - Fork 130
Add pictures for activation functions #356
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
Conversation
|
We could render them in the docs but large help sections that aren't critical can be annoying to use in the REPL. |
596f886 to
29e78eb
Compare
|
I like this idea! All the activation function docstrings are much shorter than typical docstrings e.g. |
|
How about under extended help? JuliaLang/julia#34226 |
|
I think it is very helpful to have these plots under standard help. I also like the fact that they will show up in the documentation site. |
Project.toml
Outdated
| Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c" | ||
| StableRNGs = "860ef19b-820b-49d6-a774-d7a799459cd3" | ||
| Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40" | ||
| UnicodePlots = "b8865327-cd53-5732-bb35-84acbb429228" |
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.
needs a compat bound
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.
I was following the other test deps (StableRNGs, Zygote) which don't have one.
Since there's no test dep on Documenter, I guess the docstrings aren't tested? Or maybe they are tested when building Flux's docs? Either way, there is then no need for a dependency here.
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.
Alternatively, we can add documenter just to test the doctests. That's probably not a bad idea, better to find out sooner if your PR needs to tweak something. The code needed is something like:
if VERSION < v"1.6-" || VERSION > v"1.7-"
@warn "skipping doctests, on Julia $VERSION"
else
using Documenter
@testset "doctests" begin
doctest(NNlib, manual=false)
end
end
But perhaps I declare that out-of-scope for this PR.
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.
sorry, got confused, doesn't need a compat entry (but i see you removed it entirely)
|
Maybe it's better to not have to depend on a plotting library even if light, considering that this isn't expected to be used often. Not to mention, NNlib is supposed to be light. We can still do it in the docs, it's applicability is higher in the docs anyway. |
|
Build failures are (at least) two different |

Might be nice to have?
Not entirely sure how well these will render in different places. Also whether this package tests its own
jldoctests.