mlx/docs/src/python/nn/layers.rst

.. _layers:

.. currentmodule:: mlx.nn

Layers
------

.. autosummary::
   :toctree: _autosummary
   :template: nn-module-template.rst

   ALiBi
   AvgPool1d
   AvgPool2d
   BatchNorm
   Conv1d
   Conv2d
   Dropout
   Dropout2d
   Dropout3d
   Embedding
   GELU
   GroupNorm
   GRU
   InstanceNorm
   LayerNorm
   Linear
   LSTM
   MaxPool1d
   MaxPool2d
   Mish
   MultiHeadAttention
   PReLU
   QuantizedEmbedding
   QuantizedLinear
   RMSNorm
   ReLU
   RNN
   RoPE
   SELU
   Sequential
   SiLU
   SinusoidalPositionalEncoding
   Softshrink
   Step
   Transformer
   Upsample
Docs updates (#198) Reorganize NN docs + a few other tidbits. 2023-12-18 05:20:55 +08:00			`.. _layers:`

			`.. currentmodule:: mlx.nn`

			`Layers`
			`------`

			`.. autosummary::`
			`:toctree: _autosummary`
			`:template: nn-module-template.rst`

Sort some APIs docs by names (a-z) (#472) 2024-01-17 11:37:50 +08:00			`ALiBi`
Pooling layers (#357) Co-authored-by: Angelos Katharopoulos <a_katharopoulos@apple.com> Co-authored-by: Awni Hannun <awni@apple.com> 2024-02-13 14:08:13 +08:00			`AvgPool1d`
			`AvgPool2d`
Sort some APIs docs by names (a-z) (#472) 2024-01-17 11:37:50 +08:00			`BatchNorm`
Docs updates (#198) Reorganize NN docs + a few other tidbits. 2023-12-18 05:20:55 +08:00			`Conv1d`
			`Conv2d`
Add dropout2d (#250) 2023-12-23 00:02:29 +08:00			`Dropout`
			`Dropout2d`
feat: Add Dropout3d layer to nn.layers (#313) * feat: Add Dropout3d layer to nn.layers * acknowledgement * Add dropout tests to test_nn.py * run pre-commit * Add activation functions and dropout3d ops * Add dropout tests for bfloat16 and float16 2024-01-01 06:01:21 +08:00			`Dropout3d`
Sort some APIs docs by names (a-z) (#472) 2024-01-17 11:37:50 +08:00			`Embedding`
			`GELU`
			`GroupNorm`
Implement RNN, GRU, LSTM (#268) * RNN base implementation * Address comments+format * nits in docs * add tests for prb * fix test * add a couple tests --------- Co-authored-by: Awni Hannun <awni@apple.com> 2024-03-12 12:14:44 +08:00			`GRU`
Sort some APIs docs by names (a-z) (#472) 2024-01-17 11:37:50 +08:00			`InstanceNorm`
			`LayerNorm`
			`Linear`
Implement RNN, GRU, LSTM (#268) * RNN base implementation * Address comments+format * nits in docs * add tests for prb * fix test * add a couple tests --------- Co-authored-by: Awni Hannun <awni@apple.com> 2024-03-12 12:14:44 +08:00			`LSTM`
Pooling layers (#357) Co-authored-by: Angelos Katharopoulos <a_katharopoulos@apple.com> Co-authored-by: Awni Hannun <awni@apple.com> 2024-02-13 14:08:13 +08:00			`MaxPool1d`
			`MaxPool2d`
Sort some APIs docs by names (a-z) (#472) 2024-01-17 11:37:50 +08:00			`Mish`
Transformer fix (#167) * add transformer with dropout, fix transformer ffm, layernorm order * precommit changes * precommit changes * add docstring, activation, norm_first * run precommit * run precommit * add doctstring * precommit * style nits in docs --------- Co-authored-by: junwoo-yun <junwoo.yun@bagelcode.com> Co-authored-by: Awni Hannun <awni@apple.com> 2023-12-28 00:48:36 +08:00			`MultiHeadAttention`
Sort some APIs docs by names (a-z) (#472) 2024-01-17 11:37:50 +08:00			`PReLU`
Quantize embedding (#994) * quantize embedding * rename as_linear + comment * consistency in docs * fix test 2024-04-16 07:42:10 +08:00			`QuantizedEmbedding`
Sort some APIs docs by names (a-z) (#472) 2024-01-17 11:37:50 +08:00			`QuantizedLinear`
			`RMSNorm`
			`ReLU`
Implement RNN, GRU, LSTM (#268) * RNN base implementation * Address comments+format * nits in docs * add tests for prb * fix test * add a couple tests --------- Co-authored-by: Awni Hannun <awni@apple.com> 2024-03-12 12:14:44 +08:00			`RNN`
Transformer fix (#167) * add transformer with dropout, fix transformer ffm, layernorm order * precommit changes * precommit changes * add docstring, activation, norm_first * run precommit * run precommit * add doctstring * precommit * style nits in docs --------- Co-authored-by: junwoo-yun <junwoo.yun@bagelcode.com> Co-authored-by: Awni Hannun <awni@apple.com> 2023-12-28 00:48:36 +08:00			`RoPE`
Sort some APIs docs by names (a-z) (#472) 2024-01-17 11:37:50 +08:00			`SELU`
			`Sequential`
			`SiLU`
Transformer fix (#167) * add transformer with dropout, fix transformer ffm, layernorm order * precommit changes * precommit changes * add docstring, activation, norm_first * run precommit * run precommit * add doctstring * precommit * style nits in docs --------- Co-authored-by: junwoo-yun <junwoo.yun@bagelcode.com> Co-authored-by: Awni Hannun <awni@apple.com> 2023-12-28 00:48:36 +08:00			`SinusoidalPositionalEncoding`
Softshrink mapping + op (#552) * Added Softshrink mapping + op * formatting * docs + nits in docstring --------- Co-authored-by: Awni Hannun <awni@apple.com> 2024-01-31 04:56:28 +08:00			`Softshrink`
Sort some APIs docs by names (a-z) (#472) 2024-01-17 11:37:50 +08:00			`Step`
			`Transformer`
Quantize embedding (#994) * quantize embedding * rename as_linear + comment * consistency in docs * fix test 2024-04-16 07:42:10 +08:00			`Upsample`