diff --git a/docs/build/html/.buildinfo b/docs/build/html/.buildinfo index 63c9d0e41..e8163c948 100644 --- a/docs/build/html/.buildinfo +++ b/docs/build/html/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 177bbfa0562989b62a154f2dd1ab02a1 +config: 7192ed07ca0b377e57ed9f17cbd933a4 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/build/html/_sources/python/_autosummary/mlx.core.eye.rst b/docs/build/html/_sources/python/_autosummary/mlx.core.eye.rst new file mode 100644 index 000000000..8ef207ae5 --- /dev/null +++ b/docs/build/html/_sources/python/_autosummary/mlx.core.eye.rst @@ -0,0 +1,6 @@ +mlx.core.eye +============ + +.. currentmodule:: mlx.core + +.. autofunction:: eye \ No newline at end of file diff --git a/docs/build/html/_sources/python/_autosummary/mlx.core.identity.rst b/docs/build/html/_sources/python/_autosummary/mlx.core.identity.rst new file mode 100644 index 000000000..5f7a31cf8 --- /dev/null +++ b/docs/build/html/_sources/python/_autosummary/mlx.core.identity.rst @@ -0,0 +1,6 @@ +mlx.core.identity +================= + +.. currentmodule:: mlx.core + +.. autofunction:: identity \ No newline at end of file diff --git a/docs/build/html/_sources/python/_autosummary/mlx.nn.Mish.rst b/docs/build/html/_sources/python/_autosummary/mlx.nn.Mish.rst new file mode 100644 index 000000000..bf5397852 --- /dev/null +++ b/docs/build/html/_sources/python/_autosummary/mlx.nn.Mish.rst @@ -0,0 +1,8 @@ +mlx.nn.Mish +=========== + +.. currentmodule:: mlx.nn + +.. autoclass:: Mish + + \ No newline at end of file diff --git a/docs/build/html/_sources/python/_autosummary/mlx.nn.PReLU.rst b/docs/build/html/_sources/python/_autosummary/mlx.nn.PReLU.rst new file mode 100644 index 000000000..2de33a688 --- /dev/null +++ b/docs/build/html/_sources/python/_autosummary/mlx.nn.PReLU.rst @@ -0,0 +1,8 @@ +mlx.nn.PReLU +============ + +.. currentmodule:: mlx.nn + +.. autoclass:: PReLU + + \ No newline at end of file diff --git a/docs/build/html/_sources/python/_autosummary/mlx.nn.SELU.rst b/docs/build/html/_sources/python/_autosummary/mlx.nn.SELU.rst new file mode 100644 index 000000000..9fe57cdea --- /dev/null +++ b/docs/build/html/_sources/python/_autosummary/mlx.nn.SELU.rst @@ -0,0 +1,8 @@ +mlx.nn.SELU +=========== + +.. currentmodule:: mlx.nn + +.. autoclass:: SELU + + \ No newline at end of file diff --git a/docs/build/html/_sources/python/_autosummary/mlx.nn.Step.rst b/docs/build/html/_sources/python/_autosummary/mlx.nn.Step.rst new file mode 100644 index 000000000..688313628 --- /dev/null +++ b/docs/build/html/_sources/python/_autosummary/mlx.nn.Step.rst @@ -0,0 +1,8 @@ +mlx.nn.Step +=========== + +.. currentmodule:: mlx.nn + +.. autoclass:: Step + + \ No newline at end of file diff --git a/docs/build/html/_sources/python/_autosummary_functions/mlx.nn.losses.binary_cross_entropy.rst b/docs/build/html/_sources/python/_autosummary_functions/mlx.nn.losses.binary_cross_entropy.rst new file mode 100644 index 000000000..be553e4c0 --- /dev/null +++ b/docs/build/html/_sources/python/_autosummary_functions/mlx.nn.losses.binary_cross_entropy.rst @@ -0,0 +1,8 @@ +mlx.nn.losses.binary\_cross\_entropy +==================================== + +.. currentmodule:: mlx.nn.losses + +.. autoclass:: binary_cross_entropy + + \ No newline at end of file diff --git a/docs/build/html/_sources/python/_autosummary_functions/mlx.nn.losses.cross_entropy.rst b/docs/build/html/_sources/python/_autosummary_functions/mlx.nn.losses.cross_entropy.rst new file mode 100644 index 000000000..9c50fd349 --- /dev/null +++ b/docs/build/html/_sources/python/_autosummary_functions/mlx.nn.losses.cross_entropy.rst @@ -0,0 +1,8 @@ +mlx.nn.losses.cross\_entropy +============================ + +.. currentmodule:: mlx.nn.losses + +.. autoclass:: cross_entropy + + \ No newline at end of file diff --git a/docs/build/html/_sources/python/_autosummary_functions/mlx.nn.losses.kl_div_loss.rst b/docs/build/html/_sources/python/_autosummary_functions/mlx.nn.losses.kl_div_loss.rst new file mode 100644 index 000000000..11e070650 --- /dev/null +++ b/docs/build/html/_sources/python/_autosummary_functions/mlx.nn.losses.kl_div_loss.rst @@ -0,0 +1,8 @@ +mlx.nn.losses.kl\_div\_loss +=========================== + +.. currentmodule:: mlx.nn.losses + +.. autoclass:: kl_div_loss + + \ No newline at end of file diff --git a/docs/build/html/_sources/python/_autosummary_functions/mlx.nn.losses.l1_loss.rst b/docs/build/html/_sources/python/_autosummary_functions/mlx.nn.losses.l1_loss.rst new file mode 100644 index 000000000..34ae66d69 --- /dev/null +++ b/docs/build/html/_sources/python/_autosummary_functions/mlx.nn.losses.l1_loss.rst @@ -0,0 +1,8 @@ +mlx.nn.losses.l1\_loss +====================== + +.. currentmodule:: mlx.nn.losses + +.. autoclass:: l1_loss + + \ No newline at end of file diff --git a/docs/build/html/_sources/python/_autosummary_functions/mlx.nn.losses.mse_loss.rst b/docs/build/html/_sources/python/_autosummary_functions/mlx.nn.losses.mse_loss.rst new file mode 100644 index 000000000..534ed1e14 --- /dev/null +++ b/docs/build/html/_sources/python/_autosummary_functions/mlx.nn.losses.mse_loss.rst @@ -0,0 +1,8 @@ +mlx.nn.losses.mse\_loss +======================= + +.. currentmodule:: mlx.nn.losses + +.. autoclass:: mse_loss + + \ No newline at end of file diff --git a/docs/build/html/_sources/python/_autosummary_functions/mlx.nn.losses.nll_loss.rst b/docs/build/html/_sources/python/_autosummary_functions/mlx.nn.losses.nll_loss.rst new file mode 100644 index 000000000..c94eb82a1 --- /dev/null +++ b/docs/build/html/_sources/python/_autosummary_functions/mlx.nn.losses.nll_loss.rst @@ -0,0 +1,8 @@ +mlx.nn.losses.nll\_loss +======================= + +.. currentmodule:: mlx.nn.losses + +.. autoclass:: nll_loss + + \ No newline at end of file diff --git a/docs/build/html/_sources/python/_autosummary_functions/mlx.nn.mish.rst b/docs/build/html/_sources/python/_autosummary_functions/mlx.nn.mish.rst new file mode 100644 index 000000000..85bf0899b --- /dev/null +++ b/docs/build/html/_sources/python/_autosummary_functions/mlx.nn.mish.rst @@ -0,0 +1,8 @@ +mlx.nn.mish +=========== + +.. currentmodule:: mlx.nn + +.. autoclass:: mish + + \ No newline at end of file diff --git a/docs/build/html/_sources/python/_autosummary_functions/mlx.nn.prelu.rst b/docs/build/html/_sources/python/_autosummary_functions/mlx.nn.prelu.rst new file mode 100644 index 000000000..f3757c1c3 --- /dev/null +++ b/docs/build/html/_sources/python/_autosummary_functions/mlx.nn.prelu.rst @@ -0,0 +1,8 @@ +mlx.nn.prelu +============ + +.. currentmodule:: mlx.nn + +.. autoclass:: prelu + + \ No newline at end of file diff --git a/docs/build/html/_sources/python/_autosummary_functions/mlx.nn.selu.rst b/docs/build/html/_sources/python/_autosummary_functions/mlx.nn.selu.rst new file mode 100644 index 000000000..00c1d0923 --- /dev/null +++ b/docs/build/html/_sources/python/_autosummary_functions/mlx.nn.selu.rst @@ -0,0 +1,8 @@ +mlx.nn.selu +=========== + +.. currentmodule:: mlx.nn + +.. autoclass:: selu + + \ No newline at end of file diff --git a/docs/build/html/_sources/python/_autosummary_functions/mlx.nn.step.rst b/docs/build/html/_sources/python/_autosummary_functions/mlx.nn.step.rst new file mode 100644 index 000000000..1395bd012 --- /dev/null +++ b/docs/build/html/_sources/python/_autosummary_functions/mlx.nn.step.rst @@ -0,0 +1,8 @@ +mlx.nn.step +=========== + +.. currentmodule:: mlx.nn + +.. autoclass:: step + + \ No newline at end of file diff --git a/docs/build/html/_sources/python/nn.rst b/docs/build/html/_sources/python/nn.rst index 114fd8a90..93cfd8c78 100644 --- a/docs/build/html/_sources/python/nn.rst +++ b/docs/build/html/_sources/python/nn.rst @@ -97,7 +97,7 @@ Updating the parameters MLX modules allow accessing and updating individual parameters. However, most times we need to update large subsets of a module's parameters. This action is -performed by :meth:`Module.update`. +performed by :meth:`Module.update`. Value and grad -------------- @@ -146,8 +146,12 @@ Neural Network Layers Embedding ReLU + PReLU GELU SiLU + Step + SELU + Mish Linear Conv1d Conv2d @@ -169,4 +173,22 @@ simple functions. gelu_approx gelu_fast_approx relu + prelu silu + step + selu + mish + +Loss Functions +-------------- + +.. autosummary:: + :toctree: _autosummary_functions + :template: nn-module-template.rst + + losses.cross_entropy + losses.binary_cross_entropy + losses.l1_loss + losses.mse_loss + losses.nll_loss + losses.kl_div_loss diff --git a/docs/build/html/_sources/python/ops.rst b/docs/build/html/_sources/python/ops.rst index 450588536..b9a4c9066 100644 --- a/docs/build/html/_sources/python/ops.rst +++ b/docs/build/html/_sources/python/ops.rst @@ -38,9 +38,11 @@ Operations erfinv exp expand_dims + eye full greater greater_equal + identity less less_equal load diff --git a/docs/build/html/_sources/unified_memory.rst b/docs/build/html/_sources/unified_memory.rst index feb91d730..a53477d65 100644 --- a/docs/build/html/_sources/unified_memory.rst +++ b/docs/build/html/_sources/unified_memory.rst @@ -6,7 +6,7 @@ Unified Memory .. currentmodule:: mlx.core Apple silicon has a unified memory architecture. The CPU and GPU have direct -access to the same memory pool. MLX is designed to take advantage that. +access to the same memory pool. MLX is designed to take advantage of that. Concretely, when you make an array in MLX you don't have to specify its location: diff --git a/docs/build/html/_static/documentation_options.js b/docs/build/html/_static/documentation_options.js index f8f4859e3..0339f4d46 100644 --- a/docs/build/html/_static/documentation_options.js +++ b/docs/build/html/_static/documentation_options.js @@ -1,6 +1,6 @@ var DOCUMENTATION_OPTIONS = { URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), - VERSION: '0.0.4', + VERSION: '0.0.5', LANGUAGE: 'en', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/docs/build/html/cpp/ops.html b/docs/build/html/cpp/ops.html index 2167066d3..cd7666c91 100644 --- a/docs/build/html/cpp/ops.html +++ b/docs/build/html/cpp/ops.html @@ -9,7 +9,7 @@ - Operations — MLX 0.0.4 documentation + Operations — MLX 0.0.5 documentation @@ -134,8 +134,8 @@ - MLX 0.0.4 documentation - Home - + MLX 0.0.5 documentation - Home + @@ -148,6 +148,7 @@

