mirror of
https://github.com/ml-explore/mlx.git
synced 2025-09-22 21:48:08 +08:00
docs update
This commit is contained in:

committed by
CircleCI Docs

parent
2360620475
commit
ba4eff9520
@@ -55,6 +55,7 @@
|
||||
~array.tolist
|
||||
~array.transpose
|
||||
~array.var
|
||||
~array.view
|
||||
|
||||
|
||||
|
||||
|
@@ -1,6 +0,0 @@
|
||||
mlx.core.block\_sparse\_mm
|
||||
==========================
|
||||
|
||||
.. currentmodule:: mlx.core
|
||||
|
||||
.. autofunction:: block_sparse_mm
|
25
docs/build/html/_sources/python/_autosummary/mlx.core.distributed.Group.rst
vendored
Normal file
25
docs/build/html/_sources/python/_autosummary/mlx.core.distributed.Group.rst
vendored
Normal 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
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
6
docs/build/html/_sources/python/_autosummary/mlx.core.distributed.all_gather.rst
vendored
Normal file
6
docs/build/html/_sources/python/_autosummary/mlx.core.distributed.all_gather.rst
vendored
Normal file
@@ -0,0 +1,6 @@
|
||||
mlx.core.distributed.all\_gather
|
||||
================================
|
||||
|
||||
.. currentmodule:: mlx.core.distributed
|
||||
|
||||
.. autofunction:: all_gather
|
6
docs/build/html/_sources/python/_autosummary/mlx.core.distributed.all_sum.rst
vendored
Normal file
6
docs/build/html/_sources/python/_autosummary/mlx.core.distributed.all_sum.rst
vendored
Normal file
@@ -0,0 +1,6 @@
|
||||
mlx.core.distributed.all\_sum
|
||||
=============================
|
||||
|
||||
.. currentmodule:: mlx.core.distributed
|
||||
|
||||
.. autofunction:: all_sum
|
6
docs/build/html/_sources/python/_autosummary/mlx.core.distributed.init.rst
vendored
Normal file
6
docs/build/html/_sources/python/_autosummary/mlx.core.distributed.init.rst
vendored
Normal file
@@ -0,0 +1,6 @@
|
||||
mlx.core.distributed.init
|
||||
=========================
|
||||
|
||||
.. currentmodule:: mlx.core.distributed
|
||||
|
||||
.. autofunction:: init
|
6
docs/build/html/_sources/python/_autosummary/mlx.core.distributed.is_available.rst
vendored
Normal file
6
docs/build/html/_sources/python/_autosummary/mlx.core.distributed.is_available.rst
vendored
Normal file
@@ -0,0 +1,6 @@
|
||||
mlx.core.distributed.is\_available
|
||||
==================================
|
||||
|
||||
.. currentmodule:: mlx.core.distributed
|
||||
|
||||
.. autofunction:: is_available
|
6
docs/build/html/_sources/python/_autosummary/mlx.core.view.rst
vendored
Normal file
6
docs/build/html/_sources/python/_autosummary/mlx.core.view.rst
vendored
Normal file
@@ -0,0 +1,6 @@
|
||||
mlx.core.view
|
||||
=============
|
||||
|
||||
.. currentmodule:: mlx.core
|
||||
|
||||
.. autofunction:: view
|
19
docs/build/html/_sources/python/distributed.rst
vendored
Normal file
19
docs/build/html/_sources/python/distributed.rst
vendored
Normal 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
|
16
docs/build/html/_sources/python/nn/_autosummary/mlx.nn.GLU.rst
vendored
Normal file
16
docs/build/html/_sources/python/nn/_autosummary/mlx.nn.GLU.rst
vendored
Normal file
@@ -0,0 +1,16 @@
|
||||
mlx.nn.GLU
|
||||
==========
|
||||
|
||||
.. currentmodule:: mlx.nn
|
||||
|
||||
.. autoclass:: GLU
|
||||
|
||||
|
||||
|
||||
|
||||
.. rubric:: Methods
|
||||
|
||||
.. autosummary::
|
||||
|
||||
|
||||
|
16
docs/build/html/_sources/python/nn/_autosummary/mlx.nn.HardShrink.rst
vendored
Normal file
16
docs/build/html/_sources/python/nn/_autosummary/mlx.nn.HardShrink.rst
vendored
Normal file
@@ -0,0 +1,16 @@
|
||||
mlx.nn.HardShrink
|
||||
=================
|
||||
|
||||
.. currentmodule:: mlx.nn
|
||||
|
||||
.. autoclass:: HardShrink
|
||||
|
||||
|
||||
|
||||
|
||||
.. rubric:: Methods
|
||||
|
||||
.. autosummary::
|
||||
|
||||
|
||||
|
16
docs/build/html/_sources/python/nn/_autosummary/mlx.nn.HardTanh.rst
vendored
Normal file
16
docs/build/html/_sources/python/nn/_autosummary/mlx.nn.HardTanh.rst
vendored
Normal file
@@ -0,0 +1,16 @@
|
||||
mlx.nn.HardTanh
|
||||
===============
|
||||
|
||||
.. currentmodule:: mlx.nn
|
||||
|
||||
.. autoclass:: HardTanh
|
||||
|
||||
|
||||
|
||||
|
||||
.. rubric:: Methods
|
||||
|
||||
.. autosummary::
|
||||
|
||||
|
||||
|
16
docs/build/html/_sources/python/nn/_autosummary/mlx.nn.Hardswish.rst
vendored
Normal file
16
docs/build/html/_sources/python/nn/_autosummary/mlx.nn.Hardswish.rst
vendored
Normal file
@@ -0,0 +1,16 @@
|
||||
mlx.nn.Hardswish
|
||||
================
|
||||
|
||||
.. currentmodule:: mlx.nn
|
||||
|
||||
.. autoclass:: Hardswish
|
||||
|
||||
|
||||
|
||||
|
||||
.. rubric:: Methods
|
||||
|
||||
.. autosummary::
|
||||
|
||||
|
||||
|
16
docs/build/html/_sources/python/nn/_autosummary/mlx.nn.LeakyReLU.rst
vendored
Normal file
16
docs/build/html/_sources/python/nn/_autosummary/mlx.nn.LeakyReLU.rst
vendored
Normal file
@@ -0,0 +1,16 @@
|
||||
mlx.nn.LeakyReLU
|
||||
================
|
||||
|
||||
.. currentmodule:: mlx.nn
|
||||
|
||||
.. autoclass:: LeakyReLU
|
||||
|
||||
|
||||
|
||||
|
||||
.. rubric:: Methods
|
||||
|
||||
.. autosummary::
|
||||
|
||||
|
||||
|
16
docs/build/html/_sources/python/nn/_autosummary/mlx.nn.ReLU6.rst
vendored
Normal file
16
docs/build/html/_sources/python/nn/_autosummary/mlx.nn.ReLU6.rst
vendored
Normal file
@@ -0,0 +1,16 @@
|
||||
mlx.nn.ReLU6
|
||||
============
|
||||
|
||||
.. currentmodule:: mlx.nn
|
||||
|
||||
.. autoclass:: ReLU6
|
||||
|
||||
|
||||
|
||||
|
||||
.. rubric:: Methods
|
||||
|
||||
.. autosummary::
|
||||
|
||||
|
||||
|
16
docs/build/html/_sources/python/nn/_autosummary/mlx.nn.Softmax.rst
vendored
Normal file
16
docs/build/html/_sources/python/nn/_autosummary/mlx.nn.Softmax.rst
vendored
Normal file
@@ -0,0 +1,16 @@
|
||||
mlx.nn.Softmax
|
||||
==============
|
||||
|
||||
.. currentmodule:: mlx.nn
|
||||
|
||||
.. autoclass:: Softmax
|
||||
|
||||
|
||||
|
||||
|
||||
.. rubric:: Methods
|
||||
|
||||
.. autosummary::
|
||||
|
||||
|
||||
|
16
docs/build/html/_sources/python/nn/_autosummary/mlx.nn.Softmin.rst
vendored
Normal file
16
docs/build/html/_sources/python/nn/_autosummary/mlx.nn.Softmin.rst
vendored
Normal file
@@ -0,0 +1,16 @@
|
||||
mlx.nn.Softmin
|
||||
==============
|
||||
|
||||
.. currentmodule:: mlx.nn
|
||||
|
||||
.. autoclass:: Softmin
|
||||
|
||||
|
||||
|
||||
|
||||
.. rubric:: Methods
|
||||
|
||||
.. autosummary::
|
||||
|
||||
|
||||
|
16
docs/build/html/_sources/python/nn/_autosummary/mlx.nn.Softplus.rst
vendored
Normal file
16
docs/build/html/_sources/python/nn/_autosummary/mlx.nn.Softplus.rst
vendored
Normal file
@@ -0,0 +1,16 @@
|
||||
mlx.nn.Softplus
|
||||
===============
|
||||
|
||||
.. currentmodule:: mlx.nn
|
||||
|
||||
.. autoclass:: Softplus
|
||||
|
||||
|
||||
|
||||
|
||||
.. rubric:: Methods
|
||||
|
||||
.. autosummary::
|
||||
|
||||
|
||||
|
16
docs/build/html/_sources/python/nn/_autosummary/mlx.nn.Softsign.rst
vendored
Normal file
16
docs/build/html/_sources/python/nn/_autosummary/mlx.nn.Softsign.rst
vendored
Normal file
@@ -0,0 +1,16 @@
|
||||
mlx.nn.Softsign
|
||||
===============
|
||||
|
||||
.. currentmodule:: mlx.nn
|
||||
|
||||
.. autoclass:: Softsign
|
||||
|
||||
|
||||
|
||||
|
||||
.. rubric:: Methods
|
||||
|
||||
.. autosummary::
|
||||
|
||||
|
||||
|
16
docs/build/html/_sources/python/nn/_autosummary/mlx.nn.Tanh.rst
vendored
Normal file
16
docs/build/html/_sources/python/nn/_autosummary/mlx.nn.Tanh.rst
vendored
Normal file
@@ -0,0 +1,16 @@
|
||||
mlx.nn.Tanh
|
||||
===========
|
||||
|
||||
.. currentmodule:: mlx.nn
|
||||
|
||||
.. autoclass:: Tanh
|
||||
|
||||
|
||||
|
||||
|
||||
.. rubric:: Methods
|
||||
|
||||
.. autosummary::
|
||||
|
||||
|
||||
|
11
docs/build/html/_sources/python/nn/_autosummary_functions/mlx.nn.hard_shrink.rst
vendored
Normal file
11
docs/build/html/_sources/python/nn/_autosummary_functions/mlx.nn.hard_shrink.rst
vendored
Normal file
@@ -0,0 +1,11 @@
|
||||
mlx.nn.hard\_shrink
|
||||
===================
|
||||
|
||||
.. currentmodule:: mlx.nn
|
||||
|
||||
.. autoclass:: hard_shrink
|
||||
|
||||
|
||||
|
||||
|
||||
|
11
docs/build/html/_sources/python/nn/_autosummary_functions/mlx.nn.hard_tanh.rst
vendored
Normal file
11
docs/build/html/_sources/python/nn/_autosummary_functions/mlx.nn.hard_tanh.rst
vendored
Normal file
@@ -0,0 +1,11 @@
|
||||
mlx.nn.hard\_tanh
|
||||
=================
|
||||
|
||||
.. currentmodule:: mlx.nn
|
||||
|
||||
.. autoclass:: hard_tanh
|
||||
|
||||
|
||||
|
||||
|
||||
|
11
docs/build/html/_sources/python/nn/_autosummary_functions/mlx.nn.softmin.rst
vendored
Normal file
11
docs/build/html/_sources/python/nn/_autosummary_functions/mlx.nn.softmin.rst
vendored
Normal file
@@ -0,0 +1,11 @@
|
||||
mlx.nn.softmin
|
||||
==============
|
||||
|
||||
.. currentmodule:: mlx.nn
|
||||
|
||||
.. autoclass:: softmin
|
||||
|
||||
|
||||
|
||||
|
||||
|
@@ -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
|
||||
|
11
docs/build/html/_sources/python/nn/layers.rst
vendored
11
docs/build/html/_sources/python/nn/layers.rst
vendored
@@ -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
|
||||
|
1
docs/build/html/_sources/python/ops.rst
vendored
1
docs/build/html/_sources/python/ops.rst
vendored
@@ -156,6 +156,7 @@ Operations
|
||||
tril
|
||||
triu
|
||||
var
|
||||
view
|
||||
where
|
||||
zeros
|
||||
zeros_like
|
||||
|
Reference in New Issue
Block a user