docs update

This commit is contained in:
Awni Hannun
2024-01-03 20:14:05 -08:00
committed by CircleCI Docs
parent 8bea0a4eb8
commit d03b91923e
330 changed files with 40495 additions and 3726 deletions

View File

@@ -0,0 +1,8 @@
mlx.nn.ALiBi
============
.. currentmodule:: mlx.nn
.. autoclass:: ALiBi

View File

@@ -0,0 +1,8 @@
mlx.nn.BatchNorm
================
.. currentmodule:: mlx.nn
.. autoclass:: BatchNorm

View File

@@ -0,0 +1,8 @@
mlx.nn.Dropout
==============
.. currentmodule:: mlx.nn
.. autoclass:: Dropout

View File

@@ -0,0 +1,8 @@
mlx.nn.Dropout2d
================
.. currentmodule:: mlx.nn
.. autoclass:: Dropout2d

View File

@@ -0,0 +1,8 @@
mlx.nn.Dropout3d
================
.. currentmodule:: mlx.nn
.. autoclass:: Dropout3d

View File

@@ -0,0 +1,8 @@
mlx.nn.InstanceNorm
===================
.. currentmodule:: mlx.nn
.. autoclass:: InstanceNorm

View File

@@ -0,0 +1,6 @@
mlx.nn.Module.apply
===================
.. currentmodule:: mlx.nn
.. automethod:: Module.apply

View File

@@ -0,0 +1,6 @@
mlx.nn.Module.apply\_to\_modules
================================
.. currentmodule:: mlx.nn
.. automethod:: Module.apply_to_modules

View File

@@ -0,0 +1,6 @@
mlx.nn.Module.children
======================
.. currentmodule:: mlx.nn
.. automethod:: Module.children

View File

@@ -0,0 +1,6 @@
mlx.nn.Module.eval
==================
.. currentmodule:: mlx.nn
.. automethod:: Module.eval

View File

@@ -0,0 +1,6 @@
mlx.nn.Module.filter\_and\_map
==============================
.. currentmodule:: mlx.nn
.. automethod:: Module.filter_and_map

View File

@@ -0,0 +1,6 @@
mlx.nn.Module.freeze
====================
.. currentmodule:: mlx.nn
.. automethod:: Module.freeze

View File

@@ -0,0 +1,6 @@
mlx.nn.Module.leaf\_modules
===========================
.. currentmodule:: mlx.nn
.. automethod:: Module.leaf_modules

View File

@@ -0,0 +1,6 @@
mlx.nn.Module.load\_weights
===========================
.. currentmodule:: mlx.nn
.. automethod:: Module.load_weights

View File

@@ -0,0 +1,6 @@
mlx.nn.Module.modules
=====================
.. currentmodule:: mlx.nn
.. automethod:: Module.modules

View File

@@ -0,0 +1,6 @@
mlx.nn.Module.named\_modules
============================
.. currentmodule:: mlx.nn
.. automethod:: Module.named_modules

View File

@@ -0,0 +1,6 @@
mlx.nn.Module.parameters
========================
.. currentmodule:: mlx.nn
.. automethod:: Module.parameters

View File

@@ -0,0 +1,6 @@
mlx.nn.Module.save\_weights
===========================
.. currentmodule:: mlx.nn
.. automethod:: Module.save_weights

View File

@@ -0,0 +1,6 @@
mlx.nn.Module.train
===================
.. currentmodule:: mlx.nn
.. automethod:: Module.train

View File

@@ -0,0 +1,6 @@
mlx.nn.Module.trainable\_parameters
===================================
.. currentmodule:: mlx.nn
.. automethod:: Module.trainable_parameters

View File

@@ -0,0 +1,6 @@
mlx.nn.Module.training
======================
.. currentmodule:: mlx.nn
.. autoproperty:: Module.training

View File

@@ -0,0 +1,6 @@
mlx.nn.Module.unfreeze
======================
.. currentmodule:: mlx.nn
.. automethod:: Module.unfreeze

View File

@@ -0,0 +1,6 @@
mlx.nn.Module.update
====================
.. currentmodule:: mlx.nn
.. automethod:: Module.update

View File

@@ -0,0 +1,6 @@
mlx.nn.Module.update\_modules
=============================
.. currentmodule:: mlx.nn
.. automethod:: Module.update_modules

View File

@@ -0,0 +1,8 @@
mlx.nn.SinusoidalPositionalEncoding
===================================
.. currentmodule:: mlx.nn
.. autoclass:: SinusoidalPositionalEncoding

View File

@@ -0,0 +1,8 @@
mlx.nn.Transformer
==================
.. currentmodule:: mlx.nn
.. autoclass:: Transformer

View File

@@ -0,0 +1,8 @@
mlx.nn.losses.hinge\_loss
=========================
.. currentmodule:: mlx.nn.losses
.. autoclass:: hinge_loss

View File

@@ -0,0 +1,8 @@
mlx.nn.losses.huber\_loss
=========================
.. currentmodule:: mlx.nn.losses
.. autoclass:: huber_loss

View File

@@ -0,0 +1,8 @@
mlx.nn.losses.log\_cosh\_loss
=============================
.. currentmodule:: mlx.nn.losses
.. autoclass:: log_cosh_loss

View File

@@ -9,7 +9,7 @@ Layers
:toctree: _autosummary
:template: nn-module-template.rst
Embedding
Sequential
ReLU
PReLU
GELU
@@ -17,13 +17,21 @@ Layers
Step
SELU
Mish
Embedding
Linear
QuantizedLinear
Conv1d
Conv2d
BatchNorm
LayerNorm
RMSNorm
GroupNorm
RoPE
InstanceNorm
Dropout
Dropout2d
Dropout3d
Transformer
MultiHeadAttention
Sequential
QuantizedLinear
ALiBi
RoPE
SinusoidalPositionalEncoding

View File

@@ -16,4 +16,7 @@ Loss Functions
mse_loss
nll_loss
smooth_l1_loss
triplet_loss
triplet_loss
hinge_loss
huber_loss
log_cosh_loss

View File

@@ -0,0 +1,36 @@
Module
======
.. currentmodule:: mlx.nn
.. autoclass:: Module
.. rubric:: Attributes
.. autosummary::
:toctree: _autosummary
Module.training
.. rubric:: Methods
.. autosummary::
:toctree: _autosummary
Module.apply
Module.apply_to_modules
Module.children
Module.eval
Module.filter_and_map
Module.freeze
Module.leaf_modules
Module.load_weights
Module.modules
Module.named_modules
Module.parameters
Module.save_weights
Module.train
Module.trainable_parameters
Module.unfreeze
Module.update
Module.update_modules