update docs

This commit is contained in:
Awni Hannun
2023-12-13 14:46:24 -08:00
committed by CircleCI Docs
parent af2c3689fe
commit f75712551d
241 changed files with 15049 additions and 737 deletions

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@@ -0,0 +1,8 @@
mlx.nn.losses.binary\_cross\_entropy
====================================
.. currentmodule:: mlx.nn.losses
.. autoclass:: binary_cross_entropy

View File

@@ -0,0 +1,8 @@
mlx.nn.losses.cross\_entropy
============================
.. currentmodule:: mlx.nn.losses
.. autoclass:: cross_entropy

View File

@@ -0,0 +1,8 @@
mlx.nn.losses.kl\_div\_loss
===========================
.. currentmodule:: mlx.nn.losses
.. autoclass:: kl_div_loss

View File

@@ -0,0 +1,8 @@
mlx.nn.losses.l1\_loss
======================
.. currentmodule:: mlx.nn.losses
.. autoclass:: l1_loss

View File

@@ -0,0 +1,8 @@
mlx.nn.losses.mse\_loss
=======================
.. currentmodule:: mlx.nn.losses
.. autoclass:: mse_loss

View File

@@ -0,0 +1,8 @@
mlx.nn.losses.nll\_loss
=======================
.. currentmodule:: mlx.nn.losses
.. autoclass:: nll_loss

View File

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

View File

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

View File

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

View File

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

View File

@@ -97,7 +97,7 @@ Updating the parameters
MLX modules allow accessing and updating individual parameters. However, most
times we need to update large subsets of a module's parameters. This action is
performed by :meth:`Module.update`.
performed by :meth:`Module.update`.
Value and grad
--------------
@@ -146,8 +146,12 @@ Neural Network Layers
Embedding
ReLU
PReLU
GELU
SiLU
Step
SELU
Mish
Linear
Conv1d
Conv2d
@@ -169,4 +173,22 @@ simple functions.
gelu_approx
gelu_fast_approx
relu
prelu
silu
step
selu
mish
Loss Functions
--------------
.. autosummary::
:toctree: _autosummary_functions
:template: nn-module-template.rst
losses.cross_entropy
losses.binary_cross_entropy
losses.l1_loss
losses.mse_loss
losses.nll_loss
losses.kl_div_loss

View File

@@ -38,9 +38,11 @@ Operations
erfinv
exp
expand_dims
eye
full
greater
greater_equal
identity
less
less_equal
load