From eede93197dead93cd4da0697b89d9f7bc0d910cb Mon Sep 17 00:00:00 2001 From: Awni Hannun Date: Thu, 14 Mar 2024 12:46:45 -0700 Subject: [PATCH] docs update --- docs/build/html/.buildinfo | 2 +- docs/build/html/_sources/index.rst | 1 + docs/build/html/_sources/install.rst | 6 +- .../python/_autosummary/mlx.core.isclose.rst | 6 + .../mlx.core.metal.get_active_memory.rst | 6 + .../mlx.core.metal.get_cache_memory.rst | 6 + .../mlx.core.metal.get_peak_memory.rst | 6 + .../mlx.core.metal.is_available.rst | 6 + .../mlx.core.metal.set_cache_limit.rst | 6 + .../mlx.core.metal.set_memory_limit.rst | 6 + .../python/_autosummary/mlx.core.tile.rst | 6 + .../python/_autosummary/mlx.core.topk.rst | 6 + .../_autosummary/mlx.optimizers.AdaDelta.rst | 19 - .../_autosummary/mlx.optimizers.Adafactor.rst | 19 - .../_autosummary/mlx.optimizers.Adagrad.rst | 19 - .../_autosummary/mlx.optimizers.Adam.rst | 19 - .../_autosummary/mlx.optimizers.AdamW.rst | 18 - .../_autosummary/mlx.optimizers.Adamax.rst | 19 - .../_autosummary/mlx.optimizers.Lion.rst | 19 - ...x.optimizers.Optimizer.apply_gradients.rst | 6 - .../mlx.optimizers.Optimizer.init.rst | 6 - .../mlx.optimizers.Optimizer.state.rst | 6 - .../mlx.optimizers.Optimizer.update.rst | 6 - .../_autosummary/mlx.optimizers.RMSprop.rst | 19 - .../_autosummary/mlx.optimizers.SGD.rst | 19 - .../python/_autosummary_stream/Stream.rst | 28 - .../_autosummary_stream/mlx.core.Device.rst | 28 - .../_autosummary_stream/mlx.core.Stream.rst | 28 - docs/build/html/_sources/python/metal.rst | 14 + .../python/nn/_autosummary/mlx.nn.GRU.rst | 6 + .../python/nn/_autosummary/mlx.nn.LSTM.rst | 6 + .../python/nn/_autosummary/mlx.nn.RNN.rst | 6 + docs/build/html/_sources/python/nn/layers.rst | 3 + docs/build/html/_sources/python/ops.rst | 3 + docs/build/html/_sources/python/optimizer.rst | 23 - .../_sources/usage/function_transforms.rst | 2 +- .../html/_static/documentation_options.js | 2 +- docs/build/html/cpp/ops.html | 43 +- docs/build/html/dev/extensions.html | 43 +- .../html/examples/linear_regression.html | 43 +- docs/build/html/examples/llama-inference.html | 43 +- docs/build/html/examples/mlp.html | 43 +- docs/build/html/genindex.html | 85 +- docs/build/html/index.html | 44 +- docs/build/html/install.html | 49 +- docs/build/html/objects.inv | Bin 8525 -> 8876 bytes .../python/_autosummary/mlx.core.Device.html | 43 +- .../python/_autosummary/mlx.core.Dtype.html | 43 +- .../python/_autosummary/mlx.core.Stream.html | 43 +- .../python/_autosummary/mlx.core.abs.html | 43 +- .../python/_autosummary/mlx.core.add.html | 43 +- .../python/_autosummary/mlx.core.all.html | 43 +- .../_autosummary/mlx.core.allclose.html | 43 +- .../python/_autosummary/mlx.core.any.html | 43 +- .../python/_autosummary/mlx.core.arange.html | 43 +- .../python/_autosummary/mlx.core.arccos.html | 43 +- .../python/_autosummary/mlx.core.arccosh.html | 43 +- .../python/_autosummary/mlx.core.arcsin.html | 43 +- .../python/_autosummary/mlx.core.arcsinh.html | 43 +- .../python/_autosummary/mlx.core.arctan.html | 43 +- .../python/_autosummary/mlx.core.arctanh.html | 43 +- .../python/_autosummary/mlx.core.argmax.html | 43 +- .../python/_autosummary/mlx.core.argmin.html | 43 +- .../_autosummary/mlx.core.argpartition.html | 43 +- .../python/_autosummary/mlx.core.argsort.html | 43 +- .../python/_autosummary/mlx.core.array.T.html | 43 +- .../_autosummary/mlx.core.array.abs.html | 43 +- .../_autosummary/mlx.core.array.all.html | 43 +- .../_autosummary/mlx.core.array.any.html | 43 +- .../_autosummary/mlx.core.array.argmax.html | 43 +- .../_autosummary/mlx.core.array.argmin.html | 43 +- .../_autosummary/mlx.core.array.astype.html | 43 +- .../_autosummary/mlx.core.array.cos.html | 43 +- .../_autosummary/mlx.core.array.dtype.html | 43 +- .../_autosummary/mlx.core.array.exp.html | 43 +- .../python/_autosummary/mlx.core.array.html | 43 +- .../_autosummary/mlx.core.array.item.html | 43 +- .../_autosummary/mlx.core.array.log.html | 43 +- .../_autosummary/mlx.core.array.log1p.html | 43 +- .../mlx.core.array.logsumexp.html | 43 +- .../_autosummary/mlx.core.array.max.html | 43 +- .../_autosummary/mlx.core.array.mean.html | 43 +- .../_autosummary/mlx.core.array.min.html | 43 +- .../_autosummary/mlx.core.array.ndim.html | 43 +- .../_autosummary/mlx.core.array.prod.html | 43 +- .../mlx.core.array.reciprocal.html | 43 +- .../_autosummary/mlx.core.array.reshape.html | 43 +- .../_autosummary/mlx.core.array.round.html | 43 +- .../_autosummary/mlx.core.array.rsqrt.html | 43 +- .../_autosummary/mlx.core.array.shape.html | 43 +- .../_autosummary/mlx.core.array.sin.html | 43 +- .../_autosummary/mlx.core.array.size.html | 43 +- .../_autosummary/mlx.core.array.split.html | 43 +- .../_autosummary/mlx.core.array.sqrt.html | 43 +- .../_autosummary/mlx.core.array.square.html | 43 +- .../_autosummary/mlx.core.array.sum.html | 43 +- .../_autosummary/mlx.core.array.tolist.html | 43 +- .../mlx.core.array.transpose.html | 43 +- .../_autosummary/mlx.core.array.var.html | 43 +- .../_autosummary/mlx.core.array_equal.html | 43 +- .../_autosummary/mlx.core.atleast_1d.html | 43 +- .../_autosummary/mlx.core.atleast_2d.html | 43 +- .../_autosummary/mlx.core.atleast_3d.html | 43 +- .../_autosummary/mlx.core.broadcast_to.html | 43 +- .../python/_autosummary/mlx.core.ceil.html | 43 +- .../python/_autosummary/mlx.core.clip.html | 43 +- .../python/_autosummary/mlx.core.compile.html | 43 +- .../_autosummary/mlx.core.concatenate.html | 43 +- .../python/_autosummary/mlx.core.conv1d.html | 43 +- .../python/_autosummary/mlx.core.conv2d.html | 43 +- .../_autosummary/mlx.core.conv_general.html | 43 +- .../_autosummary/mlx.core.convolve.html | 43 +- .../python/_autosummary/mlx.core.cos.html | 43 +- .../python/_autosummary/mlx.core.cosh.html | 43 +- .../_autosummary/mlx.core.default_device.html | 43 +- .../_autosummary/mlx.core.default_stream.html | 43 +- .../_autosummary/mlx.core.dequantize.html | 43 +- .../python/_autosummary/mlx.core.diag.html | 43 +- .../_autosummary/mlx.core.diagonal.html | 43 +- .../mlx.core.disable_compile.html | 43 +- .../python/_autosummary/mlx.core.divide.html | 43 +- .../python/_autosummary/mlx.core.divmod.html | 43 +- .../_autosummary/mlx.core.enable_compile.html | 43 +- .../python/_autosummary/mlx.core.equal.html | 43 +- .../python/_autosummary/mlx.core.erf.html | 43 +- .../python/_autosummary/mlx.core.erfinv.html | 43 +- .../python/_autosummary/mlx.core.eval.html | 43 +- .../python/_autosummary/mlx.core.exp.html | 43 +- .../_autosummary/mlx.core.expand_dims.html | 43 +- .../python/_autosummary/mlx.core.eye.html | 43 +- .../python/_autosummary/mlx.core.fft.fft.html | 43 +- .../_autosummary/mlx.core.fft.fft2.html | 43 +- .../_autosummary/mlx.core.fft.fftn.html | 43 +- .../_autosummary/mlx.core.fft.ifft.html | 43 +- .../_autosummary/mlx.core.fft.ifft2.html | 43 +- .../_autosummary/mlx.core.fft.ifftn.html | 43 +- .../_autosummary/mlx.core.fft.irfft.html | 43 +- .../_autosummary/mlx.core.fft.irfft2.html | 43 +- .../_autosummary/mlx.core.fft.irfftn.html | 43 +- .../_autosummary/mlx.core.fft.rfft.html | 43 +- .../_autosummary/mlx.core.fft.rfft2.html | 43 +- .../_autosummary/mlx.core.fft.rfftn.html | 43 +- .../python/_autosummary/mlx.core.flatten.html | 43 +- .../python/_autosummary/mlx.core.floor.html | 43 +- .../_autosummary/mlx.core.floor_divide.html | 43 +- .../python/_autosummary/mlx.core.full.html | 43 +- .../python/_autosummary/mlx.core.grad.html | 43 +- .../python/_autosummary/mlx.core.greater.html | 43 +- .../_autosummary/mlx.core.greater_equal.html | 43 +- .../_autosummary/mlx.core.identity.html | 43 +- .../python/_autosummary/mlx.core.inner.html | 49 +- ...s.Adafactor.html => mlx.core.isclose.html} | 193 ++-- .../python/_autosummary/mlx.core.isinf.html | 43 +- .../python/_autosummary/mlx.core.isnan.html | 49 +- .../_autosummary/mlx.core.isneginf.html | 43 +- .../_autosummary/mlx.core.isposinf.html | 43 +- .../python/_autosummary/mlx.core.jvp.html | 43 +- .../python/_autosummary/mlx.core.less.html | 43 +- .../_autosummary/mlx.core.less_equal.html | 43 +- .../_autosummary/mlx.core.linalg.norm.html | 43 +- .../_autosummary/mlx.core.linalg.qr.html | 51 +- .../_autosummary/mlx.core.linspace.html | 47 +- .../python/_autosummary/mlx.core.load.html | 43 +- .../python/_autosummary/mlx.core.log.html | 43 +- .../python/_autosummary/mlx.core.log10.html | 43 +- .../python/_autosummary/mlx.core.log1p.html | 43 +- .../python/_autosummary/mlx.core.log2.html | 43 +- .../_autosummary/mlx.core.logaddexp.html | 43 +- .../_autosummary/mlx.core.logical_and.html | 43 +- .../_autosummary/mlx.core.logical_not.html | 43 +- .../_autosummary/mlx.core.logical_or.html | 43 +- .../_autosummary/mlx.core.logsumexp.html | 43 +- .../python/_autosummary/mlx.core.matmul.html | 43 +- .../python/_autosummary/mlx.core.max.html | 43 +- .../python/_autosummary/mlx.core.maximum.html | 43 +- .../python/_autosummary/mlx.core.mean.html | 43 +- ... => mlx.core.metal.get_active_memory.html} | 168 ++-- ...l => mlx.core.metal.get_cache_memory.html} | 168 ++-- ...ml => mlx.core.metal.get_peak_memory.html} | 166 ++-- ....html => mlx.core.metal.is_available.html} | 166 ++-- ...ml => mlx.core.metal.set_cache_limit.html} | 169 ++-- ...l => mlx.core.metal.set_memory_limit.html} | 178 ++-- .../python/_autosummary/mlx.core.min.html | 43 +- .../python/_autosummary/mlx.core.minimum.html | 43 +- .../_autosummary/mlx.core.moveaxis.html | 43 +- .../_autosummary/mlx.core.multiply.html | 43 +- .../_autosummary/mlx.core.negative.html | 43 +- .../_autosummary/mlx.core.new_stream.html | 43 +- .../python/_autosummary/mlx.core.ones.html | 43 +- .../_autosummary/mlx.core.ones_like.html | 43 +- .../python/_autosummary/mlx.core.outer.html | 43 +- .../python/_autosummary/mlx.core.pad.html | 43 +- .../_autosummary/mlx.core.partition.html | 43 +- .../python/_autosummary/mlx.core.prod.html | 43 +- .../_autosummary/mlx.core.quantize.html | 43 +- .../mlx.core.quantized_matmul.html | 43 +- .../mlx.core.random.bernoulli.html | 43 +- .../mlx.core.random.categorical.html | 43 +- .../_autosummary/mlx.core.random.gumbel.html | 43 +- .../_autosummary/mlx.core.random.key.html | 43 +- .../_autosummary/mlx.core.random.normal.html | 43 +- .../_autosummary/mlx.core.random.randint.html | 43 +- .../_autosummary/mlx.core.random.seed.html | 43 +- .../_autosummary/mlx.core.random.split.html | 43 +- .../mlx.core.random.truncated_normal.html | 43 +- .../_autosummary/mlx.core.random.uniform.html | 43 +- .../_autosummary/mlx.core.reciprocal.html | 43 +- .../python/_autosummary/mlx.core.repeat.html | 43 +- .../python/_autosummary/mlx.core.reshape.html | 43 +- .../python/_autosummary/mlx.core.round.html | 43 +- .../python/_autosummary/mlx.core.rsqrt.html | 43 +- .../python/_autosummary/mlx.core.save.html | 43 +- .../_autosummary/mlx.core.save_gguf.html | 43 +- .../mlx.core.save_safetensors.html | 43 +- .../python/_autosummary/mlx.core.savez.html | 43 +- .../mlx.core.savez_compressed.html | 43 +- .../mlx.core.set_default_device.html | 43 +- .../mlx.core.set_default_stream.html | 43 +- .../python/_autosummary/mlx.core.sigmoid.html | 43 +- .../python/_autosummary/mlx.core.sign.html | 43 +- .../python/_autosummary/mlx.core.sin.html | 43 +- .../python/_autosummary/mlx.core.sinh.html | 43 +- .../python/_autosummary/mlx.core.softmax.html | 43 +- .../python/_autosummary/mlx.core.sort.html | 43 +- .../python/_autosummary/mlx.core.split.html | 43 +- .../python/_autosummary/mlx.core.sqrt.html | 43 +- .../python/_autosummary/mlx.core.square.html | 43 +- .../python/_autosummary/mlx.core.squeeze.html | 47 +- .../python/_autosummary/mlx.core.stack.html | 43 +- .../_autosummary/mlx.core.stop_gradient.html | 43 +- .../_autosummary/mlx.core.subtract.html | 43 +- .../python/_autosummary/mlx.core.sum.html | 43 +- .../_autosummary/mlx.core.swapaxes.html | 43 +- .../python/_autosummary/mlx.core.take.html | 43 +- .../mlx.core.take_along_axis.html | 43 +- .../python/_autosummary/mlx.core.tan.html | 43 +- .../python/_autosummary/mlx.core.tanh.html | 43 +- .../_autosummary/mlx.core.tensordot.html | 49 +- .../python/_autosummary/mlx.core.tile.html | 833 +++++++++++++++++ .../python/_autosummary/mlx.core.topk.html | 837 +++++++++++++++++ .../_autosummary/mlx.core.transpose.html | 49 +- .../python/_autosummary/mlx.core.tri.html | 43 +- .../python/_autosummary/mlx.core.tril.html | 43 +- .../python/_autosummary/mlx.core.triu.html | 43 +- .../_autosummary/mlx.core.value_and_grad.html | 43 +- .../python/_autosummary/mlx.core.var.html | 43 +- .../python/_autosummary/mlx.core.vjp.html | 43 +- .../python/_autosummary/mlx.core.vmap.html | 43 +- .../python/_autosummary/mlx.core.where.html | 43 +- .../python/_autosummary/mlx.core.zeros.html | 43 +- .../_autosummary/mlx.core.zeros_like.html | 43 +- .../_autosummary/mlx.nn.value_and_grad.html | 43 +- .../_autosummary/mlx.optimizers.Adagrad.html | 802 ----------------- ....optimizers.Optimizer.apply_gradients.html | 785 ---------------- .../mlx.optimizers.Optimizer.init.html | 792 ---------------- .../mlx.optimizers.Optimizer.state.html | 772 ---------------- .../mlx.optimizers.Optimizer.update.html | 782 ---------------- .../_autosummary/mlx.optimizers.SGD.html | 802 ----------------- .../_autosummary/mlx.utils.tree_flatten.html | 43 +- .../_autosummary/mlx.utils.tree_map.html | 43 +- .../mlx.utils.tree_unflatten.html | 43 +- .../python/_autosummary/stream_class.html | 43 +- .../python/_autosummary_stream/Stream.html | 777 ---------------- .../_autosummary_stream/mlx.core.Device.html | 798 ---------------- .../_autosummary_stream/mlx.core.Stream.html | 798 ---------------- docs/build/html/python/array.html | 43 +- docs/build/html/python/data_types.html | 43 +- .../html/python/devices_and_streams.html | 43 +- docs/build/html/python/fft.html | 43 +- docs/build/html/python/linalg.html | 45 +- .../python/{optimizer.html => metal.html} | 164 ++-- docs/build/html/python/nn.html | 52 +- .../python/nn/_autosummary/mlx.nn.ALiBi.html | 43 +- .../nn/_autosummary/mlx.nn.AvgPool1d.html | 43 +- .../nn/_autosummary/mlx.nn.AvgPool2d.html | 43 +- .../nn/_autosummary/mlx.nn.BatchNorm.html | 43 +- .../python/nn/_autosummary/mlx.nn.Conv1d.html | 46 +- .../python/nn/_autosummary/mlx.nn.Conv2d.html | 46 +- .../nn/_autosummary/mlx.nn.Dropout.html | 43 +- .../nn/_autosummary/mlx.nn.Dropout2d.html | 43 +- .../nn/_autosummary/mlx.nn.Dropout3d.html | 43 +- .../nn/_autosummary/mlx.nn.Embedding.html | 43 +- .../python/nn/_autosummary/mlx.nn.GELU.html | 43 +- .../python/nn/_autosummary/mlx.nn.GRU.html | 846 +++++++++++++++++ .../nn/_autosummary/mlx.nn.GroupNorm.html | 49 +- .../nn/_autosummary/mlx.nn.InstanceNorm.html | 49 +- .../python/nn/_autosummary/mlx.nn.LSTM.html | 849 ++++++++++++++++++ .../nn/_autosummary/mlx.nn.LayerNorm.html | 43 +- .../python/nn/_autosummary/mlx.nn.Linear.html | 49 +- .../nn/_autosummary/mlx.nn.MaxPool1d.html | 49 +- .../nn/_autosummary/mlx.nn.MaxPool2d.html | 43 +- .../python/nn/_autosummary/mlx.nn.Mish.html | 43 +- .../nn/_autosummary/mlx.nn.Module.apply.html | 43 +- .../mlx.nn.Module.apply_to_modules.html | 43 +- .../_autosummary/mlx.nn.Module.children.html | 43 +- .../nn/_autosummary/mlx.nn.Module.eval.html | 43 +- .../mlx.nn.Module.filter_and_map.html | 43 +- .../nn/_autosummary/mlx.nn.Module.freeze.html | 43 +- .../mlx.nn.Module.leaf_modules.html | 43 +- .../mlx.nn.Module.load_weights.html | 43 +- .../_autosummary/mlx.nn.Module.modules.html | 43 +- .../mlx.nn.Module.named_modules.html | 43 +- .../mlx.nn.Module.parameters.html | 43 +- .../mlx.nn.Module.save_weights.html | 43 +- .../nn/_autosummary/mlx.nn.Module.state.html | 43 +- .../nn/_autosummary/mlx.nn.Module.train.html | 43 +- .../mlx.nn.Module.trainable_parameters.html | 43 +- .../_autosummary/mlx.nn.Module.training.html | 43 +- .../_autosummary/mlx.nn.Module.unfreeze.html | 43 +- .../nn/_autosummary/mlx.nn.Module.update.html | 43 +- .../mlx.nn.Module.update_modules.html | 43 +- .../mlx.nn.MultiHeadAttention.html | 43 +- .../python/nn/_autosummary/mlx.nn.PReLU.html | 43 +- .../_autosummary/mlx.nn.QuantizedLinear.html | 43 +- .../nn/_autosummary/mlx.nn.RMSNorm.html | 43 +- .../python/nn/_autosummary/mlx.nn.RNN.html | 844 +++++++++++++++++ .../python/nn/_autosummary/mlx.nn.ReLU.html | 49 +- .../python/nn/_autosummary/mlx.nn.RoPE.html | 49 +- .../python/nn/_autosummary/mlx.nn.SELU.html | 43 +- .../nn/_autosummary/mlx.nn.Sequential.html | 43 +- .../python/nn/_autosummary/mlx.nn.SiLU.html | 43 +- .../mlx.nn.SinusoidalPositionalEncoding.html | 43 +- .../nn/_autosummary/mlx.nn.Softshrink.html | 43 +- .../python/nn/_autosummary/mlx.nn.Step.html | 43 +- .../nn/_autosummary/mlx.nn.Transformer.html | 43 +- .../nn/_autosummary/mlx.nn.Upsample.html | 43 +- .../nn/_autosummary/mlx.nn.init.constant.html | 43 +- .../mlx.nn.init.glorot_normal.html | 43 +- .../mlx.nn.init.glorot_uniform.html | 43 +- .../_autosummary/mlx.nn.init.he_normal.html | 43 +- .../_autosummary/mlx.nn.init.he_uniform.html | 43 +- .../nn/_autosummary/mlx.nn.init.identity.html | 43 +- .../nn/_autosummary/mlx.nn.init.normal.html | 43 +- .../nn/_autosummary/mlx.nn.init.uniform.html | 43 +- .../nn/_autosummary_functions/mlx.nn.elu.html | 43 +- .../_autosummary_functions/mlx.nn.gelu.html | 43 +- .../mlx.nn.gelu_approx.html | 43 +- .../mlx.nn.gelu_fast_approx.html | 43 +- .../nn/_autosummary_functions/mlx.nn.glu.html | 43 +- .../mlx.nn.hardswish.html | 43 +- .../mlx.nn.leaky_relu.html | 43 +- .../mlx.nn.log_sigmoid.html | 43 +- .../mlx.nn.log_softmax.html | 43 +- .../mlx.nn.losses.binary_cross_entropy.html | 43 +- .../mlx.nn.losses.cosine_similarity_loss.html | 43 +- .../mlx.nn.losses.cross_entropy.html | 43 +- .../mlx.nn.losses.gaussian_nll_loss.html | 43 +- .../mlx.nn.losses.hinge_loss.html | 43 +- .../mlx.nn.losses.huber_loss.html | 43 +- .../mlx.nn.losses.kl_div_loss.html | 43 +- .../mlx.nn.losses.l1_loss.html | 43 +- .../mlx.nn.losses.log_cosh_loss.html | 43 +- .../mlx.nn.losses.margin_ranking_loss.html | 43 +- .../mlx.nn.losses.mse_loss.html | 43 +- .../mlx.nn.losses.nll_loss.html | 43 +- .../mlx.nn.losses.smooth_l1_loss.html | 43 +- .../mlx.nn.losses.triplet_loss.html | 43 +- .../_autosummary_functions/mlx.nn.mish.html | 43 +- .../_autosummary_functions/mlx.nn.prelu.html | 43 +- .../_autosummary_functions/mlx.nn.relu.html | 43 +- .../_autosummary_functions/mlx.nn.relu6.html | 43 +- .../_autosummary_functions/mlx.nn.selu.html | 43 +- .../mlx.nn.sigmoid.html | 43 +- .../_autosummary_functions/mlx.nn.silu.html | 43 +- .../mlx.nn.softmax.html | 43 +- .../mlx.nn.softplus.html | 43 +- .../mlx.nn.softshrink.html | 43 +- .../_autosummary_functions/mlx.nn.step.html | 43 +- .../_autosummary_functions/mlx.nn.tanh.html | 43 +- docs/build/html/python/nn/functions.html | 43 +- docs/build/html/python/nn/init.html | 43 +- docs/build/html/python/nn/layers.html | 76 +- docs/build/html/python/nn/losses.html | 43 +- docs/build/html/python/nn/module.html | 43 +- docs/build/html/python/ops.html | 196 ++-- docs/build/html/python/optimizers.html | 43 +- .../_autosummary/mlx.optimizers.AdaDelta.html | 47 +- .../mlx.optimizers.Adafactor.html | 48 +- .../_autosummary/mlx.optimizers.Adagrad.html | 47 +- .../_autosummary/mlx.optimizers.Adam.html | 47 +- .../_autosummary/mlx.optimizers.AdamW.html | 47 +- .../_autosummary/mlx.optimizers.Adamax.html | 47 +- .../_autosummary/mlx.optimizers.Lion.html | 47 +- ....optimizers.Optimizer.apply_gradients.html | 43 +- .../mlx.optimizers.Optimizer.init.html | 43 +- .../mlx.optimizers.Optimizer.state.html | 43 +- .../mlx.optimizers.Optimizer.update.html | 43 +- .../_autosummary/mlx.optimizers.RMSprop.html | 47 +- .../_autosummary/mlx.optimizers.SGD.html | 43 +- .../mlx.optimizers.cosine_decay.html | 43 +- .../mlx.optimizers.exponential_decay.html | 43 +- .../mlx.optimizers.join_schedules.html | 43 +- .../mlx.optimizers.linear_schedule.html | 43 +- .../mlx.optimizers.step_decay.html | 43 +- .../python/optimizers/common_optimizers.html | 43 +- .../html/python/optimizers/optimizer.html | 43 +- .../html/python/optimizers/schedulers.html | 43 +- docs/build/html/python/random.html | 43 +- docs/build/html/python/transforms.html | 43 +- docs/build/html/python/tree_utils.html | 43 +- docs/build/html/search.html | 43 +- docs/build/html/searchindex.js | 2 +- docs/build/html/usage/compile.html | 43 +- .../build/html/usage/function_transforms.html | 45 +- docs/build/html/usage/indexing.html | 43 +- docs/build/html/usage/lazy_evaluation.html | 43 +- docs/build/html/usage/numpy.html | 43 +- docs/build/html/usage/quick_start.html | 43 +- docs/build/html/usage/saving_and_loading.html | 43 +- docs/build/html/usage/unified_memory.html | 43 +- docs/build/html/usage/using_streams.html | 43 +- 411 files changed, 15444 insertions(+), 13066 deletions(-) create mode 100644 docs/build/html/_sources/python/_autosummary/mlx.core.isclose.rst create mode 100644 docs/build/html/_sources/python/_autosummary/mlx.core.metal.get_active_memory.rst create mode 100644 docs/build/html/_sources/python/_autosummary/mlx.core.metal.get_cache_memory.rst create mode 100644 docs/build/html/_sources/python/_autosummary/mlx.core.metal.get_peak_memory.rst create mode 100644 docs/build/html/_sources/python/_autosummary/mlx.core.metal.is_available.rst create mode 100644 docs/build/html/_sources/python/_autosummary/mlx.core.metal.set_cache_limit.rst create mode 100644 docs/build/html/_sources/python/_autosummary/mlx.core.metal.set_memory_limit.rst create mode 100644 docs/build/html/_sources/python/_autosummary/mlx.core.tile.rst create mode 100644 docs/build/html/_sources/python/_autosummary/mlx.core.topk.rst delete mode 100644 docs/build/html/_sources/python/_autosummary/mlx.optimizers.AdaDelta.rst delete mode 100644 docs/build/html/_sources/python/_autosummary/mlx.optimizers.Adafactor.rst delete mode 100644 docs/build/html/_sources/python/_autosummary/mlx.optimizers.Adagrad.rst delete mode 100644 docs/build/html/_sources/python/_autosummary/mlx.optimizers.Adam.rst delete mode 100644 docs/build/html/_sources/python/_autosummary/mlx.optimizers.AdamW.rst delete mode 100644 docs/build/html/_sources/python/_autosummary/mlx.optimizers.Adamax.rst delete mode 100644 docs/build/html/_sources/python/_autosummary/mlx.optimizers.Lion.rst delete mode 100644 docs/build/html/_sources/python/_autosummary/mlx.optimizers.Optimizer.apply_gradients.rst delete mode 100644 docs/build/html/_sources/python/_autosummary/mlx.optimizers.Optimizer.init.rst delete mode 100644 docs/build/html/_sources/python/_autosummary/mlx.optimizers.Optimizer.state.rst delete mode 100644 docs/build/html/_sources/python/_autosummary/mlx.optimizers.Optimizer.update.rst delete mode 100644 docs/build/html/_sources/python/_autosummary/mlx.optimizers.RMSprop.rst delete mode 100644 docs/build/html/_sources/python/_autosummary/mlx.optimizers.SGD.rst delete mode 100644 docs/build/html/_sources/python/_autosummary_stream/Stream.rst delete mode 100644 docs/build/html/_sources/python/_autosummary_stream/mlx.core.Device.rst delete mode 100644 docs/build/html/_sources/python/_autosummary_stream/mlx.core.Stream.rst create mode 100644 docs/build/html/_sources/python/metal.rst create mode 100644 docs/build/html/_sources/python/nn/_autosummary/mlx.nn.GRU.rst create mode 100644 docs/build/html/_sources/python/nn/_autosummary/mlx.nn.LSTM.rst create mode 100644 docs/build/html/_sources/python/nn/_autosummary/mlx.nn.RNN.rst delete mode 100644 docs/build/html/_sources/python/optimizer.rst rename docs/build/html/python/_autosummary/{mlx.optimizers.Adafactor.html => mlx.core.isclose.html} (74%) rename docs/build/html/python/_autosummary/{mlx.optimizers.Adamax.html => mlx.core.metal.get_active_memory.html} (81%) rename docs/build/html/python/_autosummary/{mlx.optimizers.AdamW.html => mlx.core.metal.get_cache_memory.html} (81%) rename docs/build/html/python/_autosummary/{mlx.optimizers.AdaDelta.html => mlx.core.metal.get_peak_memory.html} (81%) rename docs/build/html/python/_autosummary/{mlx.optimizers.Adam.html => mlx.core.metal.is_available.html} (81%) rename docs/build/html/python/_autosummary/{mlx.optimizers.RMSprop.html => mlx.core.metal.set_cache_limit.html} (79%) rename docs/build/html/python/_autosummary/{mlx.optimizers.Lion.html => mlx.core.metal.set_memory_limit.html} (78%) create mode 100644 docs/build/html/python/_autosummary/mlx.core.tile.html create mode 100644 docs/build/html/python/_autosummary/mlx.core.topk.html delete mode 100644 docs/build/html/python/_autosummary/mlx.optimizers.Adagrad.html delete mode 100644 docs/build/html/python/_autosummary/mlx.optimizers.Optimizer.apply_gradients.html delete mode 100644 docs/build/html/python/_autosummary/mlx.optimizers.Optimizer.init.html delete mode 100644 docs/build/html/python/_autosummary/mlx.optimizers.Optimizer.state.html delete mode 100644 docs/build/html/python/_autosummary/mlx.optimizers.Optimizer.update.html delete mode 100644 docs/build/html/python/_autosummary/mlx.optimizers.SGD.html delete mode 100644 docs/build/html/python/_autosummary_stream/Stream.html delete mode 100644 docs/build/html/python/_autosummary_stream/mlx.core.Device.html delete mode 100644 docs/build/html/python/_autosummary_stream/mlx.core.Stream.html rename docs/build/html/python/{optimizer.html => metal.html} (81%) create mode 100644 docs/build/html/python/nn/_autosummary/mlx.nn.GRU.html create mode 100644 docs/build/html/python/nn/_autosummary/mlx.nn.LSTM.html create mode 100644 docs/build/html/python/nn/_autosummary/mlx.nn.RNN.html diff --git a/docs/build/html/.buildinfo b/docs/build/html/.buildinfo index 61885dc99..8c5f7ab98 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: 2a306b1bab538696d27d81f66f046d0d +config: 57f717b9ebf2db0403bb08af977fd504 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/build/html/_sources/index.rst b/docs/build/html/_sources/index.rst index 50dfe9083..e54a55b7a 100644 --- a/docs/build/html/_sources/index.rst +++ b/docs/build/html/_sources/index.rst @@ -64,6 +64,7 @@ are the CPU and GPU. python/transforms python/fft python/linalg + python/metal python/nn python/optimizers python/tree_utils diff --git a/docs/build/html/_sources/install.rst b/docs/build/html/_sources/install.rst index 6c0535079..ce549247f 100644 --- a/docs/build/html/_sources/install.rst +++ b/docs/build/html/_sources/install.rst @@ -15,10 +15,10 @@ 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 +- macOS >= 13.5 .. note:: - MLX is only available on devices running macOS >= 13.3 + MLX is only available on devices running macOS >= 13.5 It is highly recommended to use macOS 14 (Sonoma) @@ -54,7 +54,7 @@ Build Requirements - A C++ compiler with C++17 support (e.g. Clang >= 5.0) - `cmake `_ -- version 3.24 or later, and ``make`` -- Xcode >= 14.3 (Xcode >= 15.0 for macOS 14 and above) +- Xcode >= 15.0 and macOS SDK >= 14.0 .. note:: Ensure your shell environment is native ``arm``, not ``x86`` via Rosetta. If diff --git a/docs/build/html/_sources/python/_autosummary/mlx.core.isclose.rst b/docs/build/html/_sources/python/_autosummary/mlx.core.isclose.rst new file mode 100644 index 000000000..cae5ac0c7 --- /dev/null +++ b/docs/build/html/_sources/python/_autosummary/mlx.core.isclose.rst @@ -0,0 +1,6 @@ +mlx.core.isclose +================ + +.. currentmodule:: mlx.core + +.. autofunction:: isclose \ No newline at end of file diff --git a/docs/build/html/_sources/python/_autosummary/mlx.core.metal.get_active_memory.rst b/docs/build/html/_sources/python/_autosummary/mlx.core.metal.get_active_memory.rst new file mode 100644 index 000000000..b705b936b --- /dev/null +++ b/docs/build/html/_sources/python/_autosummary/mlx.core.metal.get_active_memory.rst @@ -0,0 +1,6 @@ +mlx.core.metal.get\_active\_memory +================================== + +.. currentmodule:: mlx.core.metal + +.. autofunction:: get_active_memory \ No newline at end of file diff --git a/docs/build/html/_sources/python/_autosummary/mlx.core.metal.get_cache_memory.rst b/docs/build/html/_sources/python/_autosummary/mlx.core.metal.get_cache_memory.rst new file mode 100644 index 000000000..bd0359013 --- /dev/null +++ b/docs/build/html/_sources/python/_autosummary/mlx.core.metal.get_cache_memory.rst @@ -0,0 +1,6 @@ +mlx.core.metal.get\_cache\_memory +================================= + +.. currentmodule:: mlx.core.metal + +.. autofunction:: get_cache_memory \ No newline at end of file diff --git a/docs/build/html/_sources/python/_autosummary/mlx.core.metal.get_peak_memory.rst b/docs/build/html/_sources/python/_autosummary/mlx.core.metal.get_peak_memory.rst new file mode 100644 index 000000000..a887cf005 --- /dev/null +++ b/docs/build/html/_sources/python/_autosummary/mlx.core.metal.get_peak_memory.rst @@ -0,0 +1,6 @@ +mlx.core.metal.get\_peak\_memory +================================ + +.. currentmodule:: mlx.core.metal + +.. autofunction:: get_peak_memory \ No newline at end of file diff --git a/docs/build/html/_sources/python/_autosummary/mlx.core.metal.is_available.rst b/docs/build/html/_sources/python/_autosummary/mlx.core.metal.is_available.rst new file mode 100644 index 000000000..b90054291 --- /dev/null +++ b/docs/build/html/_sources/python/_autosummary/mlx.core.metal.is_available.rst @@ -0,0 +1,6 @@ +mlx.core.metal.is\_available +============================ + +.. currentmodule:: mlx.core.metal + +.. autofunction:: is_available \ No newline at end of file diff --git a/docs/build/html/_sources/python/_autosummary/mlx.core.metal.set_cache_limit.rst b/docs/build/html/_sources/python/_autosummary/mlx.core.metal.set_cache_limit.rst new file mode 100644 index 000000000..25a9cac7b --- /dev/null +++ b/docs/build/html/_sources/python/_autosummary/mlx.core.metal.set_cache_limit.rst @@ -0,0 +1,6 @@ +mlx.core.metal.set\_cache\_limit +================================ + +.. currentmodule:: mlx.core.metal + +.. autofunction:: set_cache_limit \ No newline at end of file diff --git a/docs/build/html/_sources/python/_autosummary/mlx.core.metal.set_memory_limit.rst b/docs/build/html/_sources/python/_autosummary/mlx.core.metal.set_memory_limit.rst new file mode 100644 index 000000000..fbe59f6e1 --- /dev/null +++ b/docs/build/html/_sources/python/_autosummary/mlx.core.metal.set_memory_limit.rst @@ -0,0 +1,6 @@ +mlx.core.metal.set\_memory\_limit +================================= + +.. currentmodule:: mlx.core.metal + +.. autofunction:: set_memory_limit \ No newline at end of file diff --git a/docs/build/html/_sources/python/_autosummary/mlx.core.tile.rst b/docs/build/html/_sources/python/_autosummary/mlx.core.tile.rst new file mode 100644 index 000000000..f841d583e --- /dev/null +++ b/docs/build/html/_sources/python/_autosummary/mlx.core.tile.rst @@ -0,0 +1,6 @@ +mlx.core.tile +============= + +.. currentmodule:: mlx.core + +.. autofunction:: tile \ No newline at end of file diff --git a/docs/build/html/_sources/python/_autosummary/mlx.core.topk.rst b/docs/build/html/_sources/python/_autosummary/mlx.core.topk.rst new file mode 100644 index 000000000..6c9f575a9 --- /dev/null +++ b/docs/build/html/_sources/python/_autosummary/mlx.core.topk.rst @@ -0,0 +1,6 @@ +mlx.core.topk +============= + +.. currentmodule:: mlx.core + +.. autofunction:: topk \ No newline at end of file diff --git a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.AdaDelta.rst b/docs/build/html/_sources/python/_autosummary/mlx.optimizers.AdaDelta.rst deleted file mode 100644 index 55792c434..000000000 --- a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.AdaDelta.rst +++ /dev/null @@ -1,19 +0,0 @@ -mlx.optimizers.AdaDelta -======================= - -.. currentmodule:: mlx.optimizers - -.. autoclass:: AdaDelta - - - - - .. rubric:: Methods - - .. autosummary:: - - ~AdaDelta.__init__ - ~AdaDelta.apply_single - ~AdaDelta.init_single - - diff --git a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Adafactor.rst b/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Adafactor.rst deleted file mode 100644 index 9047eea41..000000000 --- a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Adafactor.rst +++ /dev/null @@ -1,19 +0,0 @@ -mlx.optimizers.Adafactor -======================== - -.. currentmodule:: mlx.optimizers - -.. autoclass:: Adafactor - - - - - .. rubric:: Methods - - .. autosummary:: - - ~Adafactor.__init__ - ~Adafactor.apply_single - ~Adafactor.init_single - - diff --git a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Adagrad.rst b/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Adagrad.rst deleted file mode 100644 index c12713e8a..000000000 --- a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Adagrad.rst +++ /dev/null @@ -1,19 +0,0 @@ -mlx.optimizers.Adagrad -====================== - -.. currentmodule:: mlx.optimizers - -.. autoclass:: Adagrad - - - - - .. rubric:: Methods - - .. autosummary:: - - ~Adagrad.__init__ - ~Adagrad.apply_single - ~Adagrad.init_single - - diff --git a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Adam.rst b/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Adam.rst deleted file mode 100644 index 9ca26adfa..000000000 --- a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Adam.rst +++ /dev/null @@ -1,19 +0,0 @@ -mlx.optimizers.Adam -=================== - -.. currentmodule:: mlx.optimizers - -.. autoclass:: Adam - - - - - .. rubric:: Methods - - .. autosummary:: - - ~Adam.__init__ - ~Adam.apply_single - ~Adam.init_single - - diff --git a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.AdamW.rst b/docs/build/html/_sources/python/_autosummary/mlx.optimizers.AdamW.rst deleted file mode 100644 index b5259844f..000000000 --- a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.AdamW.rst +++ /dev/null @@ -1,18 +0,0 @@ -mlx.optimizers.AdamW -==================== - -.. currentmodule:: mlx.optimizers - -.. autoclass:: AdamW - - - - - .. rubric:: Methods - - .. autosummary:: - - ~AdamW.__init__ - ~AdamW.apply_single - - diff --git a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Adamax.rst b/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Adamax.rst deleted file mode 100644 index 73dc7314d..000000000 --- a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Adamax.rst +++ /dev/null @@ -1,19 +0,0 @@ -mlx.optimizers.Adamax -===================== - -.. currentmodule:: mlx.optimizers - -.. autoclass:: Adamax - - - - - .. rubric:: Methods - - .. autosummary:: - - ~Adamax.__init__ - ~Adamax.apply_single - ~Adamax.init_single - - diff --git a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Lion.rst b/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Lion.rst deleted file mode 100644 index 1454aada1..000000000 --- a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Lion.rst +++ /dev/null @@ -1,19 +0,0 @@ -mlx.optimizers.Lion -=================== - -.. currentmodule:: mlx.optimizers - -.. autoclass:: Lion - - - - - .. rubric:: Methods - - .. autosummary:: - - ~Lion.__init__ - ~Lion.apply_single - ~Lion.init_single - - diff --git a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Optimizer.apply_gradients.rst b/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Optimizer.apply_gradients.rst deleted file mode 100644 index 763eeb293..000000000 --- a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Optimizer.apply_gradients.rst +++ /dev/null @@ -1,6 +0,0 @@ -mlx.optimizers.Optimizer.apply\_gradients -========================================= - -.. currentmodule:: mlx.optimizers - -.. automethod:: Optimizer.apply_gradients \ No newline at end of file diff --git a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Optimizer.init.rst b/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Optimizer.init.rst deleted file mode 100644 index e0245cf02..000000000 --- a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Optimizer.init.rst +++ /dev/null @@ -1,6 +0,0 @@ -mlx.optimizers.Optimizer.init -============================= - -.. currentmodule:: mlx.optimizers - -.. automethod:: Optimizer.init \ No newline at end of file diff --git a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Optimizer.state.rst b/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Optimizer.state.rst deleted file mode 100644 index e0bf31dbe..000000000 --- a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Optimizer.state.rst +++ /dev/null @@ -1,6 +0,0 @@ -mlx.optimizers.Optimizer.state -============================== - -.. currentmodule:: mlx.optimizers - -.. autoproperty:: Optimizer.state \ No newline at end of file diff --git a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Optimizer.update.rst b/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Optimizer.update.rst deleted file mode 100644 index e7610999e..000000000 --- a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Optimizer.update.rst +++ /dev/null @@ -1,6 +0,0 @@ -mlx.optimizers.Optimizer.update -=============================== - -.. currentmodule:: mlx.optimizers - -.. automethod:: Optimizer.update \ No newline at end of file diff --git a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.RMSprop.rst b/docs/build/html/_sources/python/_autosummary/mlx.optimizers.RMSprop.rst deleted file mode 100644 index d9ba20078..000000000 --- a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.RMSprop.rst +++ /dev/null @@ -1,19 +0,0 @@ -mlx.optimizers.RMSprop -====================== - -.. currentmodule:: mlx.optimizers - -.. autoclass:: RMSprop - - - - - .. rubric:: Methods - - .. autosummary:: - - ~RMSprop.__init__ - ~RMSprop.apply_single - ~RMSprop.init_single - - diff --git a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.SGD.rst b/docs/build/html/_sources/python/_autosummary/mlx.optimizers.SGD.rst deleted file mode 100644 index 4b6f397ec..000000000 --- a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.SGD.rst +++ /dev/null @@ -1,19 +0,0 @@ -mlx.optimizers.SGD -================== - -.. currentmodule:: mlx.optimizers - -.. autoclass:: SGD - - - - - .. rubric:: Methods - - .. autosummary:: - - ~SGD.__init__ - ~SGD.apply_single - ~SGD.init_single - - diff --git a/docs/build/html/_sources/python/_autosummary_stream/Stream.rst b/docs/build/html/_sources/python/_autosummary_stream/Stream.rst deleted file mode 100644 index 14a00e70b..000000000 --- a/docs/build/html/_sources/python/_autosummary_stream/Stream.rst +++ /dev/null @@ -1,28 +0,0 @@ -mlx.core.Stream -=============== - -.. currentmodule:: mlx.core - -.. autoclass:: Stream - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~Stream.__init__ - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~Stream.device - - \ No newline at end of file diff --git a/docs/build/html/_sources/python/_autosummary_stream/mlx.core.Device.rst b/docs/build/html/_sources/python/_autosummary_stream/mlx.core.Device.rst deleted file mode 100644 index eafe9082b..000000000 --- a/docs/build/html/_sources/python/_autosummary_stream/mlx.core.Device.rst +++ /dev/null @@ -1,28 +0,0 @@ -mlx.core.Device -=============== - -.. currentmodule:: mlx.core - -.. autoclass:: Device - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~Device.__init__ - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~Device.type - - \ No newline at end of file diff --git a/docs/build/html/_sources/python/_autosummary_stream/mlx.core.Stream.rst b/docs/build/html/_sources/python/_autosummary_stream/mlx.core.Stream.rst deleted file mode 100644 index 14a00e70b..000000000 --- a/docs/build/html/_sources/python/_autosummary_stream/mlx.core.Stream.rst +++ /dev/null @@ -1,28 +0,0 @@ -mlx.core.Stream -=============== - -.. currentmodule:: mlx.core - -.. autoclass:: Stream - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~Stream.__init__ - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~Stream.device - - \ No newline at end of file diff --git a/docs/build/html/_sources/python/metal.rst b/docs/build/html/_sources/python/metal.rst new file mode 100644 index 000000000..c11deb4fa --- /dev/null +++ b/docs/build/html/_sources/python/metal.rst @@ -0,0 +1,14 @@ +Metal +===== + +.. currentmodule:: mlx.core.metal + +.. autosummary:: + :toctree: _autosummary + + is_available + get_active_memory + get_peak_memory + get_cache_memory + set_memory_limit + set_cache_limit diff --git a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.GRU.rst b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.GRU.rst new file mode 100644 index 000000000..568e2f6f4 --- /dev/null +++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.GRU.rst @@ -0,0 +1,6 @@ +mlx.nn.GRU +========== + +.. currentmodule:: mlx.nn + +.. autoclass:: GRU \ No newline at end of file diff --git a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.LSTM.rst b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.LSTM.rst new file mode 100644 index 000000000..08344b86d --- /dev/null +++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.LSTM.rst @@ -0,0 +1,6 @@ +mlx.nn.LSTM +=========== + +.. currentmodule:: mlx.nn + +.. autoclass:: LSTM \ No newline at end of file diff --git a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.RNN.rst b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.RNN.rst new file mode 100644 index 000000000..6a6a1edb7 --- /dev/null +++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.RNN.rst @@ -0,0 +1,6 @@ +mlx.nn.RNN +========== + +.. currentmodule:: mlx.nn + +.. autoclass:: RNN \ No newline at end of file diff --git a/docs/build/html/_sources/python/nn/layers.rst b/docs/build/html/_sources/python/nn/layers.rst index f6755e8fe..c0b59b6d4 100644 --- a/docs/build/html/_sources/python/nn/layers.rst +++ b/docs/build/html/_sources/python/nn/layers.rst @@ -21,9 +21,11 @@ Layers Embedding GELU GroupNorm + GRU InstanceNorm LayerNorm Linear + LSTM MaxPool1d MaxPool2d Mish @@ -32,6 +34,7 @@ Layers QuantizedLinear RMSNorm ReLU + RNN RoPE SELU Sequential diff --git a/docs/build/html/_sources/python/ops.rst b/docs/build/html/_sources/python/ops.rst index 2cc2b6d6b..6396bb3c6 100644 --- a/docs/build/html/_sources/python/ops.rst +++ b/docs/build/html/_sources/python/ops.rst @@ -57,6 +57,7 @@ Operations greater_equal identity inner + isclose isnan isposinf isneginf @@ -121,6 +122,8 @@ Operations tan tanh tensordot + tile + topk transpose tri tril diff --git a/docs/build/html/_sources/python/optimizer.rst b/docs/build/html/_sources/python/optimizer.rst deleted file mode 100644 index cf6034dee..000000000 --- a/docs/build/html/_sources/python/optimizer.rst +++ /dev/null @@ -1,23 +0,0 @@ -Optimizer -========= - -.. currentmodule:: mlx.optimizers - -.. autoclass:: Optimizer - - - .. rubric:: Attributes - - .. autosummary:: - :toctree: _autosummary - - Optimizer.state - - .. rubric:: Methods - - .. autosummary:: - :toctree: _autosummary - - Optimizer.apply_gradients - Optimizer.init - Optimizer.update diff --git a/docs/build/html/_sources/usage/function_transforms.rst b/docs/build/html/_sources/usage/function_transforms.rst index 02c5dec48..77e58058a 100644 --- a/docs/build/html/_sources/usage/function_transforms.rst +++ b/docs/build/html/_sources/usage/function_transforms.rst @@ -40,7 +40,7 @@ getting higher order derivatives. Any of the MLX function transformations can be composed in any order to any depth. See the following sections for more information on :ref:`automatic -differentiaion ` and :ref:`automatic vectorization `. +differentiation ` and :ref:`automatic vectorization `. For more information on :func:`compile` see the :ref:`compile documentation `. diff --git a/docs/build/html/_static/documentation_options.js b/docs/build/html/_static/documentation_options.js index a168ebdde..f9bd6663c 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.5.0', + VERSION: '0.6.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 0f5b651d5..337c8fb17 100644 --- a/docs/build/html/cpp/ops.html +++ b/docs/build/html/cpp/ops.html @@ -9,7 +9,7 @@ - Operations — MLX 0.5.0 documentation + Operations — MLX 0.6.0 documentation @@ -134,8 +134,8 @@ - MLX 0.5.0 documentation - Home - + MLX 0.6.0 documentation - Home + @@ -265,6 +265,7 @@
  • mlx.core.greater_equal
  • mlx.core.identity
  • mlx.core.inner
    • +
  • mlx.core.isclose
  • mlx.core.isnan
  • mlx.core.isposinf
  • mlx.core.isneginf
    • @@ -329,6 +330,8 @@
  • mlx.core.tan
  • mlx.core.tanh
  • mlx.core.tensordot
    • +
  • mlx.core.tile
    • +
  • mlx.core.topk
  • mlx.core.transpose
  • mlx.core.tri
  • mlx.core.tril
    • @@ -384,9 +387,18 @@
  • mlx.core.linalg.qr
    • -
  • Neural Networks