From 1c51899ec694ef8f25d4aa39b08c1866c30895fc Mon Sep 17 00:00:00 2001 From: CircleCI Docs Date: Fri, 25 Jul 2025 20:37:24 +0000 Subject: [PATCH] rebase --- docs/build/html/.buildinfo | 2 +- docs/build/html/_sources/install.rst | 22 ++++++++++++-- .../html/_static/documentation_options.js | 2 +- docs/build/html/cpp/ops.html | 8 ++--- docs/build/html/dev/custom_metal_kernels.html | 8 ++--- docs/build/html/dev/extensions.html | 8 ++--- docs/build/html/dev/metal_debugger.html | 8 ++--- docs/build/html/dev/mlx_in_cpp.html | 8 ++--- .../html/examples/linear_regression.html | 8 ++--- docs/build/html/examples/llama-inference.html | 8 ++--- docs/build/html/examples/mlp.html | 8 ++--- docs/build/html/genindex.html | 8 ++--- docs/build/html/index.html | 8 ++--- docs/build/html/install.html | 28 +++++++++++++----- docs/build/html/objects.inv | Bin 28125 -> 28125 bytes .../python/_autosummary/mlx.core.Device.html | 8 ++--- .../python/_autosummary/mlx.core.Dtype.html | 8 ++--- .../_autosummary/mlx.core.DtypeCategory.html | 8 ++--- .../python/_autosummary/mlx.core.abs.html | 8 ++--- .../python/_autosummary/mlx.core.add.html | 8 ++--- .../python/_autosummary/mlx.core.addmm.html | 8 ++--- .../python/_autosummary/mlx.core.all.html | 8 ++--- .../_autosummary/mlx.core.allclose.html | 8 ++--- .../python/_autosummary/mlx.core.any.html | 8 ++--- .../python/_autosummary/mlx.core.arange.html | 8 ++--- .../python/_autosummary/mlx.core.arccos.html | 8 ++--- .../python/_autosummary/mlx.core.arccosh.html | 8 ++--- .../python/_autosummary/mlx.core.arcsin.html | 8 ++--- .../python/_autosummary/mlx.core.arcsinh.html | 8 ++--- .../python/_autosummary/mlx.core.arctan.html | 8 ++--- .../python/_autosummary/mlx.core.arctan2.html | 8 ++--- .../python/_autosummary/mlx.core.arctanh.html | 8 ++--- .../python/_autosummary/mlx.core.argmax.html | 8 ++--- .../python/_autosummary/mlx.core.argmin.html | 8 ++--- .../_autosummary/mlx.core.argpartition.html | 8 ++--- .../python/_autosummary/mlx.core.argsort.html | 8 ++--- .../python/_autosummary/mlx.core.array.T.html | 8 ++--- .../_autosummary/mlx.core.array.abs.html | 8 ++--- .../_autosummary/mlx.core.array.all.html | 8 ++--- .../_autosummary/mlx.core.array.any.html | 8 ++--- .../_autosummary/mlx.core.array.argmax.html | 8 ++--- .../_autosummary/mlx.core.array.argmin.html | 8 ++--- .../_autosummary/mlx.core.array.astype.html | 8 ++--- .../_autosummary/mlx.core.array.at.html | 8 ++--- .../_autosummary/mlx.core.array.conj.html | 8 ++--- .../_autosummary/mlx.core.array.cos.html | 8 ++--- .../_autosummary/mlx.core.array.cummax.html | 8 ++--- .../_autosummary/mlx.core.array.cummin.html | 8 ++--- .../_autosummary/mlx.core.array.cumprod.html | 8 ++--- .../_autosummary/mlx.core.array.cumsum.html | 8 ++--- .../_autosummary/mlx.core.array.diag.html | 8 ++--- .../_autosummary/mlx.core.array.diagonal.html | 8 ++--- .../_autosummary/mlx.core.array.dtype.html | 8 ++--- .../_autosummary/mlx.core.array.exp.html | 8 ++--- .../_autosummary/mlx.core.array.flatten.html | 8 ++--- .../python/_autosummary/mlx.core.array.html | 8 ++--- .../_autosummary/mlx.core.array.imag.html | 8 ++--- .../_autosummary/mlx.core.array.item.html | 8 ++--- .../_autosummary/mlx.core.array.itemsize.html | 8 ++--- .../_autosummary/mlx.core.array.log.html | 8 ++--- .../_autosummary/mlx.core.array.log10.html | 8 ++--- .../_autosummary/mlx.core.array.log1p.html | 8 ++--- .../_autosummary/mlx.core.array.log2.html | 8 ++--- .../mlx.core.array.logcumsumexp.html | 8 ++--- .../mlx.core.array.logsumexp.html | 8 ++--- .../_autosummary/mlx.core.array.max.html | 8 ++--- .../_autosummary/mlx.core.array.mean.html | 8 ++--- .../_autosummary/mlx.core.array.min.html | 8 ++--- .../_autosummary/mlx.core.array.moveaxis.html | 8 ++--- .../_autosummary/mlx.core.array.nbytes.html | 8 ++--- .../_autosummary/mlx.core.array.ndim.html | 8 ++--- .../_autosummary/mlx.core.array.prod.html | 8 ++--- .../_autosummary/mlx.core.array.real.html | 8 ++--- .../mlx.core.array.reciprocal.html | 8 ++--- .../_autosummary/mlx.core.array.reshape.html | 8 ++--- .../_autosummary/mlx.core.array.round.html | 8 ++--- .../_autosummary/mlx.core.array.rsqrt.html | 8 ++--- .../_autosummary/mlx.core.array.shape.html | 8 ++--- .../_autosummary/mlx.core.array.sin.html | 8 ++--- .../_autosummary/mlx.core.array.size.html | 8 ++--- .../_autosummary/mlx.core.array.split.html | 8 ++--- .../_autosummary/mlx.core.array.sqrt.html | 8 ++--- .../_autosummary/mlx.core.array.square.html | 8 ++--- .../_autosummary/mlx.core.array.squeeze.html | 8 ++--- .../_autosummary/mlx.core.array.std.html | 8 ++--- .../_autosummary/mlx.core.array.sum.html | 8 ++--- .../_autosummary/mlx.core.array.swapaxes.html | 8 ++--- .../_autosummary/mlx.core.array.tolist.html | 8 ++--- .../mlx.core.array.transpose.html | 8 ++--- .../_autosummary/mlx.core.array.var.html | 8 ++--- .../_autosummary/mlx.core.array.view.html | 8 ++--- .../_autosummary/mlx.core.array_equal.html | 8 ++--- .../_autosummary/mlx.core.as_strided.html | 8 ++--- .../_autosummary/mlx.core.async_eval.html | 8 ++--- .../_autosummary/mlx.core.atleast_1d.html | 8 ++--- .../_autosummary/mlx.core.atleast_2d.html | 8 ++--- .../_autosummary/mlx.core.atleast_3d.html | 8 ++--- .../_autosummary/mlx.core.bitwise_and.html | 8 ++--- .../_autosummary/mlx.core.bitwise_invert.html | 8 ++--- .../_autosummary/mlx.core.bitwise_or.html | 8 ++--- .../_autosummary/mlx.core.bitwise_xor.html | 8 ++--- .../mlx.core.block_masked_mm.html | 8 ++--- .../mlx.core.broadcast_arrays.html | 8 ++--- .../_autosummary/mlx.core.broadcast_to.html | 8 ++--- .../python/_autosummary/mlx.core.ceil.html | 8 ++--- .../_autosummary/mlx.core.clear_cache.html | 8 ++--- .../python/_autosummary/mlx.core.clip.html | 8 ++--- .../python/_autosummary/mlx.core.compile.html | 8 ++--- .../_autosummary/mlx.core.concatenate.html | 8 ++--- .../python/_autosummary/mlx.core.conj.html | 8 ++--- .../_autosummary/mlx.core.conjugate.html | 8 ++--- .../_autosummary/mlx.core.contiguous.html | 8 ++--- .../python/_autosummary/mlx.core.conv1d.html | 8 ++--- .../python/_autosummary/mlx.core.conv2d.html | 8 ++--- .../python/_autosummary/mlx.core.conv3d.html | 8 ++--- .../_autosummary/mlx.core.conv_general.html | 8 ++--- .../mlx.core.conv_transpose1d.html | 8 ++--- .../mlx.core.conv_transpose2d.html | 8 ++--- .../mlx.core.conv_transpose3d.html | 8 ++--- .../_autosummary/mlx.core.convolve.html | 8 ++--- .../python/_autosummary/mlx.core.cos.html | 8 ++--- .../python/_autosummary/mlx.core.cosh.html | 8 ++--- .../python/_autosummary/mlx.core.cummax.html | 8 ++--- .../python/_autosummary/mlx.core.cummin.html | 8 ++--- .../python/_autosummary/mlx.core.cumprod.html | 8 ++--- .../python/_autosummary/mlx.core.cumsum.html | 8 ++--- .../mlx.core.custom_function.html | 8 ++--- .../_autosummary/mlx.core.default_device.html | 8 ++--- .../_autosummary/mlx.core.default_stream.html | 8 ++--- .../python/_autosummary/mlx.core.degrees.html | 8 ++--- .../_autosummary/mlx.core.dequantize.html | 10 +++---- .../python/_autosummary/mlx.core.diag.html | 8 ++--- .../_autosummary/mlx.core.diagonal.html | 8 ++--- .../mlx.core.disable_compile.html | 8 ++--- .../mlx.core.distributed.Group.html | 8 ++--- .../mlx.core.distributed.all_gather.html | 8 ++--- .../mlx.core.distributed.all_sum.html | 8 ++--- .../mlx.core.distributed.init.html | 8 ++--- .../mlx.core.distributed.is_available.html | 8 ++--- .../mlx.core.distributed.recv.html | 8 ++--- .../mlx.core.distributed.recv_like.html | 8 ++--- .../mlx.core.distributed.send.html | 8 ++--- .../python/_autosummary/mlx.core.divide.html | 8 ++--- .../python/_autosummary/mlx.core.divmod.html | 8 ++--- .../python/_autosummary/mlx.core.einsum.html | 8 ++--- .../_autosummary/mlx.core.einsum_path.html | 8 ++--- .../_autosummary/mlx.core.enable_compile.html | 8 ++--- .../python/_autosummary/mlx.core.equal.html | 8 ++--- .../python/_autosummary/mlx.core.erf.html | 8 ++--- .../python/_autosummary/mlx.core.erfinv.html | 8 ++--- .../python/_autosummary/mlx.core.eval.html | 8 ++--- .../python/_autosummary/mlx.core.exp.html | 8 ++--- .../_autosummary/mlx.core.expand_dims.html | 8 ++--- .../python/_autosummary/mlx.core.expm1.html | 8 ++--- .../mlx.core.export_function.html | 8 ++--- .../_autosummary/mlx.core.export_to_dot.html | 8 ++--- .../_autosummary/mlx.core.exporter.html | 8 ++--- .../python/_autosummary/mlx.core.eye.html | 8 ++--- .../mlx.core.fast.layer_norm.html | 8 ++--- .../mlx.core.fast.metal_kernel.html | 8 ++--- .../_autosummary/mlx.core.fast.rms_norm.html | 8 ++--- .../_autosummary/mlx.core.fast.rope.html | 8 ++--- ...ore.fast.scaled_dot_product_attention.html | 8 ++--- .../python/_autosummary/mlx.core.fft.fft.html | 8 ++--- .../_autosummary/mlx.core.fft.fft2.html | 8 ++--- .../_autosummary/mlx.core.fft.fftn.html | 8 ++--- .../_autosummary/mlx.core.fft.fftshift.html | 8 ++--- .../_autosummary/mlx.core.fft.ifft.html | 8 ++--- .../_autosummary/mlx.core.fft.ifft2.html | 8 ++--- .../_autosummary/mlx.core.fft.ifftn.html | 8 ++--- .../_autosummary/mlx.core.fft.ifftshift.html | 8 ++--- .../_autosummary/mlx.core.fft.irfft.html | 8 ++--- .../_autosummary/mlx.core.fft.irfft2.html | 8 ++--- .../_autosummary/mlx.core.fft.irfftn.html | 8 ++--- .../_autosummary/mlx.core.fft.rfft.html | 8 ++--- .../_autosummary/mlx.core.fft.rfft2.html | 8 ++--- .../_autosummary/mlx.core.fft.rfftn.html | 8 ++--- .../python/_autosummary/mlx.core.finfo.html | 8 ++--- .../python/_autosummary/mlx.core.flatten.html | 8 ++--- .../python/_autosummary/mlx.core.floor.html | 8 ++--- .../_autosummary/mlx.core.floor_divide.html | 8 ++--- .../python/_autosummary/mlx.core.full.html | 8 ++--- .../_autosummary/mlx.core.gather_mm.html | 8 ++--- .../_autosummary/mlx.core.gather_qmm.html | 8 ++--- .../mlx.core.get_active_memory.html | 8 ++--- .../mlx.core.get_cache_memory.html | 8 ++--- .../mlx.core.get_peak_memory.html | 8 ++--- .../python/_autosummary/mlx.core.grad.html | 8 ++--- .../python/_autosummary/mlx.core.greater.html | 8 ++--- .../_autosummary/mlx.core.greater_equal.html | 8 ++--- .../mlx.core.hadamard_transform.html | 8 ++--- .../_autosummary/mlx.core.identity.html | 8 ++--- .../python/_autosummary/mlx.core.imag.html | 8 ++--- .../mlx.core.import_function.html | 8 ++--- .../python/_autosummary/mlx.core.inner.html | 8 ++--- .../python/_autosummary/mlx.core.isclose.html | 8 ++--- .../_autosummary/mlx.core.isfinite.html | 8 ++--- .../python/_autosummary/mlx.core.isinf.html | 8 ++--- .../python/_autosummary/mlx.core.isnan.html | 8 ++--- .../_autosummary/mlx.core.isneginf.html | 8 ++--- .../_autosummary/mlx.core.isposinf.html | 8 ++--- .../_autosummary/mlx.core.issubdtype.html | 8 ++--- .../python/_autosummary/mlx.core.jvp.html | 8 ++--- .../python/_autosummary/mlx.core.kron.html | 8 ++--- .../_autosummary/mlx.core.left_shift.html | 8 ++--- .../python/_autosummary/mlx.core.less.html | 8 ++--- .../_autosummary/mlx.core.less_equal.html | 8 ++--- .../mlx.core.linalg.cholesky.html | 8 ++--- .../mlx.core.linalg.cholesky_inv.html | 8 ++--- .../_autosummary/mlx.core.linalg.cross.html | 8 ++--- .../_autosummary/mlx.core.linalg.eig.html | 8 ++--- .../_autosummary/mlx.core.linalg.eigh.html | 8 ++--- .../_autosummary/mlx.core.linalg.eigvals.html | 8 ++--- .../mlx.core.linalg.eigvalsh.html | 8 ++--- .../_autosummary/mlx.core.linalg.inv.html | 8 ++--- .../_autosummary/mlx.core.linalg.lu.html | 8 ++--- .../mlx.core.linalg.lu_factor.html | 8 ++--- .../_autosummary/mlx.core.linalg.norm.html | 8 ++--- .../_autosummary/mlx.core.linalg.pinv.html | 8 ++--- .../_autosummary/mlx.core.linalg.qr.html | 8 ++--- .../_autosummary/mlx.core.linalg.solve.html | 8 ++--- .../mlx.core.linalg.solve_triangular.html | 8 ++--- .../_autosummary/mlx.core.linalg.svd.html | 8 ++--- .../_autosummary/mlx.core.linalg.tri_inv.html | 8 ++--- .../_autosummary/mlx.core.linspace.html | 8 ++--- .../python/_autosummary/mlx.core.load.html | 8 ++--- .../python/_autosummary/mlx.core.log.html | 8 ++--- .../python/_autosummary/mlx.core.log10.html | 8 ++--- .../python/_autosummary/mlx.core.log1p.html | 8 ++--- .../python/_autosummary/mlx.core.log2.html | 8 ++--- .../_autosummary/mlx.core.logaddexp.html | 8 ++--- .../_autosummary/mlx.core.logcumsumexp.html | 8 ++--- .../_autosummary/mlx.core.logical_and.html | 8 ++--- .../_autosummary/mlx.core.logical_not.html | 8 ++--- .../_autosummary/mlx.core.logical_or.html | 8 ++--- .../_autosummary/mlx.core.logsumexp.html | 8 ++--- .../python/_autosummary/mlx.core.matmul.html | 8 ++--- .../python/_autosummary/mlx.core.max.html | 8 ++--- .../python/_autosummary/mlx.core.maximum.html | 8 ++--- .../python/_autosummary/mlx.core.mean.html | 8 ++--- .../_autosummary/mlx.core.meshgrid.html | 8 ++--- .../mlx.core.metal.device_info.html | 8 ++--- .../mlx.core.metal.is_available.html | 8 ++--- .../mlx.core.metal.start_capture.html | 8 ++--- .../mlx.core.metal.stop_capture.html | 8 ++--- .../python/_autosummary/mlx.core.min.html | 8 ++--- .../python/_autosummary/mlx.core.minimum.html | 8 ++--- .../_autosummary/mlx.core.moveaxis.html | 8 ++--- .../_autosummary/mlx.core.multiply.html | 8 ++--- .../_autosummary/mlx.core.nan_to_num.html | 8 ++--- .../_autosummary/mlx.core.negative.html | 8 ++--- .../_autosummary/mlx.core.new_stream.html | 8 ++--- .../_autosummary/mlx.core.not_equal.html | 8 ++--- .../python/_autosummary/mlx.core.ones.html | 8 ++--- .../_autosummary/mlx.core.ones_like.html | 8 ++--- .../python/_autosummary/mlx.core.outer.html | 8 ++--- .../python/_autosummary/mlx.core.pad.html | 8 ++--- .../_autosummary/mlx.core.partition.html | 8 ++--- .../python/_autosummary/mlx.core.power.html | 8 ++--- .../python/_autosummary/mlx.core.prod.html | 8 ++--- .../_autosummary/mlx.core.put_along_axis.html | 8 ++--- .../_autosummary/mlx.core.quantize.html | 8 ++--- .../mlx.core.quantized_matmul.html | 8 ++--- .../python/_autosummary/mlx.core.radians.html | 8 ++--- .../mlx.core.random.bernoulli.html | 8 ++--- .../mlx.core.random.categorical.html | 8 ++--- .../_autosummary/mlx.core.random.gumbel.html | 8 ++--- .../_autosummary/mlx.core.random.key.html | 8 ++--- .../_autosummary/mlx.core.random.laplace.html | 8 ++--- .../mlx.core.random.multivariate_normal.html | 8 ++--- .../_autosummary/mlx.core.random.normal.html | 8 ++--- .../mlx.core.random.permutation.html | 8 ++--- .../_autosummary/mlx.core.random.randint.html | 8 ++--- .../_autosummary/mlx.core.random.seed.html | 8 ++--- .../_autosummary/mlx.core.random.split.html | 8 ++--- .../mlx.core.random.truncated_normal.html | 8 ++--- .../_autosummary/mlx.core.random.uniform.html | 8 ++--- .../python/_autosummary/mlx.core.real.html | 8 ++--- .../_autosummary/mlx.core.reciprocal.html | 8 ++--- .../_autosummary/mlx.core.remainder.html | 8 ++--- .../python/_autosummary/mlx.core.repeat.html | 8 ++--- .../mlx.core.reset_peak_memory.html | 8 ++--- .../python/_autosummary/mlx.core.reshape.html | 8 ++--- .../_autosummary/mlx.core.right_shift.html | 8 ++--- .../python/_autosummary/mlx.core.roll.html | 8 ++--- .../python/_autosummary/mlx.core.round.html | 8 ++--- .../python/_autosummary/mlx.core.rsqrt.html | 8 ++--- .../python/_autosummary/mlx.core.save.html | 8 ++--- .../_autosummary/mlx.core.save_gguf.html | 8 ++--- .../mlx.core.save_safetensors.html | 15 +++++----- .../python/_autosummary/mlx.core.savez.html | 8 ++--- .../mlx.core.savez_compressed.html | 8 ++--- .../mlx.core.set_cache_limit.html | 8 ++--- .../mlx.core.set_default_device.html | 8 ++--- .../mlx.core.set_default_stream.html | 8 ++--- .../mlx.core.set_memory_limit.html | 8 ++--- .../mlx.core.set_wired_limit.html | 8 ++--- .../python/_autosummary/mlx.core.sigmoid.html | 8 ++--- .../python/_autosummary/mlx.core.sign.html | 8 ++--- .../python/_autosummary/mlx.core.sin.html | 8 ++--- .../python/_autosummary/mlx.core.sinh.html | 8 ++--- .../python/_autosummary/mlx.core.slice.html | 8 ++--- .../_autosummary/mlx.core.slice_update.html | 8 ++--- .../python/_autosummary/mlx.core.softmax.html | 8 ++--- .../python/_autosummary/mlx.core.sort.html | 8 ++--- .../python/_autosummary/mlx.core.split.html | 8 ++--- .../python/_autosummary/mlx.core.sqrt.html | 8 ++--- .../python/_autosummary/mlx.core.square.html | 8 ++--- .../python/_autosummary/mlx.core.squeeze.html | 8 ++--- .../python/_autosummary/mlx.core.stack.html | 8 ++--- .../python/_autosummary/mlx.core.std.html | 8 ++--- .../_autosummary/mlx.core.stop_gradient.html | 8 ++--- .../python/_autosummary/mlx.core.stream.html | 8 ++--- .../_autosummary/mlx.core.subtract.html | 8 ++--- .../python/_autosummary/mlx.core.sum.html | 8 ++--- .../_autosummary/mlx.core.swapaxes.html | 8 ++--- .../_autosummary/mlx.core.synchronize.html | 8 ++--- .../python/_autosummary/mlx.core.take.html | 8 ++--- .../mlx.core.take_along_axis.html | 8 ++--- .../python/_autosummary/mlx.core.tan.html | 8 ++--- .../python/_autosummary/mlx.core.tanh.html | 8 ++--- .../_autosummary/mlx.core.tensordot.html | 8 ++--- .../python/_autosummary/mlx.core.tile.html | 8 ++--- .../python/_autosummary/mlx.core.topk.html | 8 ++--- .../python/_autosummary/mlx.core.trace.html | 8 ++--- .../_autosummary/mlx.core.transpose.html | 8 ++--- .../python/_autosummary/mlx.core.tri.html | 8 ++--- .../python/_autosummary/mlx.core.tril.html | 8 ++--- .../python/_autosummary/mlx.core.triu.html | 8 ++--- .../_autosummary/mlx.core.unflatten.html | 8 ++--- .../_autosummary/mlx.core.value_and_grad.html | 8 ++--- .../python/_autosummary/mlx.core.var.html | 8 ++--- .../python/_autosummary/mlx.core.view.html | 8 ++--- .../python/_autosummary/mlx.core.vjp.html | 8 ++--- .../python/_autosummary/mlx.core.vmap.html | 8 ++--- .../python/_autosummary/mlx.core.where.html | 8 ++--- .../python/_autosummary/mlx.core.zeros.html | 8 ++--- .../_autosummary/mlx.core.zeros_like.html | 8 ++--- .../mlx.nn.average_gradients.html | 8 ++--- .../python/_autosummary/mlx.nn.quantize.html | 8 ++--- .../_autosummary/mlx.nn.value_and_grad.html | 8 ++--- .../mlx.optimizers.clip_grad_norm.html | 8 ++--- .../_autosummary/mlx.utils.tree_flatten.html | 8 ++--- .../_autosummary/mlx.utils.tree_map.html | 8 ++--- .../mlx.utils.tree_map_with_path.html | 8 ++--- .../_autosummary/mlx.utils.tree_reduce.html | 8 ++--- .../mlx.utils.tree_unflatten.html | 8 ++--- .../python/_autosummary/stream_class.html | 8 ++--- docs/build/html/python/array.html | 8 ++--- docs/build/html/python/data_types.html | 8 ++--- .../html/python/devices_and_streams.html | 8 ++--- docs/build/html/python/distributed.html | 8 ++--- docs/build/html/python/export.html | 8 ++--- docs/build/html/python/fast.html | 8 ++--- docs/build/html/python/fft.html | 8 ++--- docs/build/html/python/linalg.html | 8 ++--- docs/build/html/python/memory_management.html | 8 ++--- docs/build/html/python/metal.html | 8 ++--- docs/build/html/python/nn.html | 8 ++--- .../python/nn/_autosummary/mlx.nn.ALiBi.html | 8 ++--- .../nn/_autosummary/mlx.nn.AvgPool1d.html | 8 ++--- .../nn/_autosummary/mlx.nn.AvgPool2d.html | 8 ++--- .../nn/_autosummary/mlx.nn.AvgPool3d.html | 8 ++--- .../nn/_autosummary/mlx.nn.BatchNorm.html | 8 ++--- .../python/nn/_autosummary/mlx.nn.CELU.html | 8 ++--- .../python/nn/_autosummary/mlx.nn.Conv1d.html | 8 ++--- .../python/nn/_autosummary/mlx.nn.Conv2d.html | 8 ++--- .../python/nn/_autosummary/mlx.nn.Conv3d.html | 8 ++--- .../_autosummary/mlx.nn.ConvTranspose1d.html | 8 ++--- .../_autosummary/mlx.nn.ConvTranspose2d.html | 8 ++--- .../_autosummary/mlx.nn.ConvTranspose3d.html | 8 ++--- .../nn/_autosummary/mlx.nn.Dropout.html | 8 ++--- .../nn/_autosummary/mlx.nn.Dropout2d.html | 8 ++--- .../nn/_autosummary/mlx.nn.Dropout3d.html | 8 ++--- .../python/nn/_autosummary/mlx.nn.ELU.html | 8 ++--- .../nn/_autosummary/mlx.nn.Embedding.html | 8 ++--- .../python/nn/_autosummary/mlx.nn.GELU.html | 8 ++--- .../python/nn/_autosummary/mlx.nn.GLU.html | 8 ++--- .../python/nn/_autosummary/mlx.nn.GRU.html | 8 ++--- .../nn/_autosummary/mlx.nn.GroupNorm.html | 8 ++--- .../nn/_autosummary/mlx.nn.HardShrink.html | 8 ++--- .../nn/_autosummary/mlx.nn.HardTanh.html | 8 ++--- .../nn/_autosummary/mlx.nn.Hardswish.html | 8 ++--- .../nn/_autosummary/mlx.nn.InstanceNorm.html | 8 ++--- .../python/nn/_autosummary/mlx.nn.LSTM.html | 8 ++--- .../nn/_autosummary/mlx.nn.LayerNorm.html | 8 ++--- .../nn/_autosummary/mlx.nn.LeakyReLU.html | 8 ++--- .../python/nn/_autosummary/mlx.nn.Linear.html | 8 ++--- .../nn/_autosummary/mlx.nn.LogSigmoid.html | 8 ++--- .../nn/_autosummary/mlx.nn.LogSoftmax.html | 8 ++--- .../nn/_autosummary/mlx.nn.MaxPool1d.html | 8 ++--- .../nn/_autosummary/mlx.nn.MaxPool2d.html | 8 ++--- .../nn/_autosummary/mlx.nn.MaxPool3d.html | 8 ++--- .../python/nn/_autosummary/mlx.nn.Mish.html | 8 ++--- .../nn/_autosummary/mlx.nn.Module.apply.html | 8 ++--- .../mlx.nn.Module.apply_to_modules.html | 8 ++--- .../_autosummary/mlx.nn.Module.children.html | 8 ++--- .../nn/_autosummary/mlx.nn.Module.eval.html | 8 ++--- .../mlx.nn.Module.filter_and_map.html | 8 ++--- .../nn/_autosummary/mlx.nn.Module.freeze.html | 8 ++--- .../mlx.nn.Module.leaf_modules.html | 8 ++--- .../mlx.nn.Module.load_weights.html | 8 ++--- .../_autosummary/mlx.nn.Module.modules.html | 8 ++--- .../mlx.nn.Module.named_modules.html | 8 ++--- .../mlx.nn.Module.parameters.html | 8 ++--- .../mlx.nn.Module.save_weights.html | 8 ++--- .../_autosummary/mlx.nn.Module.set_dtype.html | 8 ++--- .../nn/_autosummary/mlx.nn.Module.state.html | 8 ++--- .../nn/_autosummary/mlx.nn.Module.train.html | 8 ++--- .../mlx.nn.Module.trainable_parameters.html | 8 ++--- .../_autosummary/mlx.nn.Module.training.html | 8 ++--- .../_autosummary/mlx.nn.Module.unfreeze.html | 8 ++--- .../nn/_autosummary/mlx.nn.Module.update.html | 8 ++--- .../mlx.nn.Module.update_modules.html | 8 ++--- .../mlx.nn.MultiHeadAttention.html | 8 ++--- .../python/nn/_autosummary/mlx.nn.PReLU.html | 8 ++--- .../mlx.nn.QuantizedEmbedding.html | 8 ++--- .../_autosummary/mlx.nn.QuantizedLinear.html | 8 ++--- .../nn/_autosummary/mlx.nn.RMSNorm.html | 8 ++--- .../python/nn/_autosummary/mlx.nn.RNN.html | 8 ++--- .../python/nn/_autosummary/mlx.nn.ReLU.html | 8 ++--- .../python/nn/_autosummary/mlx.nn.ReLU6.html | 8 ++--- .../python/nn/_autosummary/mlx.nn.RoPE.html | 8 ++--- .../python/nn/_autosummary/mlx.nn.SELU.html | 8 ++--- .../nn/_autosummary/mlx.nn.Sequential.html | 8 ++--- .../python/nn/_autosummary/mlx.nn.SiLU.html | 8 ++--- .../nn/_autosummary/mlx.nn.Sigmoid.html | 8 ++--- .../mlx.nn.SinusoidalPositionalEncoding.html | 8 ++--- .../nn/_autosummary/mlx.nn.Softmax.html | 8 ++--- .../nn/_autosummary/mlx.nn.Softmin.html | 8 ++--- .../nn/_autosummary/mlx.nn.Softplus.html | 8 ++--- .../nn/_autosummary/mlx.nn.Softshrink.html | 8 ++--- .../nn/_autosummary/mlx.nn.Softsign.html | 8 ++--- .../python/nn/_autosummary/mlx.nn.Step.html | 8 ++--- .../python/nn/_autosummary/mlx.nn.Tanh.html | 8 ++--- .../nn/_autosummary/mlx.nn.Transformer.html | 8 ++--- .../nn/_autosummary/mlx.nn.Upsample.html | 8 ++--- .../nn/_autosummary/mlx.nn.init.constant.html | 8 ++--- .../mlx.nn.init.glorot_normal.html | 8 ++--- .../mlx.nn.init.glorot_uniform.html | 8 ++--- .../_autosummary/mlx.nn.init.he_normal.html | 8 ++--- .../_autosummary/mlx.nn.init.he_uniform.html | 8 ++--- .../nn/_autosummary/mlx.nn.init.identity.html | 8 ++--- .../nn/_autosummary/mlx.nn.init.normal.html | 8 ++--- .../nn/_autosummary/mlx.nn.init.uniform.html | 8 ++--- .../_autosummary_functions/mlx.nn.celu.html | 8 ++--- .../nn/_autosummary_functions/mlx.nn.elu.html | 8 ++--- .../_autosummary_functions/mlx.nn.gelu.html | 8 ++--- .../mlx.nn.gelu_approx.html | 8 ++--- .../mlx.nn.gelu_fast_approx.html | 8 ++--- .../nn/_autosummary_functions/mlx.nn.glu.html | 8 ++--- .../mlx.nn.hard_shrink.html | 8 ++--- .../mlx.nn.hard_tanh.html | 8 ++--- .../mlx.nn.hardswish.html | 8 ++--- .../mlx.nn.leaky_relu.html | 8 ++--- .../mlx.nn.log_sigmoid.html | 8 ++--- .../mlx.nn.log_softmax.html | 8 ++--- .../mlx.nn.losses.binary_cross_entropy.html | 8 ++--- .../mlx.nn.losses.cosine_similarity_loss.html | 8 ++--- .../mlx.nn.losses.cross_entropy.html | 8 ++--- .../mlx.nn.losses.gaussian_nll_loss.html | 8 ++--- .../mlx.nn.losses.hinge_loss.html | 8 ++--- .../mlx.nn.losses.huber_loss.html | 8 ++--- .../mlx.nn.losses.kl_div_loss.html | 8 ++--- .../mlx.nn.losses.l1_loss.html | 8 ++--- .../mlx.nn.losses.log_cosh_loss.html | 8 ++--- .../mlx.nn.losses.margin_ranking_loss.html | 8 ++--- .../mlx.nn.losses.mse_loss.html | 8 ++--- .../mlx.nn.losses.nll_loss.html | 8 ++--- .../mlx.nn.losses.smooth_l1_loss.html | 8 ++--- .../mlx.nn.losses.triplet_loss.html | 8 ++--- .../_autosummary_functions/mlx.nn.mish.html | 8 ++--- .../_autosummary_functions/mlx.nn.prelu.html | 8 ++--- .../_autosummary_functions/mlx.nn.relu.html | 8 ++--- .../_autosummary_functions/mlx.nn.relu6.html | 8 ++--- .../_autosummary_functions/mlx.nn.selu.html | 8 ++--- .../mlx.nn.sigmoid.html | 8 ++--- .../_autosummary_functions/mlx.nn.silu.html | 8 ++--- .../mlx.nn.softmax.html | 8 ++--- .../mlx.nn.softmin.html | 8 ++--- .../mlx.nn.softplus.html | 8 ++--- .../mlx.nn.softshrink.html | 8 ++--- .../_autosummary_functions/mlx.nn.step.html | 8 ++--- .../_autosummary_functions/mlx.nn.tanh.html | 8 ++--- docs/build/html/python/nn/functions.html | 8 ++--- docs/build/html/python/nn/init.html | 8 ++--- docs/build/html/python/nn/layers.html | 8 ++--- docs/build/html/python/nn/losses.html | 8 ++--- docs/build/html/python/nn/module.html | 8 ++--- docs/build/html/python/ops.html | 8 ++--- docs/build/html/python/optimizers.html | 8 ++--- .../_autosummary/mlx.optimizers.AdaDelta.html | 8 ++--- .../mlx.optimizers.Adafactor.html | 8 ++--- .../_autosummary/mlx.optimizers.Adagrad.html | 8 ++--- .../_autosummary/mlx.optimizers.Adam.html | 10 +++---- .../_autosummary/mlx.optimizers.AdamW.html | 10 +++---- .../_autosummary/mlx.optimizers.Adamax.html | 8 ++--- .../_autosummary/mlx.optimizers.Lion.html | 8 ++--- .../mlx.optimizers.MultiOptimizer.html | 8 ++--- .../_autosummary/mlx.optimizers.Muon.html | 8 ++--- ....optimizers.Optimizer.apply_gradients.html | 8 ++--- .../mlx.optimizers.Optimizer.init.html | 8 ++--- .../mlx.optimizers.Optimizer.state.html | 8 ++--- .../mlx.optimizers.Optimizer.update.html | 8 ++--- .../_autosummary/mlx.optimizers.RMSprop.html | 8 ++--- .../_autosummary/mlx.optimizers.SGD.html | 8 ++--- .../mlx.optimizers.cosine_decay.html | 8 ++--- .../mlx.optimizers.exponential_decay.html | 8 ++--- .../mlx.optimizers.join_schedules.html | 8 ++--- .../mlx.optimizers.linear_schedule.html | 8 ++--- .../mlx.optimizers.step_decay.html | 8 ++--- .../python/optimizers/common_optimizers.html | 8 ++--- .../html/python/optimizers/optimizer.html | 8 ++--- .../html/python/optimizers/schedulers.html | 8 ++--- docs/build/html/python/random.html | 8 ++--- docs/build/html/python/transforms.html | 8 ++--- docs/build/html/python/tree_utils.html | 8 ++--- docs/build/html/search.html | 8 ++--- docs/build/html/searchindex.js | 2 +- docs/build/html/usage/compile.html | 8 ++--- docs/build/html/usage/distributed.html | 8 ++--- docs/build/html/usage/export.html | 8 ++--- .../build/html/usage/function_transforms.html | 8 ++--- docs/build/html/usage/indexing.html | 8 ++--- .../html/usage/launching_distributed.html | 8 ++--- docs/build/html/usage/lazy_evaluation.html | 8 ++--- docs/build/html/usage/numpy.html | 8 ++--- docs/build/html/usage/quick_start.html | 8 ++--- docs/build/html/usage/saving_and_loading.html | 8 ++--- docs/build/html/usage/unified_memory.html | 8 ++--- docs/build/html/usage/using_streams.html | 8 ++--- 531 files changed, 2150 insertions(+), 2119 deletions(-) diff --git a/docs/build/html/.buildinfo b/docs/build/html/.buildinfo index 009f93cb4..5331fb28b 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: 9c3e17ea0d482d32f4f063bee7570344 +config: 3eac35b7a723ac541f1874e4ba883287 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/build/html/_sources/install.rst b/docs/build/html/_sources/install.rst index 70491ac64..268141567 100644 --- a/docs/build/html/_sources/install.rst +++ b/docs/build/html/_sources/install.rst @@ -13,7 +13,7 @@ silicon computer is pip install mlx -To install from PyPI you must meet the following requirements: +To install from PyPI your system must meet the following requirements: - Using an M series chip (Apple silicon) - Using a native Python >= 3.9 @@ -26,13 +26,22 @@ To install from PyPI you must meet the following requirements: CUDA ^^^^ -MLX has a CUDA backend which you can use on any Linux platform with CUDA 12 -and SM 7.0 (Volta) and up. To install MLX with CUDA support, run: +MLX has a CUDA backend which you can install with: .. code-block:: shell pip install "mlx[cuda]" +To install the CUDA package from PyPi your system must meet the following +requirements: + +- Nvidia architecture >= SM 7.0 (Volta) +- Nvidia driver >= 550.54.14 +- CUDA toolkit >= 12.0 +- Linux distribution with glibc >= 2.35 +- Python >= 3.9 + + CPU-only (Linux) ^^^^^^^^^^^^^^^^ @@ -42,6 +51,13 @@ For a CPU-only version of MLX that runs on Linux use: pip install "mlx[cpu]" +To install the CPU-only package from PyPi your system must meet the following +requirements: + +- Linux distribution with glibc >= 2.35 +- Python >= 3.9 + + Troubleshooting ^^^^^^^^^^^^^^^ diff --git a/docs/build/html/_static/documentation_options.js b/docs/build/html/_static/documentation_options.js index fd264a281..13e217a09 100644 --- a/docs/build/html/_static/documentation_options.js +++ b/docs/build/html/_static/documentation_options.js @@ -1,5 +1,5 @@ const DOCUMENTATION_OPTIONS = { - VERSION: '0.26.5', + VERSION: '0.27.0', LANGUAGE: 'en', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/docs/build/html/cpp/ops.html b/docs/build/html/cpp/ops.html index 6f5f23599..bbdae7e06 100644 --- a/docs/build/html/cpp/ops.html +++ b/docs/build/html/cpp/ops.html @@ -8,7 +8,7 @@ - Operations — MLX 0.26.5 documentation + Operations — MLX 0.27.0 documentation @@ -36,7 +36,7 @@ - + @@ -137,8 +137,8 @@ - MLX 0.26.5 documentation - Home - + MLX 0.27.0 documentation - Home + diff --git a/docs/build/html/dev/custom_metal_kernels.html b/docs/build/html/dev/custom_metal_kernels.html index 92c800644..6bcf880c9 100644 --- a/docs/build/html/dev/custom_metal_kernels.html +++ b/docs/build/html/dev/custom_metal_kernels.html @@ -8,7 +8,7 @@ - Custom Metal Kernels — MLX 0.26.5 documentation + Custom Metal Kernels — MLX 0.27.0 documentation @@ -36,7 +36,7 @@ - + @@ -137,8 +137,8 @@ - MLX 0.26.5 documentation - Home - + MLX 0.27.0 documentation - Home + diff --git a/docs/build/html/dev/extensions.html b/docs/build/html/dev/extensions.html index 74c6d4ccd..92fd1f3fe 100644 --- a/docs/build/html/dev/extensions.html +++ b/docs/build/html/dev/extensions.html @@ -8,7 +8,7 @@ - Custom Extensions in MLX — MLX 0.26.5 documentation + Custom Extensions in MLX — MLX 0.27.0 documentation @@ -36,7 +36,7 @@ - + @@ -137,8 +137,8 @@ - MLX 0.26.5 documentation - Home - + MLX 0.27.0 documentation - Home + diff --git a/docs/build/html/dev/metal_debugger.html b/docs/build/html/dev/metal_debugger.html index ecc4e784f..1d2082609 100644 --- a/docs/build/html/dev/metal_debugger.html +++ b/docs/build/html/dev/metal_debugger.html @@ -8,7 +8,7 @@ - Metal Debugger — MLX 0.26.5 documentation + Metal Debugger — MLX 0.27.0 documentation @@ -36,7 +36,7 @@ - + @@ -137,8 +137,8 @@ - MLX 0.26.5 documentation - Home - + MLX 0.27.0 documentation - Home + diff --git a/docs/build/html/dev/mlx_in_cpp.html b/docs/build/html/dev/mlx_in_cpp.html index e9659eb4f..92886b4a6 100644 --- a/docs/build/html/dev/mlx_in_cpp.html +++ b/docs/build/html/dev/mlx_in_cpp.html @@ -8,7 +8,7 @@ - Using MLX in C++ — MLX 0.26.5 documentation + Using MLX in C++ — MLX 0.27.0 documentation @@ -36,7 +36,7 @@ - + @@ -136,8 +136,8 @@ - MLX 0.26.5 documentation - Home - + MLX 0.27.0 documentation - Home + diff --git a/docs/build/html/examples/linear_regression.html b/docs/build/html/examples/linear_regression.html index 0822dc3b1..ccc6a14b6 100644 --- a/docs/build/html/examples/linear_regression.html +++ b/docs/build/html/examples/linear_regression.html @@ -8,7 +8,7 @@ - Linear Regression — MLX 0.26.5 documentation + Linear Regression — MLX 0.27.0 documentation @@ -36,7 +36,7 @@ - + @@ -137,8 +137,8 @@ - MLX 0.26.5 documentation - Home - + MLX 0.27.0 documentation - Home + diff --git a/docs/build/html/examples/llama-inference.html b/docs/build/html/examples/llama-inference.html index 659ec5be8..191ca6c4a 100644 --- a/docs/build/html/examples/llama-inference.html +++ b/docs/build/html/examples/llama-inference.html @@ -8,7 +8,7 @@ - LLM inference — MLX 0.26.5 documentation + LLM inference — MLX 0.27.0 documentation @@ -36,7 +36,7 @@ - + @@ -137,8 +137,8 @@ - MLX 0.26.5 documentation - Home - + MLX 0.27.0 documentation - Home + diff --git a/docs/build/html/examples/mlp.html b/docs/build/html/examples/mlp.html index 671b9304e..f8fce79ce 100644 --- a/docs/build/html/examples/mlp.html +++ b/docs/build/html/examples/mlp.html @@ -8,7 +8,7 @@ - Multi-Layer Perceptron — MLX 0.26.5 documentation + Multi-Layer Perceptron — MLX 0.27.0 documentation @@ -36,7 +36,7 @@ - + @@ -137,8 +137,8 @@ - MLX 0.26.5 documentation - Home - + MLX 0.27.0 documentation - Home + diff --git a/docs/build/html/genindex.html b/docs/build/html/genindex.html index 8fce14d3f..501d3bbc3 100644 --- a/docs/build/html/genindex.html +++ b/docs/build/html/genindex.html @@ -7,7 +7,7 @@ - Index — MLX 0.26.5 documentation + Index — MLX 0.27.0 documentation @@ -35,7 +35,7 @@ - + @@ -136,8 +136,8 @@ - MLX 0.26.5 documentation - Home - + MLX 0.27.0 documentation - Home + diff --git a/docs/build/html/index.html b/docs/build/html/index.html index 8596232c8..7eabd006d 100644 --- a/docs/build/html/index.html +++ b/docs/build/html/index.html @@ -8,7 +8,7 @@ - MLX — MLX 0.26.5 documentation + MLX — MLX 0.27.0 documentation @@ -36,7 +36,7 @@ - + @@ -139,8 +139,8 @@ - MLX 0.26.5 documentation - Home - + MLX 0.27.0 documentation - Home + diff --git a/docs/build/html/install.html b/docs/build/html/install.html index b62cda0a7..1722c2498 100644 --- a/docs/build/html/install.html +++ b/docs/build/html/install.html @@ -8,7 +8,7 @@ - Build and Install — MLX 0.26.5 documentation + Build and Install — MLX 0.27.0 documentation @@ -36,7 +36,7 @@ - + @@ -137,8 +137,8 @@ - MLX 0.26.5 documentation - Home - + MLX 0.27.0 documentation - Home + @@ -948,7 +948,7 @@ silicon computer is

pip install mlx
 
-

To install from PyPI you must meet the following requirements:

+

To install from PyPI your system must meet the following requirements: