better docs?

MartinuzziFrancesco · Nov 8, 2024 · 0051ebe · 0051ebe
1 parent c0030ac
commit 0051ebe
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 8 deletions.
diff --git a/docs/make.jl b/docs/make.jl
@@ -3,12 +3,15 @@ using Documenter
 include("pages.jl")
 
 DocMeta.setdocmeta!(RecurrentLayers, :DocTestSetup, :(using RecurrentLayers); recursive=true)
+mathengine = MathJax3()
 
 makedocs(;
     modules=[RecurrentLayers],
     authors="Francesco Martinuzzi",
     sitename="RecurrentLayers.jl",
     format=Documenter.HTML(;
+        mathengine,
+        assets = ["assets/favicon.ico"],
         canonical="https://MartinuzziFrancesco.github.io/RecurrentLayers.jl",
         edit_link="main",
         assets=String[],

diff --git a/docs/src/assets/favicon.ico b/docs/src/assets/favicon.ico
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -2,10 +2,6 @@
 CurrentModule = RecurrentLayers
 ```
 
-<p align="center">
-    <img width="400px" src="assets/logo.png"/>
-</p>
-
 # RecurrentLayers
 
 RecurrentLayers.jl extends [Flux.jl](https://github.com/FluxML/Flux.jl) recurrent layers offering by providing implementations of bleeding edge recurrent layers not commonly available in base deep learning libraries. It is designed for a seamless integration with the larger Flux ecosystem, enabling researchers and practitioners to leverage the latest developments in recurrent neural networks.
@@ -16,7 +12,7 @@ RecurrentLayers.jl extends [Flux.jl](https://github.com/FluxML/Flux.jl) recurren
  - Light gated recurrent unit as `LiGRUCell` [arxiv](https://arxiv.org/abs/1803.10225)
  - Independently recurrent neural networks as `IndRNNCell` [arxiv](https://arxiv.org/abs/1803.04831)
  - Recurrent addictive networks as `RANCell` [arxiv](https://arxiv.org/abs/1705.07393)
- - Recurrent highway network as `RHNCell [arixv](https://arxiv.org/pdf/1607.03474)
+ - Recurrent highway network as `RHNCell` [arixv](https://arxiv.org/pdf/1607.03474)
  - Light recurrent unit as `LightRUCell` [pub](https://www.mdpi.com/2079-9292/13/16/3204)
  - Neural architecture search unit `NASCell` [arxiv](https://arxiv.org/abs/1611.01578)
  - Evolving recurrent neural networks as `MUT1Cell`, `MUT2Cell`, `MUT3Cell` [pub](https://proceedings.mlr.press/v37/jozefowicz15.pdf)

diff --git a/src/indrnn_cell.jl b/src/indrnn_cell.jl
@@ -23,7 +23,6 @@ Flux.@layer IndRNNCell
     - `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})
     ```
@@ -32,8 +31,6 @@ Flux.@layer IndRNNCell
 
         rnncell(inp, [state])
 
-        
-
 """
 function IndRNNCell((in, out)::Pair, σ=relu;
     kernel_init = glorot_uniform,