Doc corrections and unicode(theta)#184
Conversation
Codecov Report
@@ Coverage Diff @@
## master #184 +/- ##
=======================================
Coverage 71.11% 71.11%
=======================================
Files 26 26
Lines 945 945
=======================================
Hits 672 672
Misses 273 273
Continue to review full report at Codecov.
|
src/impl/conv_im2col.jl
Outdated
|
|
||
| """ | ||
| conv_im2col!(y, x, w, cdims, col=similar(x); alpha=1, beta=0) | ||
| conv_im2col!(y, x, w, cdims, col=similar(x); α=1, β=0) |
There was a problem hiding this comment.
is this exported or used in flux? we should not break the interface
There was a problem hiding this comment.
I searched for this in the flux source files, but didn't found any function where this or other functions changed here, use alpha or beta parameters. However, flux re-export NNlib in its main file. I hope there shouldn't be any problem with Flux related interface.
|
@CarloLucibello can you please review these changes? I have removed the Unicode for alpha and beta as they may break the interface for some of the dependent packages, as you pointed out earlier. |
src/activation.jl
Outdated
| See [ThresholdRelu](https://arxiv.org/pdf/1402.3337.pdf) | ||
| """ | ||
| trelu(x::Real,theta = one(x)) = ifelse(x> theta, x, zero(x)) | ||
| trelu(x::Real,θ = one(x)) = ifelse(x> θ, x, zero(x)) |
There was a problem hiding this comment.
| trelu(x::Real,θ = one(x)) = ifelse(x> θ, x, zero(x)) | |
| trelu(x::Real, θ=one(x)) = ifelse(x> θ, x, zero(x)) |
src/activation.jl
Outdated
|
|
||
| """ | ||
| logcosh(x) | ||
| logcosh(x) = x + softplus(-2x) - log(2) |
There was a problem hiding this comment.
the mathematical definition better down in the docstring
There was a problem hiding this comment.
So this should be changed for all the existing functions? As in all the rest functions, mathematical definition is written beside the function.
|
@CarloLucibello I have moved the mathematical definition to docstrings, for all the functions to maintain the uniformity. Please review these changes. |
I have made some minor doc corrections and replaced alpha, beta, theta with their unicode chars.
I have also updated the leakyrelu activation function to address #176 , and replaced
x / one(x)withx / 1asx / 1works faster. Please have a look at these changes.