Docs updates (#198)

Reorganize NN docs + a few other tidbits.
This commit is contained in:
Awni Hannun
2023-12-17 13:20:55 -08:00
committed by GitHub
parent 90d04072b7
commit ee0c2835c5
9 changed files with 160 additions and 74 deletions

View File

@@ -0,0 +1,23 @@
.. _nn_functions:
.. currentmodule:: mlx.nn
Functions
---------
Layers without parameters (e.g. activation functions) are also provided as
simple functions.
.. autosummary::
:toctree: _autosummary_functions
:template: nn-module-template.rst
gelu
gelu_approx
gelu_fast_approx
relu
prelu
silu
step
selu
mish

View File

@@ -0,0 +1,28 @@
.. _layers:
.. currentmodule:: mlx.nn
Layers
------
.. autosummary::
:toctree: _autosummary
:template: nn-module-template.rst
Embedding
ReLU
PReLU
GELU
SiLU
Step
SELU
Mish
Linear
Conv1d
Conv2d
LayerNorm
RMSNorm
GroupNorm
RoPE
MultiHeadAttention
Sequential

View File

@@ -0,0 +1,17 @@
.. _losses:
.. currentmodule:: mlx.nn.losses
Loss Functions
--------------
.. autosummary::
:toctree: _autosummary_functions
:template: nn-module-template.rst
cross_entropy
binary_cross_entropy
l1_loss
mse_loss
nll_loss
kl_div_loss

View File

@@ -1,7 +0,0 @@
mlx.nn.Module
=============
.. currentmodule:: mlx.nn
.. autoclass:: Module
:members: