Skip to content

Commit

Permalink
docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
MartinuzziFrancesco committed Nov 7, 2024
1 parent 3198d9c commit c0030ac
Showing 1 changed file with 23 additions and 2 deletions.
25 changes: 23 additions & 2 deletions src/indrnn_cell.jl
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,32 @@ end

Flux.@layer IndRNNCell

"""
function IndRNNCell((in, out)::Pair, σ=relu;
@doc raw"""
IndRNNCell((in => out)::Pair, σ=relu;
kernel_init = glorot_uniform,
recurrent_kernel_init = glorot_uniform,
bias = true)
# Arguments
- `in => out`: input and inner dimension of the layer
- `σ`: activation function. Default is `tanh`
- `kernel_init`: initializer for the input to hidden weights
- `recurrent_kernel_init`: initializer for the hidden to hidden weights
- `bias`: include a bias or not. Default is `true`
# Equations
```math
\mathbf{h}_{t+1} = \sigma(\mathbf{W} \mathbf{x}_t + \mathbf{u} \odot \mathbf{h}_{t} + \mathbf{b})
```
# Forward
rnncell(inp, [state])
"""
function IndRNNCell((in, out)::Pair, σ=relu;
kernel_init = glorot_uniform,
Expand Down

0 comments on commit c0030ac

Please sign in to comment.