mirror of
https://github.com/ml-explore/mlx.git
synced 2025-09-18 10:26:56 +08:00
update docs
This commit is contained in:

committed by
CircleCI Docs

parent
af2c3689fe
commit
f75712551d
6
docs/build/html/_sources/python/_autosummary/mlx.core.eye.rst
vendored
Normal file
6
docs/build/html/_sources/python/_autosummary/mlx.core.eye.rst
vendored
Normal file
@@ -0,0 +1,6 @@
|
||||
mlx.core.eye
|
||||
============
|
||||
|
||||
.. currentmodule:: mlx.core
|
||||
|
||||
.. autofunction:: eye
|
6
docs/build/html/_sources/python/_autosummary/mlx.core.identity.rst
vendored
Normal file
6
docs/build/html/_sources/python/_autosummary/mlx.core.identity.rst
vendored
Normal file
@@ -0,0 +1,6 @@
|
||||
mlx.core.identity
|
||||
=================
|
||||
|
||||
.. currentmodule:: mlx.core
|
||||
|
||||
.. autofunction:: identity
|
8
docs/build/html/_sources/python/_autosummary/mlx.nn.Mish.rst
vendored
Normal file
8
docs/build/html/_sources/python/_autosummary/mlx.nn.Mish.rst
vendored
Normal file
@@ -0,0 +1,8 @@
|
||||
mlx.nn.Mish
|
||||
===========
|
||||
|
||||
.. currentmodule:: mlx.nn
|
||||
|
||||
.. autoclass:: Mish
|
||||
|
||||
|
8
docs/build/html/_sources/python/_autosummary/mlx.nn.PReLU.rst
vendored
Normal file
8
docs/build/html/_sources/python/_autosummary/mlx.nn.PReLU.rst
vendored
Normal file
@@ -0,0 +1,8 @@
|
||||
mlx.nn.PReLU
|
||||
============
|
||||
|
||||
.. currentmodule:: mlx.nn
|
||||
|
||||
.. autoclass:: PReLU
|
||||
|
||||
|
8
docs/build/html/_sources/python/_autosummary/mlx.nn.SELU.rst
vendored
Normal file
8
docs/build/html/_sources/python/_autosummary/mlx.nn.SELU.rst
vendored
Normal file
@@ -0,0 +1,8 @@
|
||||
mlx.nn.SELU
|
||||
===========
|
||||
|
||||
.. currentmodule:: mlx.nn
|
||||
|
||||
.. autoclass:: SELU
|
||||
|
||||
|
8
docs/build/html/_sources/python/_autosummary/mlx.nn.Step.rst
vendored
Normal file
8
docs/build/html/_sources/python/_autosummary/mlx.nn.Step.rst
vendored
Normal file
@@ -0,0 +1,8 @@
|
||||
mlx.nn.Step
|
||||
===========
|
||||
|
||||
.. currentmodule:: mlx.nn
|
||||
|
||||
.. autoclass:: Step
|
||||
|
||||
|
@@ -0,0 +1,8 @@
|
||||
mlx.nn.losses.binary\_cross\_entropy
|
||||
====================================
|
||||
|
||||
.. currentmodule:: mlx.nn.losses
|
||||
|
||||
.. autoclass:: binary_cross_entropy
|
||||
|
||||
|
8
docs/build/html/_sources/python/_autosummary_functions/mlx.nn.losses.cross_entropy.rst
vendored
Normal file
8
docs/build/html/_sources/python/_autosummary_functions/mlx.nn.losses.cross_entropy.rst
vendored
Normal file
@@ -0,0 +1,8 @@
|
||||
mlx.nn.losses.cross\_entropy
|
||||
============================
|
||||
|
||||
.. currentmodule:: mlx.nn.losses
|
||||
|
||||
.. autoclass:: cross_entropy
|
||||
|
||||
|
8
docs/build/html/_sources/python/_autosummary_functions/mlx.nn.losses.kl_div_loss.rst
vendored
Normal file
8
docs/build/html/_sources/python/_autosummary_functions/mlx.nn.losses.kl_div_loss.rst
vendored
Normal file
@@ -0,0 +1,8 @@
|
||||
mlx.nn.losses.kl\_div\_loss
|
||||
===========================
|
||||
|
||||
.. currentmodule:: mlx.nn.losses
|
||||
|
||||
.. autoclass:: kl_div_loss
|
||||
|
||||
|
8
docs/build/html/_sources/python/_autosummary_functions/mlx.nn.losses.l1_loss.rst
vendored
Normal file
8
docs/build/html/_sources/python/_autosummary_functions/mlx.nn.losses.l1_loss.rst
vendored
Normal file
@@ -0,0 +1,8 @@
|
||||
mlx.nn.losses.l1\_loss
|
||||
======================
|
||||
|
||||
.. currentmodule:: mlx.nn.losses
|
||||
|
||||
.. autoclass:: l1_loss
|
||||
|
||||
|
8
docs/build/html/_sources/python/_autosummary_functions/mlx.nn.losses.mse_loss.rst
vendored
Normal file
8
docs/build/html/_sources/python/_autosummary_functions/mlx.nn.losses.mse_loss.rst
vendored
Normal file
@@ -0,0 +1,8 @@
|
||||
mlx.nn.losses.mse\_loss
|
||||
=======================
|
||||
|
||||
.. currentmodule:: mlx.nn.losses
|
||||
|
||||
.. autoclass:: mse_loss
|
||||
|
||||
|
8
docs/build/html/_sources/python/_autosummary_functions/mlx.nn.losses.nll_loss.rst
vendored
Normal file
8
docs/build/html/_sources/python/_autosummary_functions/mlx.nn.losses.nll_loss.rst
vendored
Normal file
@@ -0,0 +1,8 @@
|
||||
mlx.nn.losses.nll\_loss
|
||||
=======================
|
||||
|
||||
.. currentmodule:: mlx.nn.losses
|
||||
|
||||
.. autoclass:: nll_loss
|
||||
|
||||
|
8
docs/build/html/_sources/python/_autosummary_functions/mlx.nn.mish.rst
vendored
Normal file
8
docs/build/html/_sources/python/_autosummary_functions/mlx.nn.mish.rst
vendored
Normal file
@@ -0,0 +1,8 @@
|
||||
mlx.nn.mish
|
||||
===========
|
||||
|
||||
.. currentmodule:: mlx.nn
|
||||
|
||||
.. autoclass:: mish
|
||||
|
||||
|
8
docs/build/html/_sources/python/_autosummary_functions/mlx.nn.prelu.rst
vendored
Normal file
8
docs/build/html/_sources/python/_autosummary_functions/mlx.nn.prelu.rst
vendored
Normal file
@@ -0,0 +1,8 @@
|
||||
mlx.nn.prelu
|
||||
============
|
||||
|
||||
.. currentmodule:: mlx.nn
|
||||
|
||||
.. autoclass:: prelu
|
||||
|
||||
|
8
docs/build/html/_sources/python/_autosummary_functions/mlx.nn.selu.rst
vendored
Normal file
8
docs/build/html/_sources/python/_autosummary_functions/mlx.nn.selu.rst
vendored
Normal file
@@ -0,0 +1,8 @@
|
||||
mlx.nn.selu
|
||||
===========
|
||||
|
||||
.. currentmodule:: mlx.nn
|
||||
|
||||
.. autoclass:: selu
|
||||
|
||||
|
8
docs/build/html/_sources/python/_autosummary_functions/mlx.nn.step.rst
vendored
Normal file
8
docs/build/html/_sources/python/_autosummary_functions/mlx.nn.step.rst
vendored
Normal file
@@ -0,0 +1,8 @@
|
||||
mlx.nn.step
|
||||
===========
|
||||
|
||||
.. currentmodule:: mlx.nn
|
||||
|
||||
.. autoclass:: step
|
||||
|
||||
|
24
docs/build/html/_sources/python/nn.rst
vendored
24
docs/build/html/_sources/python/nn.rst
vendored
@@ -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
|
||||
|
2
docs/build/html/_sources/python/ops.rst
vendored
2
docs/build/html/_sources/python/ops.rst
vendored
@@ -38,9 +38,11 @@ Operations
|
||||
erfinv
|
||||
exp
|
||||
expand_dims
|
||||
eye
|
||||
full
|
||||
greater
|
||||
greater_equal
|
||||
identity
|
||||
less
|
||||
less_equal
|
||||
load
|
||||
|
Reference in New Issue
Block a user