docs update

2025-09-19 19:38:16 +08:00 · 2024-04-26 08:24:09 -07:00
parent f77d99b285
commit f946f689a6
502 changed files with 14665 additions and 15103 deletions
--- a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.ALiBi.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.ALiBi.rst
@@ -3,4 +3,16 @@

 .. currentmodule:: mlx.nn

-.. autoclass:: ALiBi
+.. autoclass:: ALiBi
+
+   
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+   
+         ~ALiBi.create_alibi_matrix
+         ~ALiBi.create_alibi_slope
+   
+   
--- a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.AvgPool1d.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.AvgPool1d.rst
@@ -3,4 +3,14 @@

 .. currentmodule:: mlx.nn

-.. autoclass:: AvgPool1d
+.. autoclass:: AvgPool1d
+
+   
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+   
+   
+   
--- a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.AvgPool2d.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.AvgPool2d.rst
@@ -3,4 +3,14 @@

 .. currentmodule:: mlx.nn

-.. autoclass:: AvgPool2d
+.. autoclass:: AvgPool2d
+
+   
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+   
+   
+   
--- a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.BatchNorm.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.BatchNorm.rst
@@ -3,4 +3,15 @@

 .. currentmodule:: mlx.nn

-.. autoclass:: BatchNorm
+.. autoclass:: BatchNorm
+
+   
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+   
+         ~BatchNorm.unfreeze
+   
+   
--- a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.Conv1d.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.Conv1d.rst
@@ -3,4 +3,14 @@

 .. currentmodule:: mlx.nn

-.. autoclass:: Conv1d
+.. autoclass:: Conv1d
+
+   
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+   
+   
+   
--- a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.Conv2d.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.Conv2d.rst
@@ -3,4 +3,14 @@

 .. currentmodule:: mlx.nn

-.. autoclass:: Conv2d
+.. autoclass:: Conv2d
+
+   
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+   
+   
+   
--- a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.Dropout.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.Dropout.rst
@@ -3,4 +3,14 @@

 .. currentmodule:: mlx.nn

-.. autoclass:: Dropout
+.. autoclass:: Dropout
+
+   
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+   
+   
+   
--- a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.Dropout2d.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.Dropout2d.rst
@@ -3,4 +3,14 @@

 .. currentmodule:: mlx.nn

-.. autoclass:: Dropout2d
+.. autoclass:: Dropout2d
+
+   
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+   
+   
+   
--- a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.Dropout3d.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.Dropout3d.rst
@@ -3,4 +3,14 @@

 .. currentmodule:: mlx.nn

-.. autoclass:: Dropout3d
+.. autoclass:: Dropout3d
+
+   
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+   
+   
+   
--- a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.Embedding.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.Embedding.rst
@@ -3,4 +3,15 @@

 .. currentmodule:: mlx.nn

-.. autoclass:: Embedding
+.. autoclass:: Embedding
+
+   
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+   
+         ~Embedding.as_linear
+   
+   
--- a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.GELU.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.GELU.rst
@@ -3,4 +3,14 @@

 .. currentmodule:: mlx.nn

-.. autoclass:: GELU
+.. autoclass:: GELU
+
+   
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+   
+   
+   
--- a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.GRU.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.GRU.rst
@@ -3,4 +3,14 @@

 .. currentmodule:: mlx.nn

-.. autoclass:: GRU
+.. autoclass:: GRU
+
+   
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+   
+   
+   
--- a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.GroupNorm.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.GroupNorm.rst
@@ -3,4 +3,14 @@

 .. currentmodule:: mlx.nn

-.. autoclass:: GroupNorm
+.. autoclass:: GroupNorm
+
+   
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+   
+   
+   
--- a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.InstanceNorm.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.InstanceNorm.rst
@@ -3,4 +3,14 @@

 .. currentmodule:: mlx.nn

-.. autoclass:: InstanceNorm
+.. autoclass:: InstanceNorm
+
+   
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+   
+   
+   
--- a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.LSTM.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.LSTM.rst
@@ -3,4 +3,14 @@

 .. currentmodule:: mlx.nn

-.. autoclass:: LSTM
+.. autoclass:: LSTM
+
+   
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+   
+   
+   
--- a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.LayerNorm.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.LayerNorm.rst
@@ -3,4 +3,14 @@

 .. currentmodule:: mlx.nn

-.. autoclass:: LayerNorm
+.. autoclass:: LayerNorm
+
+   
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+   
+   
+   
--- a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.Linear.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.Linear.rst
@@ -3,4 +3,14 @@

 .. currentmodule:: mlx.nn

-.. autoclass:: Linear
+.. autoclass:: Linear
+
+   
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+   
+   
+   
--- a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.MaxPool1d.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.MaxPool1d.rst
@@ -3,4 +3,14 @@

 .. currentmodule:: mlx.nn

