docs

docs/build/html/_sources/python/_autosummary/mlx.core.array.rst

@@ -26,6 +26,7 @@
       ~array.cumprod
       ~array.cumsum
       ~array.exp
+      ~array.flatten
       ~array.item
       ~array.log
       ~array.log10
@@ -35,6 +36,7 @@
       ~array.max
       ~array.mean
       ~array.min
+      ~array.moveaxis
       ~array.prod
       ~array.reciprocal
       ~array.reshape
@@ -45,6 +47,7 @@
       ~array.square
       ~array.squeeze
       ~array.sum
+      ~array.swapaxes
       ~array.tolist
       ~array.transpose
       ~array.var

docs/build/html/_sources/python/_autosummary/mlx.core.ceil.rst

@@ -0,0 +1,6 @@
+mlx.core.ceil
+=============
+
+.. currentmodule:: mlx.core
+
+.. autofunction:: ceil

docs/build/html/_sources/python/_autosummary/mlx.core.flatten.rst

@@ -0,0 +1,6 @@
+mlx.core.flatten
+================
+
+.. currentmodule:: mlx.core
+
+.. autofunction:: flatten

docs/build/html/_sources/python/_autosummary/mlx.core.floor.rst

@@ -0,0 +1,6 @@
+mlx.core.floor
+==============
+
+.. currentmodule:: mlx.core
+
+.. autofunction:: floor

docs/build/html/_sources/python/_autosummary/mlx.core.moveaxis.rst

@@ -0,0 +1,6 @@
+mlx.core.moveaxis
+=================
+
+.. currentmodule:: mlx.core
+
+.. autofunction:: moveaxis

docs/build/html/_sources/python/_autosummary/mlx.core.simplify.rst

@@ -0,0 +1,6 @@
+mlx.core.simplify
+=================
+
+.. currentmodule:: mlx.core
+
+.. autofunction:: simplify

docs/build/html/_sources/python/_autosummary/mlx.core.stack.rst

@@ -0,0 +1,6 @@
+mlx.core.stack
+==============
+
+.. currentmodule:: mlx.core
+
+.. autofunction:: stack

docs/build/html/_sources/python/_autosummary/mlx.core.swapaxes.rst

@@ -0,0 +1,6 @@
+mlx.core.swapaxes
+=================
+
+.. currentmodule:: mlx.core
+
+.. autofunction:: swapaxes

docs/build/html/_sources/python/_autosummary/mlx.core.tri.rst

@@ -0,0 +1,6 @@
+mlx.core.tri
+============
+
+.. currentmodule:: mlx.core
+
+.. autofunction:: tri

docs/build/html/_sources/python/_autosummary/mlx.core.tril.rst

@@ -0,0 +1,6 @@
+mlx.core.tril
+=============
+
+.. currentmodule:: mlx.core
+
+.. autofunction:: tril

docs/build/html/_sources/python/_autosummary/mlx.core.triu.rst

@@ -0,0 +1,6 @@
+mlx.core.triu
+=============
+
+.. currentmodule:: mlx.core
+
+.. autofunction:: triu

docs/build/html/_sources/python/_autosummary/mlx.nn.Conv1d.rst

@@ -1,8 +0,0 @@
-mlx.nn.Conv1d
-=============
-
-.. currentmodule:: mlx.nn
-
-.. autoclass:: Conv1d
-
-   

docs/build/html/_sources/python/_autosummary/mlx.nn.Conv2d.rst

@@ -1,8 +0,0 @@
-mlx.nn.Conv2d
-=============
-
-.. currentmodule:: mlx.nn
-
-.. autoclass:: Conv2d
-
-   

docs/build/html/_sources/python/_autosummary/mlx.nn.Embedding.rst

@@ -1,8 +0,0 @@
-mlx.nn.Embedding
-================
-
-.. currentmodule:: mlx.nn
-
-.. autoclass:: Embedding
-
-   

docs/build/html/_sources/python/_autosummary/mlx.nn.GELU.rst

@@ -1,8 +0,0 @@
-mlx.nn.GELU
-===========
-
-.. currentmodule:: mlx.nn
-
-.. autoclass:: GELU
-
-   

docs/build/html/_sources/python/_autosummary/mlx.nn.GroupNorm.rst

@@ -1,8 +0,0 @@
-mlx.nn.GroupNorm
-================
-
-.. currentmodule:: mlx.nn
-
-.. autoclass:: GroupNorm
-
-   

docs/build/html/_sources/python/_autosummary/mlx.nn.LayerNorm.rst

@@ -1,8 +0,0 @@
-mlx.nn.LayerNorm
-================
-
-.. currentmodule:: mlx.nn
-
-.. autoclass:: LayerNorm
-
-   

docs/build/html/_sources/python/_autosummary/mlx.nn.Linear.rst

@@ -1,8 +0,0 @@
-mlx.nn.Linear
-=============
-
-.. currentmodule:: mlx.nn
-
-.. autoclass:: Linear
-
-   

docs/build/html/_sources/python/_autosummary/mlx.nn.Mish.rst

@@ -1,8 +0,0 @@
-mlx.nn.Mish
-===========
-
-.. currentmodule:: mlx.nn
-
-.. autoclass:: Mish
-
-   

docs/build/html/_sources/python/_autosummary/mlx.nn.Module.rst

