docs

2025-09-19 10:48:09 +08:00 · 2023-12-17 13:23:03 -08:00
parent f75712551d
commit 0250e203f6
319 changed files with 39952 additions and 21579 deletions
--- a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.Conv1d.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.Conv1d.rst
@@ -0,0 +1,8 @@
+mlx.nn.Conv1d
+=============
+
+.. currentmodule:: mlx.nn
+
+.. autoclass:: Conv1d
+
+   
--- a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.Conv2d.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.Conv2d.rst
@@ -0,0 +1,8 @@
+mlx.nn.Conv2d
+=============
+
+.. currentmodule:: mlx.nn
+
+.. autoclass:: Conv2d
+
+   
--- a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.Embedding.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.Embedding.rst
@@ -0,0 +1,8 @@
+mlx.nn.Embedding
+================
+
+.. currentmodule:: mlx.nn
+
+.. autoclass:: Embedding
+
+   
--- a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.GELU.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.GELU.rst
@@ -0,0 +1,8 @@
+mlx.nn.GELU
+===========
+
+.. currentmodule:: mlx.nn
+
+.. autoclass:: GELU
+
+   
--- a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.GroupNorm.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.GroupNorm.rst
@@ -0,0 +1,8 @@
+mlx.nn.GroupNorm
+================
+
+.. currentmodule:: mlx.nn
+
+.. autoclass:: GroupNorm
+
+   
--- a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.LayerNorm.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.LayerNorm.rst
@@ -0,0 +1,8 @@
+mlx.nn.LayerNorm
+================
+
+.. currentmodule:: mlx.nn
+
+.. autoclass:: LayerNorm
+
+   
--- a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.Linear.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.Linear.rst
@@ -0,0 +1,8 @@
+mlx.nn.Linear
+=============
+
+.. currentmodule:: mlx.nn
+
+.. autoclass:: Linear
+
+   
--- a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.Mish.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.Mish.rst
@@ -0,0 +1,8 @@
+mlx.nn.Mish
+===========
+
+.. currentmodule:: mlx.nn
+
+.. autoclass:: Mish
+
+   
--- a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.MultiHeadAttention.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.MultiHeadAttention.rst
@@ -0,0 +1,8 @@
+mlx.nn.MultiHeadAttention
+=========================
+
+.. currentmodule:: mlx.nn
+
+.. autoclass:: MultiHeadAttention
+
+   
--- a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.PReLU.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.PReLU.rst
@@ -0,0 +1,8 @@
+mlx.nn.PReLU
+============
+
+.. currentmodule:: mlx.nn
+
+.. autoclass:: PReLU
+
+   
--- a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.RMSNorm.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.RMSNorm.rst
@@ -0,0 +1,8 @@
+mlx.nn.RMSNorm
+==============
+
+.. currentmodule:: mlx.nn
+
+.. autoclass:: RMSNorm
+
+   
--- a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.ReLU.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.ReLU.rst
@@ -0,0 +1,8 @@
+mlx.nn.ReLU
+===========
+
+.. currentmodule:: mlx.nn
+
+.. autoclass:: ReLU
+
+   
--- a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.RoPE.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.RoPE.rst
@@ -0,0 +1,8 @@
+mlx.nn.RoPE
+===========
+
+.. currentmodule:: mlx.nn
+
+.. autoclass:: RoPE
+
+   
--- a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.SELU.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.SELU.rst
@@ -0,0 +1,8 @@
+mlx.nn.SELU
+===========
+
+.. currentmodule:: mlx.nn
+
+.. autoclass:: SELU
+
+   
--- a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.Sequential.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.Sequential.rst
@@ -0,0 +1,8 @@
+mlx.nn.Sequential
+=================
+
+.. currentmodule:: mlx.nn
+
+.. autoclass:: Sequential
+
+   
--- a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.SiLU.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.SiLU.rst
@@ -0,0 +1,8 @@
+mlx.nn.SiLU
+===========
+
+.. currentmodule:: mlx.nn
+
+.. autoclass:: SiLU
+
+   
--- a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.Step.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.Step.rst
@@ -0,0 +1,8 @@
+mlx.nn.Step
+===========
+
+.. currentmodule:: mlx.nn
+
+.. autoclass:: Step
+
+   
--- a/docs/build/html/_sources/python/nn/_autosummary_functions/mlx.nn.gelu.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary_functions/mlx.nn.gelu.rst
@@ -0,0 +1,8 @@
+mlx.nn.gelu
+===========
+
+.. currentmodule:: mlx.nn
+
+.. autoclass:: gelu
+
+   
--- a/docs/build/html/_sources/python/nn/_autosummary_functions/mlx.nn.gelu_approx.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary_functions/mlx.nn.gelu_approx.rst
@@ -0,0 +1,8 @@
+mlx.nn.gelu\_approx
+===================
+
+.. currentmodule:: mlx.nn
+
+.. autoclass:: gelu_approx
+
+   
--- a/docs/build/html/_sources/python/nn/_autosummary_functions/mlx.nn.gelu_fast_approx.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary_functions/mlx.nn.gelu_fast_approx.rst
@@ -0,0 +1,8 @@
+mlx.nn.gelu\_fast\_approx
+=========================
+
+.. currentmodule:: mlx.nn
+
+.. autoclass:: gelu_fast_approx
+
+   
--- a/docs/build/html/_sources/python/nn/_autosummary_functions/mlx.nn.losses.binary_cross_entropy.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary_functions/mlx.nn.losses.binary_cross_entropy.rst
@@ -0,0 +1,8 @@
+mlx.nn.losses.binary\_cross\_entropy
+====================================
+
+.. currentmodule:: mlx.nn.losses
+
+.. autoclass:: binary_cross_entropy
+
+   
--- a/docs/build/html/_sources/python/nn/_autosummary_functions/mlx.nn.losses.cross_entropy.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary_functions/mlx.nn.losses.cross_entropy.rst
@@ -0,0 +1,8 @@
+mlx.nn.losses.cross\_entropy
+============================
+
+.. currentmodule:: mlx.nn.losses
+
+.. autoclass:: cross_entropy
+
+   
--- a/docs/build/html/_sources/python/nn/_autosummary_functions/mlx.nn.losses.kl_div_loss.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary_functions/mlx.nn.losses.kl_div_loss.rst
@@ -0,0 +1,8 @@
+mlx.nn.losses.kl\_div\_loss
+===========================
+
+.. currentmodule:: mlx.nn.losses
+
+.. autoclass:: kl_div_loss
+
+   
--- a/docs/build/html/_sources/python/nn/_autosummary_functions/mlx.nn.losses.l1_loss.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary_functions/mlx.nn.losses.l1_loss.rst
@@ -0,0 +1,8 @@
+mlx.nn.losses.l1\_loss
+======================
+
+.. currentmodule:: mlx.nn.losses
+
+.. autoclass:: l1_loss
+
+   
--- a/docs/build/html/_sources/python/nn/_autosummary_functions/mlx.nn.losses.mse_loss.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary_functions/mlx.nn.losses.mse_loss.rst
@@ -0,0 +1,8 @@
+mlx.nn.losses.mse\_loss
+=======================
+
+.. currentmodule:: mlx.nn.losses
+
+.. autoclass:: mse_loss
+
+   
--- a/docs/build/html/_sources/python/nn/_autosummary_functions/mlx.nn.losses.nll_loss.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary_functions/mlx.nn.losses.nll_loss.rst
@@ -0,0 +1,8 @@
+mlx.nn.losses.nll\_loss
+=======================
+
+.. currentmodule:: mlx.nn.losses
+
+.. autoclass:: nll_loss
+
+   
--- a/docs/build/html/_sources/python/nn/_autosummary_functions/mlx.nn.mish.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary_functions/mlx.nn.mish.rst
@@ -0,0 +1,8 @@
+mlx.nn.mish
+===========
+
+.. currentmodule:: mlx.nn
+
+.. autoclass:: mish
+
+   
--- a/docs/build/html/_sources/python/nn/_autosummary_functions/mlx.nn.prelu.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary_functions/mlx.nn.prelu.rst
@@ -0,0 +1,8 @@
+mlx.nn.prelu
+============
+
+.. currentmodule:: mlx.nn
+
+.. autoclass:: prelu
+
+   
--- a/docs/build/html/_sources/python/nn/_autosummary_functions/mlx.nn.relu.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary_functions/mlx.nn.relu.rst
@@ -0,0 +1,8 @@
+mlx.nn.relu
+===========
+
+.. currentmodule:: mlx.nn
+
+.. autoclass:: relu
+
+   
--- a/docs/build/html/_sources/python/nn/_autosummary_functions/mlx.nn.selu.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary_functions/mlx.nn.selu.rst
@@ -0,0 +1,8 @@
+mlx.nn.selu
+===========
+
+.. currentmodule:: mlx.nn
+
+.. autoclass:: selu
+
+   
--- a/docs/build/html/_sources/python/nn/_autosummary_functions/mlx.nn.silu.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary_functions/mlx.nn.silu.rst
@@ -0,0 +1,8 @@
+mlx.nn.silu
+===========
+
+.. currentmodule:: mlx.nn
+
+.. autoclass:: silu
+
+   
--- a/docs/build/html/_sources/python/nn/_autosummary_functions/mlx.nn.step.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary_functions/mlx.nn.step.rst
@@ -0,0 +1,8 @@
+mlx.nn.step
+===========
+
+.. currentmodule:: mlx.nn
+
+.. autoclass:: step
+
+   
--- a/docs/build/html/_sources/python/nn/functions.rst
+++ b/docs/build/html/_sources/python/nn/functions.rst
@@ -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
--- a/docs/build/html/_sources/python/nn/layers.rst
+++ b/docs/build/html/_sources/python/nn/layers.rst
@@ -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
--- a/docs/build/html/_sources/python/nn/losses.rst
+++ b/docs/build/html/_sources/python/nn/losses.rst
@@ -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
--- a/docs/build/html/_sources/python/nn/module.rst
+++ b/docs/build/html/_sources/python/nn/module.rst
@@ -1,7 +0,0 @@
-mlx.nn.Module
-=============
-
-.. currentmodule:: mlx.nn
-
-.. autoclass:: Module
-   :members: