docs update

This commit is contained in:
Awni Hannun
2024-05-10 08:49:36 -07:00
committed by CircleCI Docs
parent f946f689a6
commit 3e724a7c98
1835 changed files with 274325 additions and 2256 deletions

View File

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

View File

@@ -20,6 +20,7 @@
~array.argmax
~array.argmin
~array.astype
~array.conj
~array.cos
~array.cummax
~array.cummin

View File

@@ -0,0 +1,6 @@
mlx.core.bitwise\_and
=====================
.. currentmodule:: mlx.core
.. autofunction:: bitwise_and

View File

@@ -0,0 +1,6 @@
mlx.core.bitwise\_or
====================
.. currentmodule:: mlx.core
.. autofunction:: bitwise_or

View File

@@ -0,0 +1,6 @@
mlx.core.bitwise\_xor
=====================
.. currentmodule:: mlx.core
.. autofunction:: bitwise_xor

View File

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

View File

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

View File

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

View File

@@ -0,0 +1,6 @@
mlx.core.left\_shift
====================
.. currentmodule:: mlx.core
.. autofunction:: left_shift

View File

@@ -0,0 +1,6 @@
mlx.core.metal.device\_info
===========================
.. currentmodule:: mlx.core.metal
.. autofunction:: device_info

View File

@@ -0,0 +1,6 @@
mlx.core.metal.reset\_peak\_memory
==================================
.. currentmodule:: mlx.core.metal
.. autofunction:: reset_peak_memory

View File

@@ -0,0 +1,6 @@
mlx.core.right\_shift
=====================
.. currentmodule:: mlx.core
.. autofunction:: right_shift

View File

@@ -0,0 +1,6 @@
mlx.optimizers.clip\_grad\_norm
===============================
.. currentmodule:: mlx.optimizers
.. autofunction:: clip_grad_norm

View File

@@ -0,0 +1,6 @@
mlx.utils.tree\_reduce
======================
.. currentmodule:: mlx.utils
.. autofunction:: tree_reduce

View File

@@ -7,8 +7,10 @@ Metal
:toctree: _autosummary
is_available
device_info
get_active_memory
get_peak_memory
reset_peak_memory
get_cache_memory
set_memory_limit
set_cache_limit

View File

@@ -19,6 +19,7 @@ Operations
arcsin
arcsinh
arctan
arctan2
arctanh
argmax
argmin
@@ -28,11 +29,17 @@ Operations
atleast_1d
atleast_2d
atleast_3d
broadcast_to
bitwise_and
bitwise_or
bitwise_xor
block_masked_mm
block_sparse_mm
broadcast_to
ceil
clip
concatenate
conj
conjugate
convolve
conv1d
conv2d
@@ -69,6 +76,7 @@ Operations
isnan
isneginf
isposinf
left_shift
less
less_equal
linspace
@@ -105,6 +113,7 @@ Operations
reciprocal
repeat
reshape
right_shift
round
rsqrt
save

View File

@@ -1,5 +1,7 @@
.. _optimizers:
.. currentmodule:: mlx.optimizers
Optimizers
==========
@@ -34,3 +36,8 @@ model's parameters and the **optimizer state**.
optimizers/optimizer
optimizers/common_optimizers
optimizers/schedulers
.. autosummary::
:toctree: _autosummary
clip_grad_norm

View File

@@ -20,3 +20,4 @@ return python trees will be using the default python ``dict``, ``list`` and
tree_unflatten
tree_map
tree_map_with_path
tree_reduce