@@ -0,0 +1,58 @@
+mlx.nn.Module
+=============
+
+.. currentmodule:: mlx.nn
+
+.. autoclass:: Module
+
+   
+   .. automethod:: __init__
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+   
+      ~Module.__init__
+      ~Module.apply
+      ~Module.apply_to_modules
+      ~Module.children
+      ~Module.clear
+      ~Module.copy
+      ~Module.eval
+      ~Module.filter_and_map
+      ~Module.freeze
+      ~Module.fromkeys
+      ~Module.get
+      ~Module.is_module
+      ~Module.items
+      ~Module.keys
+      ~Module.leaf_modules
+      ~Module.load_weights
+      ~Module.modules
+      ~Module.named_modules
+      ~Module.parameters
+      ~Module.pop
+      ~Module.popitem
+      ~Module.save_weights
+      ~Module.setdefault
+      ~Module.train
+      ~Module.trainable_parameter_filter
+      ~Module.trainable_parameters
+      ~Module.unfreeze
+      ~Module.update
+      ~Module.valid_child_filter
+      ~Module.valid_parameter_filter
+      ~Module.values
+   
+   
+
+   
+   
+   .. rubric:: Attributes
+
+   .. autosummary::
+   
+      ~Module.training
+   
+   

docs/build/html/_sources/python/_autosummary/mlx.nn.MultiHeadAttention.rst

@@ -1,8 +0,0 @@
-mlx.nn.MultiHeadAttention
-=========================
-
-.. currentmodule:: mlx.nn
-
-.. autoclass:: MultiHeadAttention
-
-   

docs/build/html/_sources/python/_autosummary/mlx.nn.PReLU.rst

@@ -1,8 +0,0 @@
-mlx.nn.PReLU
-============
-
-.. currentmodule:: mlx.nn
-
-.. autoclass:: PReLU
-
-   

docs/build/html/_sources/python/_autosummary/mlx.nn.RMSNorm.rst

@@ -1,8 +0,0 @@
-mlx.nn.RMSNorm
-==============
-
-.. currentmodule:: mlx.nn
-
-.. autoclass:: RMSNorm
-
-   

docs/build/html/_sources/python/_autosummary/mlx.nn.ReLU.rst

@@ -1,8 +0,0 @@
-mlx.nn.ReLU
-===========
-
-.. currentmodule:: mlx.nn
-
-.. autoclass:: ReLU
-
-   

docs/build/html/_sources/python/_autosummary/mlx.nn.RoPE.rst

@@ -1,8 +0,0 @@
-mlx.nn.RoPE
-===========
-
-.. currentmodule:: mlx.nn
-
-.. autoclass:: RoPE
-
-   

docs/build/html/_sources/python/_autosummary/mlx.nn.SELU.rst

@@ -1,8 +0,0 @@
-mlx.nn.SELU
-===========
-
-.. currentmodule:: mlx.nn
-
-.. autoclass:: SELU
-
-   

docs/build/html/_sources/python/_autosummary/mlx.nn.Sequential.rst

@@ -1,8 +0,0 @@
-mlx.nn.Sequential
-=================
-
-.. currentmodule:: mlx.nn
-
-.. autoclass:: Sequential
-
-   

docs/build/html/_sources/python/_autosummary/mlx.nn.SiLU.rst

@@ -1,8 +0,0 @@
-mlx.nn.SiLU
-===========
-
-.. currentmodule:: mlx.nn
-
-.. autoclass:: SiLU
-
-   

docs/build/html/_sources/python/_autosummary/mlx.nn.Step.rst

@@ -1,8 +0,0 @@
-mlx.nn.Step
-===========
-
-.. currentmodule:: mlx.nn
-
-.. autoclass:: Step
-
-   

docs/build/html/_sources/python/_autosummary/mlx.optimizers.AdaDelta.rst

@@ -0,0 +1,18 @@
+mlx.optimizers.AdaDelta
+=======================
+
+.. currentmodule:: mlx.optimizers
+
+.. autoclass:: AdaDelta
+
+   
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+   
+         ~AdaDelta.__init__
+         ~AdaDelta.apply_single
+   
+   

docs/build/html/_sources/python/_autosummary/mlx.optimizers.Adagrad.rst

@@ -0,0 +1,18 @@
+mlx.optimizers.Adagrad
+======================
+
+.. currentmodule:: mlx.optimizers
+
+.. autoclass:: Adagrad
+
+   
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+   
+         ~Adagrad.__init__
+         ~Adagrad.apply_single
+   
+   

docs/build/html/_sources/python/_autosummary/mlx.optimizers.AdamW.rst

@@ -0,0 +1,18 @@
+mlx.optimizers.AdamW
+====================
+
+.. currentmodule:: mlx.optimizers
+
+.. autoclass:: AdamW
+
+   
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+   
+         ~AdamW.__init__
+         ~AdamW.apply_single
+   
+   

docs/build/html/_sources/python/_autosummary/mlx.optimizers.Adamax.rst

@@ -0,0 +1,18 @@
+mlx.optimizers.Adamax
+=====================
+
+.. currentmodule:: mlx.optimizers
+
+.. autoclass:: Adamax
+
+   
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+   
+         ~Adamax.__init__
+         ~Adamax.apply_single
+   
+   

docs/build/html/_sources/python/_autosummary/mlx.optimizers.RMSprop.rst

@@ -0,0 +1,18 @@
+mlx.optimizers.RMSprop
+======================
+
+.. currentmodule:: mlx.optimizers
+
+.. autoclass:: RMSprop
+
+   
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+   
+         ~RMSprop.__init__
+         ~RMSprop.apply_single
+   
+