docs update

2025-09-19 19:38:16 +08:00 · 2024-02-08 12:44:23 -08:00
parent 06b6d9a4d4
commit e492638dff
437 changed files with 11568 additions and 13689 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,6 +3,4 @@

 .. currentmodule:: mlx.nn

-.. autoclass:: ALiBi
-
-   
+.. autoclass:: ALiBi
--- 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,6 +3,4 @@

 .. currentmodule:: mlx.nn

-.. autoclass:: BatchNorm
-
-   
+.. autoclass:: BatchNorm
--- 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,6 +3,4 @@

 .. currentmodule:: mlx.nn

-.. autoclass:: Conv1d
-
-   
+.. 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
@@ -3,6 +3,4 @@

 .. currentmodule:: mlx.nn

-.. autoclass:: Conv2d
-
-   
+.. autoclass:: Conv2d
--- 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,6 +3,4 @@

 .. currentmodule:: mlx.nn

-.. autoclass:: Dropout
-
-   
+.. autoclass:: Dropout
--- 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,6 +3,4 @@

 .. currentmodule:: mlx.nn

-.. autoclass:: Dropout2d
-
-   
+.. autoclass:: Dropout2d
--- 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,6 +3,4 @@

 .. currentmodule:: mlx.nn

-.. autoclass:: Dropout3d
-
-   
+.. autoclass:: Dropout3d
--- 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,6 +3,4 @@

 .. currentmodule:: mlx.nn

-.. autoclass:: Embedding
-
-   
+.. 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
@@ -3,6 +3,4 @@

 .. currentmodule:: mlx.nn

-.. autoclass:: GELU
-
-   
+.. 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
@@ -3,6 +3,4 @@

 .. currentmodule:: mlx.nn

-.. autoclass:: GroupNorm
-
-   
+.. autoclass:: GroupNorm
--- 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,6 +3,4 @@

 .. currentmodule:: mlx.nn

-.. autoclass:: InstanceNorm
-
-   
+.. autoclass:: InstanceNorm
--- 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,6 +3,4 @@

 .. currentmodule:: mlx.nn

-.. autoclass:: LayerNorm
-
-   
+.. 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
@@ -3,6 +3,4 @@

 .. currentmodule:: mlx.nn

-.. autoclass:: Linear
-
-   
+.. 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
@@ -3,6 +3,4 @@

 .. currentmodule:: mlx.nn

-.. autoclass:: Mish
-
-   
+.. autoclass:: Mish
--- a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.Module.state.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.Module.state.rst
@@ -0,0 +1,6 @@
+mlx.nn.Module.state
+===================
+
+.. currentmodule:: mlx.nn
+
+.. autoproperty:: Module.state
--- 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,6 +3,4 @@

 .. currentmodule:: mlx.nn

-.. autoclass:: MultiHeadAttention
-
-   
+.. 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
@@ -3,6 +3,4 @@

 .. currentmodule:: mlx.nn

-.. autoclass:: PReLU
-
-   
+.. autoclass:: PReLU
--- 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,6 +3,4 @@

 .. currentmodule:: mlx.nn

-.. autoclass:: QuantizedLinear
-
-   
+.. autoclass:: QuantizedLinear
--- 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,6 +3,4 @@

 .. currentmodule:: mlx.nn

-.. autoclass:: RMSNorm
-
-   
+.. 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
@@ -3,6 +3,4 @@

 .. currentmodule:: mlx.nn

-.. autoclass:: ReLU
-
-   
+.. 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
@@ -3,6 +3,4 @@

 .. currentmodule:: mlx.nn

-.. autoclass:: RoPE
-
-   
+.. 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
@@ -3,6 +3,4 @@

 .. currentmodule:: mlx.nn

-.. autoclass:: SELU
-
-   
+.. 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
@@ -3,6 +3,4 @@

 .. currentmodule:: mlx.nn

-.. autoclass:: Sequential
-
-   
+.. 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
@@ -3,6 +3,4 @@

 .. currentmodule:: mlx.nn

-.. autoclass:: SiLU
-
-   
+.. autoclass:: SiLU
--- 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,6 +3,4 @@

 .. currentmodule:: mlx.nn

-.. autoclass:: SinusoidalPositionalEncoding
-
-   
+.. autoclass:: SinusoidalPositionalEncoding
--- 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,6 +3,4 @@

 .. currentmodule:: mlx.nn

-.. autoclass:: Softshrink
-
-   
+.. autoclass:: Softshrink
--- 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,6 +3,4 @@

 .. currentmodule:: mlx.nn

-.. autoclass:: Step
-
-   
+.. autoclass:: Step
--- 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,6 +3,4 @@

 .. currentmodule:: mlx.nn

-.. autoclass:: Transformer
-
-   
+.. autoclass:: Transformer