docs update

This commit is contained in:
Awni Hannun
2024-06-06 20:28:06 -07:00
committed by CircleCI Docs
parent 2360620475
commit ba4eff9520
2046 changed files with 323202 additions and 2319 deletions

View File

@@ -55,6 +55,7 @@
~array.tolist
~array.transpose
~array.var
~array.view

View File

@@ -1,6 +0,0 @@
mlx.core.block\_sparse\_mm
==========================
.. currentmodule:: mlx.core
.. autofunction:: block_sparse_mm

View File

@@ -0,0 +1,25 @@
mlx.core.distributed.Group
==========================
.. currentmodule:: mlx.core.distributed
.. autoclass:: Group
.. automethod:: __init__
.. rubric:: Methods
.. autosummary::
~Group.__init__
~Group.rank
~Group.size
~Group.split

View File

@@ -0,0 +1,6 @@
mlx.core.distributed.all\_gather
================================
.. currentmodule:: mlx.core.distributed
.. autofunction:: all_gather

View File

@@ -0,0 +1,6 @@
mlx.core.distributed.all\_sum
=============================
.. currentmodule:: mlx.core.distributed
.. autofunction:: all_sum

View File

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

View File

@@ -0,0 +1,6 @@
mlx.core.distributed.is\_available
==================================
.. currentmodule:: mlx.core.distributed
.. autofunction:: is_available

View File

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

View File

@@ -0,0 +1,19 @@
.. _distributed:
.. currentmodule:: mlx.core.distributed
Distributed Communication
==========================
MLX provides a distributed communication package using MPI. The MPI library is
loaded at runtime; if MPI is available then distributed communication is also
made available.
.. autosummary::
:toctree: _autosummary
Group
is_available
init
all_sum
all_gather

View File

@@ -0,0 +1,16 @@
mlx.nn.GLU
==========
.. currentmodule:: mlx.nn
.. autoclass:: GLU
.. rubric:: Methods
.. autosummary::

View File

@@ -0,0 +1,16 @@
mlx.nn.HardShrink
=================
.. currentmodule:: mlx.nn
.. autoclass:: HardShrink
.. rubric:: Methods
.. autosummary::

View File

@@ -0,0 +1,16 @@
mlx.nn.HardTanh
===============
.. currentmodule:: mlx.nn
.. autoclass:: HardTanh
.. rubric:: Methods
.. autosummary::

View File

@@ -0,0 +1,16 @@
mlx.nn.Hardswish
================
.. currentmodule:: mlx.nn
.. autoclass:: Hardswish
.. rubric:: Methods
.. autosummary::

View File

@@ -0,0 +1,16 @@
mlx.nn.LeakyReLU
================
.. currentmodule:: mlx.nn
.. autoclass:: LeakyReLU
.. rubric:: Methods
.. autosummary::

View File

@@ -0,0 +1,16 @@
mlx.nn.ReLU6
============
.. currentmodule:: mlx.nn
.. autoclass:: ReLU6
.. rubric:: Methods
.. autosummary::

View File

@@ -0,0 +1,16 @@
mlx.nn.Softmax
==============
.. currentmodule:: mlx.nn
.. autoclass:: Softmax
.. rubric:: Methods
.. autosummary::

View File

@@ -0,0 +1,16 @@
mlx.nn.Softmin
==============
.. currentmodule:: mlx.nn
.. autoclass:: Softmin
.. rubric:: Methods
.. autosummary::

View File

@@ -0,0 +1,16 @@
mlx.nn.Softplus
===============
.. currentmodule:: mlx.nn
.. autoclass:: Softplus
.. rubric:: Methods
.. autosummary::

View File

@@ -0,0 +1,16 @@
mlx.nn.Softsign
===============
.. currentmodule:: mlx.nn
.. autoclass:: Softsign
.. rubric:: Methods
.. autosummary::

View File

@@ -0,0 +1,16 @@
mlx.nn.Tanh
===========
.. currentmodule:: mlx.nn
.. autoclass:: Tanh
.. rubric:: Methods
.. autosummary::

View File

@@ -0,0 +1,11 @@
mlx.nn.hard\_shrink
===================
.. currentmodule:: mlx.nn
.. autoclass:: hard_shrink

View File

@@ -0,0 +1,11 @@
mlx.nn.hard\_tanh
=================
.. currentmodule:: mlx.nn
.. autoclass:: hard_tanh

View File

@@ -0,0 +1,11 @@
mlx.nn.softmin
==============
.. currentmodule:: mlx.nn
.. autoclass:: softmin

View File

@@ -17,6 +17,8 @@ simple functions.
gelu_approx
gelu_fast_approx
glu
hard_shrink
hard_tanh
hardswish
leaky_relu
log_sigmoid
@@ -29,6 +31,7 @@ simple functions.
sigmoid
silu
softmax
softmin
softplus
softshrink
step

View File

@@ -21,10 +21,15 @@ Layers
Dropout3d
Embedding
GELU
GLU
GroupNorm
GRU
HardShrink
HardTanh
Hardswish
InstanceNorm
LayerNorm
LeakyReLU
Linear
LSTM
MaxPool1d
@@ -36,13 +41,19 @@ Layers
QuantizedLinear
RMSNorm
ReLU
ReLU6
RNN
RoPE
SELU
Sequential
SiLU
SinusoidalPositionalEncoding
Softmin
Softshrink
Softsign
Softmax
Softplus
Step
Tanh
Transformer
Upsample

View File

@@ -156,6 +156,7 @@ Operations
tril
triu
var
view
where
zeros
zeros_like