-.. autoclass:: MaxPool1d
+.. autoclass:: MaxPool1d
+
+   
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+   
+   
+   
--- a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.MaxPool2d.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.MaxPool2d.rst
@@ -3,4 +3,14 @@

 .. currentmodule:: mlx.nn

-.. autoclass:: MaxPool2d
+.. autoclass:: MaxPool2d
+
+   
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+   
+   
+   
--- a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.Mish.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.Mish.rst
@@ -3,4 +3,14 @@

 .. currentmodule:: mlx.nn

-.. autoclass:: Mish
+.. autoclass:: Mish
+
+   
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+   
+   
+   
--- a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.MultiHeadAttention.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.MultiHeadAttention.rst
@@ -3,4 +3,15 @@

 .. currentmodule:: mlx.nn

-.. autoclass:: MultiHeadAttention
+.. autoclass:: MultiHeadAttention
+
+   
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+   
+         ~MultiHeadAttention.create_additive_causal_mask
+   
+   
--- a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.PReLU.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.PReLU.rst
@@ -3,4 +3,14 @@

 .. currentmodule:: mlx.nn

-.. autoclass:: PReLU
+.. autoclass:: PReLU
+
+   
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+   
+   
+   
--- a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.QuantizedEmbedding.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.QuantizedEmbedding.rst
@@ -0,0 +1,18 @@
+mlx.nn.QuantizedEmbedding
+=========================
+
+.. currentmodule:: mlx.nn
+
+.. autoclass:: QuantizedEmbedding
+
+   
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+   
+         ~QuantizedEmbedding.as_linear
+         ~QuantizedEmbedding.from_embedding
+   
+   
--- a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.QuantizedLinear.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.QuantizedLinear.rst
@@ -3,4 +3,16 @@

 .. currentmodule:: mlx.nn

-.. autoclass:: QuantizedLinear
+.. autoclass:: QuantizedLinear
+
+   
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+   
+         ~QuantizedLinear.from_linear
+         ~QuantizedLinear.unfreeze
+   
+   
--- a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.RMSNorm.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.RMSNorm.rst
@@ -3,4 +3,14 @@

 .. currentmodule:: mlx.nn

-.. autoclass:: RMSNorm
+.. autoclass:: RMSNorm
+
+   
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+   
+   
+   
--- a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.RNN.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.RNN.rst
@@ -3,4 +3,14 @@

 .. currentmodule:: mlx.nn

-.. autoclass:: RNN
+.. autoclass:: RNN
+
+   
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+   
+   
+   
--- a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.ReLU.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.ReLU.rst
@@ -3,4 +3,14 @@

 .. currentmodule:: mlx.nn

-.. autoclass:: ReLU
+.. autoclass:: ReLU
+
+   
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+   
+   
+   
--- a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.RoPE.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.RoPE.rst
@@ -3,4 +3,14 @@

 .. currentmodule:: mlx.nn

-.. autoclass:: RoPE
+.. autoclass:: RoPE
+
+   
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+   
+   
+   
--- a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.SELU.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.SELU.rst
@@ -3,4 +3,14 @@

 .. currentmodule:: mlx.nn

-.. autoclass:: SELU
+.. autoclass:: SELU
+
+   
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+   
+   
+   
--- a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.Sequential.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.Sequential.rst
@@ -3,4 +3,14 @@

 .. currentmodule:: mlx.nn

-.. autoclass:: Sequential
+.. autoclass:: Sequential
+
+   
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+   
+   
+   
--- a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.SiLU.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.SiLU.rst
@@ -3,4 +3,14 @@

 .. currentmodule:: mlx.nn

-.. autoclass:: SiLU
+.. autoclass:: SiLU
+
+   
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+   
+   
+   
--- a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.SinusoidalPositionalEncoding.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.SinusoidalPositionalEncoding.rst
@@ -3,4 +3,14 @@

 .. currentmodule:: mlx.nn

-.. autoclass:: SinusoidalPositionalEncoding
+.. autoclass:: SinusoidalPositionalEncoding
+
+   
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+   
+   
+   
--- a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.Softshrink.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.Softshrink.rst
@@ -3,4 +3,14 @@

 .. currentmodule:: mlx.nn

-.. autoclass:: Softshrink
+.. autoclass:: Softshrink
+
+   
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+   
+   
+   
--- a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.Step.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.Step.rst
@@ -3,4 +3,14 @@

 .. currentmodule:: mlx.nn

-.. autoclass:: Step
+.. autoclass:: Step
+
+   
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+   
+   
+   
--- a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.Transformer.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.Transformer.rst
@@ -3,4 +3,14 @@

 .. currentmodule:: mlx.nn

-.. autoclass:: Transformer
+.. autoclass:: Transformer
+
+   
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+   
+   
+   
--- a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.Upsample.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.Upsample.rst
@@ -3,4 +3,14 @@

 .. currentmodule:: mlx.nn

-.. autoclass:: Upsample
+.. autoclass:: Upsample
+
+   
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+   
+   
+