From b71521953330ad72dd936ba2d5ff76c4d7dd45a8 Mon Sep 17 00:00:00 2001 From: Awni Hannun Date: Thu, 7 Dec 2023 08:00:41 -0800 Subject: [PATCH] docs --- docs/build/html/.buildinfo | 2 +- docs/build/html/_sources/install.rst | 25 ++++++++++++ .../html/_static/documentation_options.js | 2 +- docs/build/html/cpp/ops.html | 6 +-- docs/build/html/dev/extensions.html | 6 +-- .../html/examples/linear_regression.html | 6 +-- docs/build/html/examples/llama-inference.html | 6 +-- docs/build/html/examples/mlp.html | 6 +-- docs/build/html/genindex.html | 6 +-- docs/build/html/index.html | 6 +-- docs/build/html/install.html | 38 +++++++++++++++--- docs/build/html/objects.inv | Bin 4576 -> 4576 bytes .../python/_autosummary/mlx.core.Device.html | 6 +-- .../python/_autosummary/mlx.core.Dtype.html | 6 +-- .../python/_autosummary/mlx.core.Stream.html | 6 +-- .../python/_autosummary/mlx.core.abs.html | 6 +-- .../python/_autosummary/mlx.core.add.html | 6 +-- .../python/_autosummary/mlx.core.all.html | 6 +-- .../_autosummary/mlx.core.allclose.html | 6 +-- .../python/_autosummary/mlx.core.any.html | 6 +-- .../python/_autosummary/mlx.core.arange.html | 6 +-- .../python/_autosummary/mlx.core.arccos.html | 6 +-- .../python/_autosummary/mlx.core.arccosh.html | 6 +-- .../python/_autosummary/mlx.core.arcsin.html | 6 +-- .../python/_autosummary/mlx.core.arcsinh.html | 6 +-- .../python/_autosummary/mlx.core.arctan.html | 6 +-- .../python/_autosummary/mlx.core.arctanh.html | 6 +-- .../python/_autosummary/mlx.core.argmax.html | 6 +-- .../python/_autosummary/mlx.core.argmin.html | 6 +-- .../_autosummary/mlx.core.argpartition.html | 6 +-- .../python/_autosummary/mlx.core.argsort.html | 6 +-- .../python/_autosummary/mlx.core.array.T.html | 6 +-- .../_autosummary/mlx.core.array.abs.html | 6 +-- .../_autosummary/mlx.core.array.all.html | 6 +-- .../_autosummary/mlx.core.array.any.html | 6 +-- .../_autosummary/mlx.core.array.argmax.html | 6 +-- .../_autosummary/mlx.core.array.argmin.html | 6 +-- .../_autosummary/mlx.core.array.astype.html | 6 +-- .../_autosummary/mlx.core.array.cos.html | 6 +-- .../_autosummary/mlx.core.array.dtype.html | 6 +-- .../_autosummary/mlx.core.array.exp.html | 6 +-- .../python/_autosummary/mlx.core.array.html | 6 +-- .../_autosummary/mlx.core.array.item.html | 6 +-- .../_autosummary/mlx.core.array.log.html | 6 +-- .../_autosummary/mlx.core.array.log1p.html | 6 +-- .../mlx.core.array.logsumexp.html | 6 +-- .../_autosummary/mlx.core.array.max.html | 6 +-- .../_autosummary/mlx.core.array.mean.html | 6 +-- .../_autosummary/mlx.core.array.min.html | 6 +-- .../_autosummary/mlx.core.array.ndim.html | 6 +-- .../_autosummary/mlx.core.array.prod.html | 6 +-- .../mlx.core.array.reciprocal.html | 6 +-- .../_autosummary/mlx.core.array.reshape.html | 6 +-- .../_autosummary/mlx.core.array.rsqrt.html | 6 +-- .../_autosummary/mlx.core.array.shape.html | 6 +-- .../_autosummary/mlx.core.array.sin.html | 6 +-- .../_autosummary/mlx.core.array.size.html | 6 +-- .../_autosummary/mlx.core.array.split.html | 6 +-- .../_autosummary/mlx.core.array.sqrt.html | 6 +-- .../_autosummary/mlx.core.array.square.html | 6 +-- .../_autosummary/mlx.core.array.sum.html | 6 +-- .../_autosummary/mlx.core.array.tolist.html | 6 +-- .../mlx.core.array.transpose.html | 6 +-- .../_autosummary/mlx.core.array.var.html | 6 +-- .../_autosummary/mlx.core.array_equal.html | 6 +-- .../_autosummary/mlx.core.broadcast_to.html | 6 +-- .../_autosummary/mlx.core.concatenate.html | 6 +-- .../python/_autosummary/mlx.core.conv1d.html | 6 +-- .../python/_autosummary/mlx.core.conv2d.html | 6 +-- .../_autosummary/mlx.core.convolve.html | 6 +-- .../python/_autosummary/mlx.core.cos.html | 6 +-- .../python/_autosummary/mlx.core.cosh.html | 6 +-- .../_autosummary/mlx.core.default_device.html | 6 +-- .../_autosummary/mlx.core.default_stream.html | 6 +-- .../python/_autosummary/mlx.core.divide.html | 6 +-- .../python/_autosummary/mlx.core.equal.html | 6 +-- .../python/_autosummary/mlx.core.erf.html | 6 +-- .../python/_autosummary/mlx.core.erfinv.html | 6 +-- .../python/_autosummary/mlx.core.eval.html | 6 +-- .../python/_autosummary/mlx.core.exp.html | 6 +-- .../_autosummary/mlx.core.expand_dims.html | 6 +-- .../python/_autosummary/mlx.core.fft.fft.html | 6 +-- .../_autosummary/mlx.core.fft.fft2.html | 6 +-- .../_autosummary/mlx.core.fft.fftn.html | 6 +-- .../_autosummary/mlx.core.fft.ifft.html | 6 +-- .../_autosummary/mlx.core.fft.ifft2.html | 6 +-- .../_autosummary/mlx.core.fft.ifftn.html | 6 +-- .../_autosummary/mlx.core.fft.irfft.html | 6 +-- .../_autosummary/mlx.core.fft.irfft2.html | 6 +-- .../_autosummary/mlx.core.fft.irfftn.html | 6 +-- .../_autosummary/mlx.core.fft.rfft.html | 6 +-- .../_autosummary/mlx.core.fft.rfft2.html | 6 +-- .../_autosummary/mlx.core.fft.rfftn.html | 6 +-- .../python/_autosummary/mlx.core.full.html | 6 +-- .../python/_autosummary/mlx.core.grad.html | 17 +++++--- .../python/_autosummary/mlx.core.greater.html | 6 +-- .../_autosummary/mlx.core.greater_equal.html | 6 +-- .../python/_autosummary/mlx.core.jvp.html | 6 +-- .../python/_autosummary/mlx.core.less.html | 6 +-- .../_autosummary/mlx.core.less_equal.html | 6 +-- .../python/_autosummary/mlx.core.load.html | 6 +-- .../python/_autosummary/mlx.core.log.html | 6 +-- .../python/_autosummary/mlx.core.log10.html | 6 +-- .../python/_autosummary/mlx.core.log1p.html | 6 +-- .../python/_autosummary/mlx.core.log2.html | 6 +-- .../_autosummary/mlx.core.logaddexp.html | 6 +-- .../_autosummary/mlx.core.logical_not.html | 6 +-- .../_autosummary/mlx.core.logsumexp.html | 6 +-- .../python/_autosummary/mlx.core.matmul.html | 6 +-- .../python/_autosummary/mlx.core.max.html | 6 +-- .../python/_autosummary/mlx.core.maximum.html | 6 +-- .../python/_autosummary/mlx.core.mean.html | 6 +-- .../python/_autosummary/mlx.core.min.html | 6 +-- .../python/_autosummary/mlx.core.minimum.html | 6 +-- .../_autosummary/mlx.core.multiply.html | 6 +-- .../_autosummary/mlx.core.negative.html | 6 +-- .../_autosummary/mlx.core.new_stream.html | 6 +-- .../python/_autosummary/mlx.core.ones.html | 6 +-- .../_autosummary/mlx.core.ones_like.html | 6 +-- .../python/_autosummary/mlx.core.pad.html | 6 +-- .../_autosummary/mlx.core.partition.html | 6 +-- .../python/_autosummary/mlx.core.prod.html | 6 +-- .../mlx.core.random.bernoulli.html | 6 +-- .../mlx.core.random.categorical.html | 6 +-- .../_autosummary/mlx.core.random.gumbel.html | 6 +-- .../_autosummary/mlx.core.random.key.html | 6 +-- .../_autosummary/mlx.core.random.normal.html | 6 +-- .../_autosummary/mlx.core.random.randint.html | 6 +-- .../_autosummary/mlx.core.random.seed.html | 6 +-- .../_autosummary/mlx.core.random.split.html | 6 +-- .../mlx.core.random.truncated_normal.html | 6 +-- .../_autosummary/mlx.core.random.uniform.html | 6 +-- .../_autosummary/mlx.core.reciprocal.html | 6 +-- .../python/_autosummary/mlx.core.reshape.html | 6 +-- .../python/_autosummary/mlx.core.rsqrt.html | 6 +-- .../python/_autosummary/mlx.core.save.html | 6 +-- .../python/_autosummary/mlx.core.savez.html | 6 +-- .../mlx.core.savez_compressed.html | 6 +-- .../mlx.core.set_default_device.html | 6 +-- .../mlx.core.set_default_stream.html | 6 +-- .../python/_autosummary/mlx.core.sigmoid.html | 6 +-- .../python/_autosummary/mlx.core.sign.html | 6 +-- .../python/_autosummary/mlx.core.sin.html | 6 +-- .../python/_autosummary/mlx.core.sinh.html | 6 +-- .../python/_autosummary/mlx.core.softmax.html | 6 +-- .../python/_autosummary/mlx.core.sort.html | 6 +-- .../python/_autosummary/mlx.core.split.html | 6 +-- .../python/_autosummary/mlx.core.sqrt.html | 6 +-- .../python/_autosummary/mlx.core.square.html | 6 +-- .../python/_autosummary/mlx.core.squeeze.html | 6 +-- .../_autosummary/mlx.core.stop_gradient.html | 6 +-- .../_autosummary/mlx.core.subtract.html | 6 +-- .../python/_autosummary/mlx.core.sum.html | 6 +-- .../python/_autosummary/mlx.core.take.html | 6 +-- .../mlx.core.take_along_axis.html | 6 +-- .../python/_autosummary/mlx.core.tan.html | 6 +-- .../python/_autosummary/mlx.core.tanh.html | 6 +-- .../_autosummary/mlx.core.transpose.html | 6 +-- .../_autosummary/mlx.core.value_and_grad.html | 17 +++++--- .../python/_autosummary/mlx.core.var.html | 6 +-- .../python/_autosummary/mlx.core.vjp.html | 6 +-- .../python/_autosummary/mlx.core.vmap.html | 6 +-- .../python/_autosummary/mlx.core.where.html | 6 +-- .../python/_autosummary/mlx.core.zeros.html | 6 +-- .../_autosummary/mlx.core.zeros_like.html | 6 +-- .../python/_autosummary/mlx.nn.Conv1d.html | 6 +-- .../python/_autosummary/mlx.nn.Conv2d.html | 6 +-- .../python/_autosummary/mlx.nn.Embedding.html | 6 +-- .../html/python/_autosummary/mlx.nn.GELU.html | 6 +-- .../python/_autosummary/mlx.nn.GroupNorm.html | 6 +-- .../python/_autosummary/mlx.nn.LayerNorm.html | 6 +-- .../python/_autosummary/mlx.nn.Linear.html | 6 +-- .../mlx.nn.MultiHeadAttention.html | 6 +-- .../python/_autosummary/mlx.nn.RMSNorm.html | 6 +-- .../html/python/_autosummary/mlx.nn.ReLU.html | 6 +-- .../html/python/_autosummary/mlx.nn.RoPE.html | 6 +-- .../_autosummary/mlx.nn.Sequential.html | 6 +-- .../html/python/_autosummary/mlx.nn.SiLU.html | 6 +-- .../_autosummary/mlx.nn.value_and_grad.html | 6 +-- .../_autosummary/mlx.optimizers.Adam.html | 6 +-- .../mlx.optimizers.Optimizer.html | 6 +-- .../mlx.optimizers.OptimizerState.html | 6 +-- .../_autosummary/mlx.optimizers.SGD.html | 6 +-- .../_autosummary/mlx.utils.tree_flatten.html | 6 +-- .../_autosummary/mlx.utils.tree_map.html | 6 +-- .../mlx.utils.tree_unflatten.html | 6 +-- .../_autosummary_functions/mlx.nn.gelu.html | 6 +-- .../mlx.nn.gelu_approx.html | 6 +-- .../mlx.nn.gelu_fast_approx.html | 6 +-- .../_autosummary_functions/mlx.nn.relu.html | 6 +-- .../_autosummary_functions/mlx.nn.silu.html | 6 +-- docs/build/html/python/array.html | 6 +-- docs/build/html/python/data_types.html | 6 +-- .../html/python/devices_and_streams.html | 6 +-- docs/build/html/python/fft.html | 6 +-- docs/build/html/python/nn.html | 6 +-- docs/build/html/python/nn/module.html | 6 +-- docs/build/html/python/ops.html | 6 +-- docs/build/html/python/optimizers.html | 6 +-- docs/build/html/python/random.html | 6 +-- docs/build/html/python/transforms.html | 10 ++--- docs/build/html/python/tree_utils.html | 6 +-- docs/build/html/quick_start.html | 6 +-- docs/build/html/search.html | 6 +-- docs/build/html/searchindex.js | 2 +- docs/build/html/using_streams.html | 6 +-- 206 files changed, 678 insertions(+), 617 deletions(-) diff --git a/docs/build/html/.buildinfo b/docs/build/html/.buildinfo index 5b5e9de51..63c9d0e41 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: 101437d3a6497705badb11e599f96b45 +config: 177bbfa0562989b62a154f2dd1ab02a1 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/build/html/_sources/install.rst b/docs/build/html/_sources/install.rst index b82b2838c..682f09f38 100644 --- a/docs/build/html/_sources/install.rst +++ b/docs/build/html/_sources/install.rst @@ -11,10 +11,34 @@ silicon computer is pip install mlx +To install from PyPI you must meet the following requirements: + +- Using an M series chip (Apple silicon) +- Using a native Python >= 3.8 +- MacOS >= 13.3 + .. note:: MLX is only available on devices running MacOS >= 13.3 It is highly recommended to use MacOS 14 (Sonoma) +Troubleshooting +^^^^^^^^^^^^^^^ + +*My OS and Python versions are in the required range but pip still does not find +a matching distribution.* + +Probably you are using a non-native Python. The output of + +.. code-block:: shell + + python -c "import platform; print(platform.processor())" + +should be ``arm``. If it is ``i386`` (and you have M series machine) then you +are using a non-native Python. Switch your Python to a native Python. A good +way to do this is with +`Conda `_. + + Build from source ----------------- @@ -61,6 +85,7 @@ To make sure the install is working run the tests with: .. code-block:: shell + pip install ".[testing]" python -m unittest discover python/tests C++ API diff --git a/docs/build/html/_static/documentation_options.js b/docs/build/html/_static/documentation_options.js index 9012603b7..f8f4859e3 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.3', + VERSION: '0.0.4', LANGUAGE: 'en', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/docs/build/html/cpp/ops.html b/docs/build/html/cpp/ops.html index 4d97b7a65..2167066d3 100644 --- a/docs/build/html/cpp/ops.html +++ b/docs/build/html/cpp/ops.html @@ -9,7 +9,7 @@ - Operations — MLX 0.0.3 documentation + Operations — MLX 0.0.4 documentation @@ -134,8 +134,8 @@ - MLX 0.0.3 documentation - Home - + MLX 0.0.4 documentation - Home + diff --git a/docs/build/html/dev/extensions.html b/docs/build/html/dev/extensions.html index cb3a13b80..9a47ae5f3 100644 --- a/docs/build/html/dev/extensions.html +++ b/docs/build/html/dev/extensions.html @@ -9,7 +9,7 @@ - Developer Documentation — MLX 0.0.3 documentation + Developer Documentation — MLX 0.0.4 documentation @@ -133,8 +133,8 @@ - MLX 0.0.3 documentation - Home - + MLX 0.0.4 documentation - Home + diff --git a/docs/build/html/examples/linear_regression.html b/docs/build/html/examples/linear_regression.html index 932db4c26..a096950bf 100644 --- a/docs/build/html/examples/linear_regression.html +++ b/docs/build/html/examples/linear_regression.html @@ -9,7 +9,7 @@ - Linear Regression — MLX 0.0.3 documentation + Linear Regression — MLX 0.0.4 documentation @@ -134,8 +134,8 @@ - MLX 0.0.3 documentation - Home - + MLX 0.0.4 documentation - Home + diff --git a/docs/build/html/examples/llama-inference.html b/docs/build/html/examples/llama-inference.html index aada78d30..6658e6034 100644 --- a/docs/build/html/examples/llama-inference.html +++ b/docs/build/html/examples/llama-inference.html @@ -9,7 +9,7 @@ - LLM inference — MLX 0.0.3 documentation + LLM inference — MLX 0.0.4 documentation @@ -134,8 +134,8 @@ - MLX 0.0.3 documentation - Home - + MLX 0.0.4 documentation - Home + diff --git a/docs/build/html/examples/mlp.html b/docs/build/html/examples/mlp.html index 7bf055a43..5ab1e11f8 100644 --- a/docs/build/html/examples/mlp.html +++ b/docs/build/html/examples/mlp.html @@ -9,7 +9,7 @@ - Multi-Layer Perceptron — MLX 0.0.3 documentation + Multi-Layer Perceptron — MLX 0.0.4 documentation @@ -134,8 +134,8 @@ - MLX 0.0.3 documentation - Home - + MLX 0.0.4 documentation - Home + diff --git a/docs/build/html/genindex.html b/docs/build/html/genindex.html index bd40f287d..4332ef3da 100644 --- a/docs/build/html/genindex.html +++ b/docs/build/html/genindex.html @@ -8,7 +8,7 @@ - Index — MLX 0.0.3 documentation + Index — MLX 0.0.4 documentation @@ -131,8 +131,8 @@ - MLX 0.0.3 documentation - Home - + MLX 0.0.4 documentation - Home + diff --git a/docs/build/html/index.html b/docs/build/html/index.html index ef7b2e990..c5927c04e 100644 --- a/docs/build/html/index.html +++ b/docs/build/html/index.html @@ -9,7 +9,7 @@ - MLX — MLX 0.0.3 documentation + MLX — MLX 0.0.4 documentation @@ -133,8 +133,8 @@ - MLX 0.0.3 documentation - Home - + MLX 0.0.4 documentation - Home + diff --git a/docs/build/html/install.html b/docs/build/html/install.html index 45ed70943..f630b7de6 100644 --- a/docs/build/html/install.html +++ b/docs/build/html/install.html @@ -9,7 +9,7 @@ - Build and Install — MLX 0.0.3 documentation + Build and Install — MLX 0.0.4 documentation @@ -134,8 +134,8 @@ - MLX 0.0.3 documentation - Home - + MLX 0.0.4 documentation - Home + @@ -536,7 +536,10 @@ document.write(`