Usage

Examples

@@ -237,9 +238,11 @@
  • mlx.core.erfinv
  • mlx.core.exp
  • mlx.core.expand_dims
    • +
  • mlx.core.eye
  • mlx.core.full
  • mlx.core.greater
  • mlx.core.greater_equal
    • +
  • mlx.core.identity
  • mlx.core.less
  • mlx.core.less_equal
  • mlx.core.load
    • @@ -334,8 +337,12 @@
  • mlx.nn.value_and_grad
  • mlx.nn.Embedding
  • mlx.nn.ReLU
    • +
  • mlx.nn.PReLU
  • mlx.nn.GELU
  • mlx.nn.SiLU
    • +
  • mlx.nn.Step
    • +
  • mlx.nn.SELU
    • +
  • mlx.nn.Mish
  • mlx.nn.Linear
  • mlx.nn.Conv1d
  • mlx.nn.Conv2d
    • @@ -349,7 +356,17 @@
  • mlx.nn.gelu_approx
  • mlx.nn.gelu_fast_approx
  • mlx.nn.relu
    • +
  • mlx.nn.prelu
  • mlx.nn.silu
    • +
  • mlx.nn.step
    • +
  • mlx.nn.selu
    • +
  • mlx.nn.mish
    • +
  • mlx.nn.losses.cross_entropy
    • +
  • mlx.nn.losses.binary_cross_entropy
    • +
  • mlx.nn.losses.l1_loss
    • +
  • mlx.nn.losses.mse_loss
    • +
  • mlx.nn.losses.nll_loss
    • +
  • mlx.nn.losses.kl_div_loss
  • Optimizers
  • Optimizers
  • Optimizers
  • Optimizers
  • Optimizers
  • Optimizers @@ -630,10 +648,10 @@ document.write(`
  • conv1d() (in module mlx.core)
    • - - +
  • cosh() (in module mlx.core) +
    • +
  • cross_entropy (class in mlx.nn.losses)
    • @@ -691,6 +711,8 @@ document.write(`
  • expand_dims() (in module mlx.core) +
    • +
  • eye() (in module mlx.core)
    • @@ -744,6 +766,8 @@ document.write(`

    I