From a6140fe550a4fcba327c0b1d98d9ad75f8f6f1a7 Mon Sep 17 00:00:00 2001 From: Awni Hannun Date: Wed, 13 Dec 2023 14:46:24 -0800 Subject: [PATCH] update docs --- docs/build/html/.buildinfo | 2 +- .../python/_autosummary/mlx.core.eye.rst | 6 + .../python/_autosummary/mlx.core.identity.rst | 6 + .../python/_autosummary/mlx.nn.Mish.rst | 8 + .../python/_autosummary/mlx.nn.PReLU.rst | 8 + .../python/_autosummary/mlx.nn.SELU.rst | 8 + .../python/_autosummary/mlx.nn.Step.rst | 8 + .../mlx.nn.losses.binary_cross_entropy.rst | 8 + .../mlx.nn.losses.cross_entropy.rst | 8 + .../mlx.nn.losses.kl_div_loss.rst | 8 + .../mlx.nn.losses.l1_loss.rst | 8 + .../mlx.nn.losses.mse_loss.rst | 8 + .../mlx.nn.losses.nll_loss.rst | 8 + .../_autosummary_functions/mlx.nn.mish.rst | 8 + .../_autosummary_functions/mlx.nn.prelu.rst | 8 + .../_autosummary_functions/mlx.nn.selu.rst | 8 + .../_autosummary_functions/mlx.nn.step.rst | 8 + docs/build/html/_sources/python/nn.rst | 24 +- docs/build/html/_sources/python/ops.rst | 2 + docs/build/html/_sources/unified_memory.rst | 2 +- .../html/_static/documentation_options.js | 2 +- docs/build/html/cpp/ops.html | 23 +- docs/build/html/dev/extensions.html | 23 +- .../html/examples/linear_regression.html | 23 +- docs/build/html/examples/llama-inference.html | 23 +- docs/build/html/examples/mlp.html | 23 +- docs/build/html/genindex.html | 70 +- docs/build/html/index.html | 22 +- docs/build/html/install.html | 23 +- docs/build/html/objects.inv | Bin 4625 -> 5020 bytes .../python/_autosummary/mlx.core.Device.html | 23 +- .../python/_autosummary/mlx.core.Dtype.html | 23 +- .../python/_autosummary/mlx.core.Stream.html | 23 +- .../python/_autosummary/mlx.core.abs.html | 23 +- .../python/_autosummary/mlx.core.add.html | 25 +- .../python/_autosummary/mlx.core.all.html | 23 +- .../_autosummary/mlx.core.allclose.html | 23 +- .../python/_autosummary/mlx.core.any.html | 23 +- .../python/_autosummary/mlx.core.arange.html | 23 +- .../python/_autosummary/mlx.core.arccos.html | 23 +- .../python/_autosummary/mlx.core.arccosh.html | 23 +- .../python/_autosummary/mlx.core.arcsin.html | 23 +- .../python/_autosummary/mlx.core.arcsinh.html | 23 +- .../python/_autosummary/mlx.core.arctan.html | 23 +- .../python/_autosummary/mlx.core.arctanh.html | 23 +- .../python/_autosummary/mlx.core.argmax.html | 25 +- .../python/_autosummary/mlx.core.argmin.html | 25 +- .../_autosummary/mlx.core.argpartition.html | 25 +- .../python/_autosummary/mlx.core.argsort.html | 25 +- .../python/_autosummary/mlx.core.array.T.html | 23 +- .../_autosummary/mlx.core.array.abs.html | 23 +- .../_autosummary/mlx.core.array.all.html | 23 +- .../_autosummary/mlx.core.array.any.html | 23 +- .../_autosummary/mlx.core.array.argmax.html | 23 +- .../_autosummary/mlx.core.array.argmin.html | 23 +- .../_autosummary/mlx.core.array.astype.html | 23 +- .../_autosummary/mlx.core.array.cos.html | 23 +- .../_autosummary/mlx.core.array.dtype.html | 23 +- .../_autosummary/mlx.core.array.exp.html | 23 +- .../python/_autosummary/mlx.core.array.html | 38 +- .../_autosummary/mlx.core.array.item.html | 23 +- .../_autosummary/mlx.core.array.log.html | 23 +- .../_autosummary/mlx.core.array.log1p.html | 23 +- .../mlx.core.array.logsumexp.html | 23 +- .../_autosummary/mlx.core.array.max.html | 23 +- .../_autosummary/mlx.core.array.mean.html | 23 +- .../_autosummary/mlx.core.array.min.html | 23 +- .../_autosummary/mlx.core.array.ndim.html | 23 +- .../_autosummary/mlx.core.array.prod.html | 23 +- .../mlx.core.array.reciprocal.html | 23 +- .../_autosummary/mlx.core.array.reshape.html | 23 +- .../_autosummary/mlx.core.array.rsqrt.html | 23 +- .../_autosummary/mlx.core.array.shape.html | 23 +- .../_autosummary/mlx.core.array.sin.html | 23 +- .../_autosummary/mlx.core.array.size.html | 23 +- .../_autosummary/mlx.core.array.split.html | 23 +- .../_autosummary/mlx.core.array.sqrt.html | 23 +- .../_autosummary/mlx.core.array.square.html | 23 +- .../_autosummary/mlx.core.array.sum.html | 23 +- .../_autosummary/mlx.core.array.tolist.html | 23 +- .../mlx.core.array.transpose.html | 23 +- .../_autosummary/mlx.core.array.var.html | 23 +- .../_autosummary/mlx.core.array_equal.html | 25 +- .../_autosummary/mlx.core.broadcast_to.html | 25 +- .../_autosummary/mlx.core.concatenate.html | 25 +- .../python/_autosummary/mlx.core.conv1d.html | 23 +- .../python/_autosummary/mlx.core.conv2d.html | 25 +- .../_autosummary/mlx.core.convolve.html | 23 +- .../python/_autosummary/mlx.core.cos.html | 23 +- .../python/_autosummary/mlx.core.cosh.html | 23 +- .../_autosummary/mlx.core.default_device.html | 23 +- .../_autosummary/mlx.core.default_stream.html | 23 +- .../python/_autosummary/mlx.core.divide.html | 25 +- .../python/_autosummary/mlx.core.equal.html | 25 +- .../python/_autosummary/mlx.core.erf.html | 23 +- .../python/_autosummary/mlx.core.erfinv.html | 23 +- .../python/_autosummary/mlx.core.eval.html | 23 +- .../python/_autosummary/mlx.core.exp.html | 23 +- .../_autosummary/mlx.core.expand_dims.html | 29 +- .../python/_autosummary/mlx.core.eye.html | 670 +++++++++++++++++ .../python/_autosummary/mlx.core.fft.fft.html | 23 +- .../_autosummary/mlx.core.fft.fft2.html | 23 +- .../_autosummary/mlx.core.fft.fftn.html | 23 +- .../_autosummary/mlx.core.fft.ifft.html | 23 +- .../_autosummary/mlx.core.fft.ifft2.html | 23 +- .../_autosummary/mlx.core.fft.ifftn.html | 23 +- .../_autosummary/mlx.core.fft.irfft.html | 23 +- .../_autosummary/mlx.core.fft.irfft2.html | 23 +- .../_autosummary/mlx.core.fft.irfftn.html | 23 +- .../_autosummary/mlx.core.fft.rfft.html | 23 +- .../_autosummary/mlx.core.fft.rfft2.html | 23 +- .../_autosummary/mlx.core.fft.rfftn.html | 23 +- .../python/_autosummary/mlx.core.full.html | 31 +- .../python/_autosummary/mlx.core.grad.html | 23 +- .../python/_autosummary/mlx.core.greater.html | 25 +- .../_autosummary/mlx.core.greater_equal.html | 31 +- .../_autosummary/mlx.core.identity.html | 668 +++++++++++++++++ .../python/_autosummary/mlx.core.jvp.html | 23 +- .../python/_autosummary/mlx.core.less.html | 31 +- .../_autosummary/mlx.core.less_equal.html | 25 +- .../python/_autosummary/mlx.core.load.html | 25 +- .../python/_autosummary/mlx.core.log.html | 23 +- .../python/_autosummary/mlx.core.log10.html | 23 +- .../python/_autosummary/mlx.core.log1p.html | 23 +- .../python/_autosummary/mlx.core.log2.html | 23 +- .../_autosummary/mlx.core.logaddexp.html | 25 +- .../_autosummary/mlx.core.logical_not.html | 25 +- .../_autosummary/mlx.core.logsumexp.html | 23 +- .../python/_autosummary/mlx.core.matmul.html | 23 +- .../python/_autosummary/mlx.core.max.html | 23 +- .../python/_autosummary/mlx.core.maximum.html | 25 +- .../python/_autosummary/mlx.core.mean.html | 23 +- .../python/_autosummary/mlx.core.min.html | 23 +- .../python/_autosummary/mlx.core.minimum.html | 25 +- .../_autosummary/mlx.core.multiply.html | 25 +- .../_autosummary/mlx.core.negative.html | 23 +- .../_autosummary/mlx.core.new_stream.html | 23 +- .../python/_autosummary/mlx.core.ones.html | 23 +- .../_autosummary/mlx.core.ones_like.html | 23 +- .../python/_autosummary/mlx.core.pad.html | 25 +- .../_autosummary/mlx.core.partition.html | 25 +- .../python/_autosummary/mlx.core.prod.html | 23 +- .../mlx.core.random.bernoulli.html | 25 +- .../mlx.core.random.categorical.html | 23 +- .../_autosummary/mlx.core.random.gumbel.html | 25 +- .../_autosummary/mlx.core.random.key.html | 23 +- .../_autosummary/mlx.core.random.normal.html | 25 +- .../_autosummary/mlx.core.random.randint.html | 25 +- .../_autosummary/mlx.core.random.seed.html | 23 +- .../_autosummary/mlx.core.random.split.html | 23 +- .../mlx.core.random.truncated_normal.html | 25 +- .../_autosummary/mlx.core.random.uniform.html | 25 +- .../_autosummary/mlx.core.reciprocal.html | 23 +- .../python/_autosummary/mlx.core.reshape.html | 23 +- .../python/_autosummary/mlx.core.rsqrt.html | 23 +- .../python/_autosummary/mlx.core.save.html | 25 +- .../python/_autosummary/mlx.core.savez.html | 25 +- .../mlx.core.savez_compressed.html | 25 +- .../mlx.core.set_default_device.html | 23 +- .../mlx.core.set_default_stream.html | 23 +- .../python/_autosummary/mlx.core.sigmoid.html | 23 +- .../python/_autosummary/mlx.core.sign.html | 23 +- .../python/_autosummary/mlx.core.sin.html | 23 +- .../python/_autosummary/mlx.core.sinh.html | 23 +- .../python/_autosummary/mlx.core.softmax.html | 23 +- .../python/_autosummary/mlx.core.sort.html | 25 +- .../python/_autosummary/mlx.core.split.html | 25 +- .../python/_autosummary/mlx.core.sqrt.html | 23 +- .../python/_autosummary/mlx.core.square.html | 23 +- .../python/_autosummary/mlx.core.squeeze.html | 23 +- .../_autosummary/mlx.core.stop_gradient.html | 23 +- .../_autosummary/mlx.core.subtract.html | 25 +- .../python/_autosummary/mlx.core.sum.html | 25 +- .../python/_autosummary/mlx.core.take.html | 23 +- .../mlx.core.take_along_axis.html | 25 +- .../python/_autosummary/mlx.core.tan.html | 23 +- .../python/_autosummary/mlx.core.tanh.html | 23 +- .../_autosummary/mlx.core.transpose.html | 23 +- .../_autosummary/mlx.core.value_and_grad.html | 23 +- .../python/_autosummary/mlx.core.var.html | 23 +- .../python/_autosummary/mlx.core.vjp.html | 23 +- .../python/_autosummary/mlx.core.vmap.html | 23 +- .../python/_autosummary/mlx.core.where.html | 25 +- .../python/_autosummary/mlx.core.zeros.html | 23 +- .../_autosummary/mlx.core.zeros_like.html | 23 +- .../python/_autosummary/mlx.nn.Conv1d.html | 23 +- .../python/_autosummary/mlx.nn.Conv2d.html | 25 +- .../python/_autosummary/mlx.nn.Embedding.html | 23 +- .../html/python/_autosummary/mlx.nn.GELU.html | 29 +- .../python/_autosummary/mlx.nn.GroupNorm.html | 23 +- .../python/_autosummary/mlx.nn.LayerNorm.html | 23 +- .../python/_autosummary/mlx.nn.Linear.html | 29 +- .../html/python/_autosummary/mlx.nn.Mish.html | 658 +++++++++++++++++ .../mlx.nn.MultiHeadAttention.html | 27 +- .../python/_autosummary/mlx.nn.PReLU.html | 652 +++++++++++++++++ .../python/_autosummary/mlx.nn.RMSNorm.html | 23 +- .../html/python/_autosummary/mlx.nn.ReLU.html | 29 +- .../html/python/_autosummary/mlx.nn.RoPE.html | 23 +- .../html/python/_autosummary/mlx.nn.SELU.html | 661 +++++++++++++++++ .../_autosummary/mlx.nn.Sequential.html | 23 +- .../html/python/_autosummary/mlx.nn.SiLU.html | 31 +- .../html/python/_autosummary/mlx.nn.Step.html | 666 +++++++++++++++++ .../_autosummary/mlx.nn.value_and_grad.html | 23 +- .../_autosummary/mlx.optimizers.Adam.html | 23 +- .../mlx.optimizers.Optimizer.html | 23 +- .../mlx.optimizers.OptimizerState.html | 23 +- .../_autosummary/mlx.optimizers.SGD.html | 34 +- .../_autosummary/mlx.utils.tree_flatten.html | 23 +- .../_autosummary/mlx.utils.tree_map.html | 23 +- .../mlx.utils.tree_unflatten.html | 23 +- .../_autosummary_functions/mlx.nn.gelu.html | 25 +- .../mlx.nn.gelu_approx.html | 23 +- .../mlx.nn.gelu_fast_approx.html | 23 +- .../mlx.nn.losses.binary_cross_entropy.html | 679 ++++++++++++++++++ .../mlx.nn.losses.cross_entropy.html | 670 +++++++++++++++++ .../mlx.nn.losses.kl_div_loss.html | 675 +++++++++++++++++ .../mlx.nn.losses.l1_loss.html | 669 +++++++++++++++++ .../mlx.nn.losses.mse_loss.html | 669 +++++++++++++++++ .../mlx.nn.losses.nll_loss.html | 670 +++++++++++++++++ .../_autosummary_functions/mlx.nn.mish.html | 658 +++++++++++++++++ .../_autosummary_functions/mlx.nn.prelu.html | 657 +++++++++++++++++ .../_autosummary_functions/mlx.nn.relu.html | 29 +- .../_autosummary_functions/mlx.nn.selu.html | 661 +++++++++++++++++ .../_autosummary_functions/mlx.nn.silu.html | 37 +- .../_autosummary_functions/mlx.nn.step.html | 666 +++++++++++++++++ docs/build/html/python/array.html | 23 +- docs/build/html/python/data_types.html | 23 +- .../html/python/devices_and_streams.html | 23 +- docs/build/html/python/fft.html | 23 +- docs/build/html/python/nn.html | 80 ++- docs/build/html/python/nn/module.html | 23 +- docs/build/html/python/ops.html | 65 +- docs/build/html/python/optimizers.html | 31 +- docs/build/html/python/random.html | 23 +- docs/build/html/python/transforms.html | 23 +- docs/build/html/python/tree_utils.html | 23 +- docs/build/html/quick_start.html | 22 +- docs/build/html/search.html | 22 +- docs/build/html/searchindex.js | 2 +- docs/build/html/unified_memory.html | 24 +- docs/build/html/using_streams.html | 22 +- 241 files changed, 15049 insertions(+), 737 deletions(-) create mode 100644 docs/build/html/_sources/python/_autosummary/mlx.core.eye.rst create mode 100644 docs/build/html/_sources/python/_autosummary/mlx.core.identity.rst create mode 100644 docs/build/html/_sources/python/_autosummary/mlx.nn.Mish.rst create mode 100644 docs/build/html/_sources/python/_autosummary/mlx.nn.PReLU.rst create mode 100644 docs/build/html/_sources/python/_autosummary/mlx.nn.SELU.rst create mode 100644 docs/build/html/_sources/python/_autosummary/mlx.nn.Step.rst create mode 100644 docs/build/html/_sources/python/_autosummary_functions/mlx.nn.losses.binary_cross_entropy.rst create mode 100644 docs/build/html/_sources/python/_autosummary_functions/mlx.nn.losses.cross_entropy.rst create mode 100644 docs/build/html/_sources/python/_autosummary_functions/mlx.nn.losses.kl_div_loss.rst create mode 100644 docs/build/html/_sources/python/_autosummary_functions/mlx.nn.losses.l1_loss.rst create mode 100644 docs/build/html/_sources/python/_autosummary_functions/mlx.nn.losses.mse_loss.rst create mode 100644 docs/build/html/_sources/python/_autosummary_functions/mlx.nn.losses.nll_loss.rst create mode 100644 docs/build/html/_sources/python/_autosummary_functions/mlx.nn.mish.rst create mode 100644 docs/build/html/_sources/python/_autosummary_functions/mlx.nn.prelu.rst create mode 100644 docs/build/html/_sources/python/_autosummary_functions/mlx.nn.selu.rst create mode 100644 docs/build/html/_sources/python/_autosummary_functions/mlx.nn.step.rst create mode 100644 docs/build/html/python/_autosummary/mlx.core.eye.html create mode 100644 docs/build/html/python/_autosummary/mlx.core.identity.html create mode 100644 docs/build/html/python/_autosummary/mlx.nn.Mish.html create mode 100644 docs/build/html/python/_autosummary/mlx.nn.PReLU.html create mode 100644 docs/build/html/python/_autosummary/mlx.nn.SELU.html create mode 100644 docs/build/html/python/_autosummary/mlx.nn.Step.html create mode 100644 docs/build/html/python/_autosummary_functions/mlx.nn.losses.binary_cross_entropy.html create mode 100644 docs/build/html/python/_autosummary_functions/mlx.nn.losses.cross_entropy.html create mode 100644 docs/build/html/python/_autosummary_functions/mlx.nn.losses.kl_div_loss.html create mode 100644 docs/build/html/python/_autosummary_functions/mlx.nn.losses.l1_loss.html create mode 100644 docs/build/html/python/_autosummary_functions/mlx.nn.losses.mse_loss.html create mode 100644 docs/build/html/python/_autosummary_functions/mlx.nn.losses.nll_loss.html create mode 100644 docs/build/html/python/_autosummary_functions/mlx.nn.mish.html create mode 100644 docs/build/html/python/_autosummary_functions/mlx.nn.prelu.html create mode 100644 docs/build/html/python/_autosummary_functions/mlx.nn.selu.html create mode 100644 docs/build/html/python/_autosummary_functions/mlx.nn.step.html 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