docs update

This commit is contained in:
Awni Hannun
2024-02-17 13:25:37 -08:00
committed by CircleCI Docs
parent 9c44222630
commit fdf4088123
371 changed files with 32812 additions and 6257 deletions

View File

@@ -0,0 +1,19 @@
mlx.optimizers.AdaDelta
=======================
.. currentmodule:: mlx.optimizers
.. autoclass:: AdaDelta
.. rubric:: Methods
.. autosummary::
~AdaDelta.__init__
~AdaDelta.apply_single
~AdaDelta.init_single

View File

@@ -0,0 +1,19 @@
mlx.optimizers.Adafactor
========================
.. currentmodule:: mlx.optimizers
.. autoclass:: Adafactor
.. rubric:: Methods
.. autosummary::
~Adafactor.__init__
~Adafactor.apply_single
~Adafactor.init_single

View File

@@ -0,0 +1,19 @@
mlx.optimizers.Adagrad
======================
.. currentmodule:: mlx.optimizers
.. autoclass:: Adagrad
.. rubric:: Methods
.. autosummary::
~Adagrad.__init__
~Adagrad.apply_single
~Adagrad.init_single

View File

@@ -0,0 +1,19 @@
mlx.optimizers.Adam
===================
.. currentmodule:: mlx.optimizers
.. autoclass:: Adam
.. rubric:: Methods
.. autosummary::
~Adam.__init__
~Adam.apply_single
~Adam.init_single

View File

@@ -0,0 +1,18 @@
mlx.optimizers.AdamW
====================
.. currentmodule:: mlx.optimizers
.. autoclass:: AdamW
.. rubric:: Methods
.. autosummary::
~AdamW.__init__
~AdamW.apply_single

View File

@@ -0,0 +1,19 @@
mlx.optimizers.Adamax
=====================
.. currentmodule:: mlx.optimizers
.. autoclass:: Adamax
.. rubric:: Methods
.. autosummary::
~Adamax.__init__
~Adamax.apply_single
~Adamax.init_single

View File

@@ -0,0 +1,19 @@
mlx.optimizers.Lion
===================
.. currentmodule:: mlx.optimizers
.. autoclass:: Lion
.. rubric:: Methods
.. autosummary::
~Lion.__init__
~Lion.apply_single
~Lion.init_single

View File

@@ -0,0 +1,6 @@
mlx.optimizers.Optimizer.apply\_gradients
=========================================
.. currentmodule:: mlx.optimizers
.. automethod:: Optimizer.apply_gradients

View File

@@ -0,0 +1,6 @@
mlx.optimizers.Optimizer.init
=============================
.. currentmodule:: mlx.optimizers
.. automethod:: Optimizer.init

View File

@@ -0,0 +1,6 @@
mlx.optimizers.Optimizer.state
==============================
.. currentmodule:: mlx.optimizers
.. autoproperty:: Optimizer.state

View File

@@ -0,0 +1,6 @@
mlx.optimizers.Optimizer.update
===============================
.. currentmodule:: mlx.optimizers
.. automethod:: Optimizer.update

View File

@@ -0,0 +1,19 @@
mlx.optimizers.RMSprop
======================
.. currentmodule:: mlx.optimizers
.. autoclass:: RMSprop
.. rubric:: Methods
.. autosummary::
~RMSprop.__init__
~RMSprop.apply_single
~RMSprop.init_single

View File

@@ -0,0 +1,19 @@
mlx.optimizers.SGD
==================
.. currentmodule:: mlx.optimizers
.. autoclass:: SGD
.. rubric:: Methods
.. autosummary::
~SGD.__init__
~SGD.apply_single
~SGD.init_single

View File

@@ -0,0 +1,6 @@
mlx.optimizers.cosine\_decay
============================
.. currentmodule:: mlx.optimizers
.. autofunction:: cosine_decay

View File

@@ -0,0 +1,6 @@
mlx.optimizers.exponential\_decay
=================================
.. currentmodule:: mlx.optimizers
.. autofunction:: exponential_decay

View File

@@ -0,0 +1,6 @@
mlx.optimizers.step\_decay
==========================
.. currentmodule:: mlx.optimizers
.. autofunction:: step_decay