From 0051ebeb4e3c9061214d84b0129f5f469067037a Mon Sep 17 00:00:00 2001 From: MartinuzziFrancesco Date: Fri, 8 Nov 2024 11:44:04 +0100 Subject: [PATCH] better docs? --- docs/make.jl | 3 +++ docs/src/assets/favicon.ico | Bin 0 -> 15406 bytes docs/src/index.md | 6 +----- src/indrnn_cell.jl | 3 --- 4 files changed, 4 insertions(+), 8 deletions(-) create mode 100644 docs/src/assets/favicon.ico diff --git a/docs/make.jl b/docs/make.jl index c6ecf2e..5bdac3d 100644 --- 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 new file mode 100644 index 0000000000000000000000000000000000000000..62903cb95c92ca904d5829dc8741731c1db9f148 GIT binary patch literal 15406 zcmeHO3vg7`8NLBTD^{TvZEDq^C^X1sAIUz#?%o7Ub~i9Q3d=r#;`G7LGIlz)wzaKn zJ30kSvb#xkH>O2mZAH7;hbUvEklY(YhZdyJqI5(pR*_akd=LbYY`?R~*__?%-E5Le zVmrArch0%z{OA9_^Pl&B{>yO%+<0#CWDa2ww{`-@X*rH7D(d;3Ifdi4AWf<4&A*l7 zo}bEbGeLtQDAALS;4}MZO`VJMys%Mk?s#ktFFu|NXxQE|JM8gHWNB1p@vC~i^KHXi zF#$dY*u0E*LCocQzs>25Cx}{lpR%%@R~t;iNm5?R3xA^N*}`q^hDA}AuRHE;T0`@- z=8pB+N})??eghs~;FX+wUV^Z{)=~26PZp_`72;1v4 zBoAe~45s!UX3|N0Lx)$z-Tp+>U+EW0cEnhyQMN&-rUiwuN00KbK$ghl`0=~`Zk~qJ|s8@OvEQH!*=(9%^r?F>D z1Nmq`qiMNBYuYhQU$L9ln>tow?q82Fyf&Y*!=b@k`E@-n9wYOGp+ZcsudYJeIaJPJl2!<$efC~@s;QjZy}qX8Smy2 z1<*l+%B3N663C>@=bNmhSksOW`AG~e|K9y;S}w^|7P59wxir+7gkR(;lPfRo@D)Yf zzT*@_+~vPdie6_H7gCvNp{aA7RGECz(FTU7%YVK{2fnirckPYY%Av3CqjJ&rzX?1) zhCaHn4{&CqA52=rkTI2ho~3*6B^1WNSIBXPeW1 zE!NhLd;7tuR^F4go*J+}O4Xeg?jDvfiNer9TaOMJ6KxKkjU{9Ioz}R!n9Y+b9&>tE z(>B0f^L~~uGe?g(EoQ?zL;ZHq~!C$ z!)%^ham+t268TsUx?_%}TUowZ?bBDH51u9%$XL+pcU{Nk4>yi=(3YyZ+qXX(Kb^Uw ziRu9Du{9gbP}0J7&qS<2f2Z=}4)3aLeAK4SLIW>;kkkP$yd_sZBzqsU_dk=mclrKC z_9fZmlQf)@*FyjAl=8xDQZz$Jk2~tFPqx3Se!#U1>unJ$L(y0@4c`T9+CcF_kLGfm z&(hZUf%ZPxc$PF*Yt^Be4{-L|Q_^Iq$VQWv=HVyceCJjNZLi|YctR1X8nPaX12ta) zpOfUQNnh}MNgc3mQZ?C@DudRtl7MBFs>xzd1uU!7A!{?}-=ef6#P{(To6Gy1iPJFW z_~<$J+FoOM<{O9X=ar4sB{|sVl{LM=da1I>@-211wjVrk{_fL9W*qtFRYBV`>L%L) zFdtN($p;MSQ>vhKC1h;C+Y0?`1+L9#6OSfnTU=aU{e^t^jM02HG(hYmFwt^%;2pD* zKnY{dmYVU+#;xZ(l6zq(9(uhn z-C!1Rw<4Ye#tVju9=i=aJETH#?^PkzO7R&^dfQU(EbOOu<6Lnly28I?aJ&))T4TE% z*poJo6yDzRC;N@I_|f2a4@~WWZ42kIL-ag^db}TX)-TC*F6qxTF^<>^(FU)ucr)YZ zKX>#mJG>NPJBvAeA4gJlRbMyGS1-jK4dsL7jPY7dZ7-SF$+xzmbN*m?=0lG&xS#63 z_gvTwo7B!{|FnyKbs3u&ZU-Hl?_d zag6c#MmFpu4fwlC4f39YSuA0@ZwAKib1Ce^HsbPs7`f#+= zxbvo5eB{WBI=y$Y{RnMvhTP>#^A3-P?mfWx3B^xrS7rR3Qc{N4uTh6*(6{!%Z{aJ_ zeB{Y_(pC3G=zJe-0}@8y%OJ&FquF^Cuy+t0_u&^FV(E3dUDxVx_fBZp^otQs;NA;& zBKH9IIa&w!K%AAjFN0soG+=)(g&p=ntywf(3~c%GY;)9=qYd7q_+#z{-1&L$%vK(K zXL-8r#r-4EPqJa5X^&LZPQn;Sn~Ne2?;mMC8|vo@K}Pop?B%v76g%?re_;8@9Vh-L zefm$%rN_edjs5yB=9xVy{A7*dJAclh56X>au>9aV^feYg)`tH?Ty?}mk@n!8`pqQ% zO0q_YXEE1&JB?tJKH8jqMLK@}$!vQfVD9R}5C5!+PRA%gP7@nlQhQB0e)yz0ywzz$ zoG<}nmznp4(-^zU(rHHL>(Tierm*-ioHCR z=SV%U4xhpt+HW03|9Q0!zj)4oJMwf+qw|GxSQ+u(qiq2FzZ+ZJ|GoqLC*@;7)&Z;s z_hJ4SH#(^Mq(&TpRTO(Nboow1+}?isFTF|FNcB%b)Zy`w*eCQM%^t)3{)6;Pmh3-n z-^8isC1Cyid9OS^Z{;dEpA^e;f3lY6E=ZKEB82h2=XE@fP^JVVmea?suvF(H7oZGSTPZn=QOd z$3RaV#KXjfn5&%JdBo;Jbf3aa=6$FCo#^uV0qzZn&x&w=27Y3XyIZ5#pVP-p&N@Vw z`^&KJKa;}m@?XH&<)O`4{E#!{!fuOkAihZJfcR8kNyehMtmO)|B5SOPXBL7JD?t$q_Ad7pFaKROUeEp z;{ks5qci^yT*sbxfo0S2J3-#Xu-2Y~M z9l-m!l0X%?x|aPZX|`0T0=6zz9*qOXIpBF4;bGLHmDCe{5DxNBgDOX{nMH!~l!6z2NZ>LQ{U MV?CyU|62|G7k}a@w*UYD literal 0 HcmV?d00001 diff --git a/docs/src/index.md b/docs/src/index.md index b2cbaf2..5cb074f 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -2,10 +2,6 @@ CurrentModule = RecurrentLayers ``` -

- -

- # 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 index e1fd5cb..c8c69e7 100644 --- 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,