From fdf408812372be8d21e6b4f468fc801590005a93 Mon Sep 17 00:00:00 2001 From: Awni Hannun Date: Sat, 17 Feb 2024 13:25:37 -0800 Subject: [PATCH] docs update --- docs/build/html/.buildinfo | 2 +- docs/build/html/_sources/dev/extensions.rst | 2 +- .../python/_autosummary/mlx.core.Stream.rst | 26 +- .../python/_autosummary/stream_class.rst | 28 + .../python/_autosummary_stream/Stream.rst | 28 + .../_autosummary_stream/mlx.core.Device.rst | 28 + .../_autosummary_stream/mlx.core.Stream.rst | 28 + .../_sources/python/devices_and_streams.rst | 3 +- .../nn/_autosummary/mlx.nn.AvgPool1d.rst | 6 + .../nn/_autosummary/mlx.nn.AvgPool2d.rst | 6 + .../nn/_autosummary/mlx.nn.MaxPool1d.rst | 6 + .../nn/_autosummary/mlx.nn.MaxPool2d.rst | 6 + docs/build/html/_sources/python/nn/layers.rst | 4 + .../build/html/_sources/python/optimizers.rst | 20 +- .../_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 + .../mlx.optimizers.cosine_decay.rst | 6 + .../mlx.optimizers.exponential_decay.rst | 6 + .../mlx.optimizers.step_decay.rst | 6 + .../python/optimizers/common_optimizers.rst | 20 + .../_sources/python/optimizers/optimizer.rst | 23 + .../_sources/python/optimizers/schedulers.rst | 13 + .../html/_static/documentation_options.js | 2 +- docs/build/html/cpp/ops.html | 52 +- docs/build/html/dev/extensions.html | 56 +- .../html/examples/linear_regression.html | 52 +- docs/build/html/examples/llama-inference.html | 52 +- docs/build/html/examples/mlp.html | 54 +- docs/build/html/genindex.html | 122 +-- docs/build/html/index.html | 52 +- docs/build/html/install.html | 52 +- docs/build/html/objects.inv | Bin 7646 -> 8122 bytes .../python/_autosummary/mlx.core.Device.html | 61 +- .../python/_autosummary/mlx.core.Dtype.html | 52 +- .../python/_autosummary/mlx.core.Stream.html | 109 +-- .../python/_autosummary/mlx.core.abs.html | 54 +- .../python/_autosummary/mlx.core.add.html | 54 +- .../python/_autosummary/mlx.core.all.html | 54 +- .../_autosummary/mlx.core.allclose.html | 54 +- .../python/_autosummary/mlx.core.any.html | 54 +- .../python/_autosummary/mlx.core.arange.html | 54 +- .../python/_autosummary/mlx.core.arccos.html | 54 +- .../python/_autosummary/mlx.core.arccosh.html | 54 +- .../python/_autosummary/mlx.core.arcsin.html | 54 +- .../python/_autosummary/mlx.core.arcsinh.html | 54 +- .../python/_autosummary/mlx.core.arctan.html | 54 +- .../python/_autosummary/mlx.core.arctanh.html | 54 +- .../python/_autosummary/mlx.core.argmax.html | 54 +- .../python/_autosummary/mlx.core.argmin.html | 54 +- .../_autosummary/mlx.core.argpartition.html | 54 +- .../python/_autosummary/mlx.core.argsort.html | 54 +- .../python/_autosummary/mlx.core.array.T.html | 52 +- .../_autosummary/mlx.core.array.abs.html | 54 +- .../_autosummary/mlx.core.array.all.html | 54 +- .../_autosummary/mlx.core.array.any.html | 54 +- .../_autosummary/mlx.core.array.argmax.html | 54 +- .../_autosummary/mlx.core.array.argmin.html | 54 +- .../_autosummary/mlx.core.array.astype.html | 56 +- .../_autosummary/mlx.core.array.cos.html | 54 +- .../_autosummary/mlx.core.array.dtype.html | 52 +- .../_autosummary/mlx.core.array.exp.html | 54 +- .../python/_autosummary/mlx.core.array.html | 52 +- .../_autosummary/mlx.core.array.item.html | 52 +- .../_autosummary/mlx.core.array.log.html | 54 +- .../_autosummary/mlx.core.array.log1p.html | 54 +- .../mlx.core.array.logsumexp.html | 54 +- .../_autosummary/mlx.core.array.max.html | 54 +- .../_autosummary/mlx.core.array.mean.html | 54 +- .../_autosummary/mlx.core.array.min.html | 54 +- .../_autosummary/mlx.core.array.ndim.html | 52 +- .../_autosummary/mlx.core.array.prod.html | 54 +- .../mlx.core.array.reciprocal.html | 54 +- .../_autosummary/mlx.core.array.reshape.html | 54 +- .../_autosummary/mlx.core.array.round.html | 54 +- .../_autosummary/mlx.core.array.rsqrt.html | 54 +- .../_autosummary/mlx.core.array.shape.html | 52 +- .../_autosummary/mlx.core.array.sin.html | 54 +- .../_autosummary/mlx.core.array.size.html | 52 +- .../_autosummary/mlx.core.array.split.html | 54 +- .../_autosummary/mlx.core.array.sqrt.html | 54 +- .../_autosummary/mlx.core.array.square.html | 54 +- .../_autosummary/mlx.core.array.sum.html | 54 +- .../_autosummary/mlx.core.array.tolist.html | 52 +- .../mlx.core.array.transpose.html | 54 +- .../_autosummary/mlx.core.array.var.html | 54 +- .../_autosummary/mlx.core.array_equal.html | 54 +- .../_autosummary/mlx.core.broadcast_to.html | 54 +- .../python/_autosummary/mlx.core.ceil.html | 54 +- .../python/_autosummary/mlx.core.clip.html | 54 +- .../python/_autosummary/mlx.core.compile.html | 52 +- .../_autosummary/mlx.core.concatenate.html | 54 +- .../python/_autosummary/mlx.core.conv1d.html | 54 +- .../python/_autosummary/mlx.core.conv2d.html | 54 +- .../_autosummary/mlx.core.convolve.html | 54 +- .../python/_autosummary/mlx.core.cos.html | 54 +- .../python/_autosummary/mlx.core.cosh.html | 54 +- .../_autosummary/mlx.core.default_device.html | 61 +- .../_autosummary/mlx.core.default_stream.html | 63 +- .../_autosummary/mlx.core.dequantize.html | 54 +- .../python/_autosummary/mlx.core.diag.html | 54 +- .../_autosummary/mlx.core.diagonal.html | 54 +- .../mlx.core.disable_compile.html | 52 +- .../python/_autosummary/mlx.core.divide.html | 54 +- .../python/_autosummary/mlx.core.divmod.html | 54 +- .../_autosummary/mlx.core.enable_compile.html | 52 +- .../python/_autosummary/mlx.core.equal.html | 54 +- .../python/_autosummary/mlx.core.erf.html | 54 +- .../python/_autosummary/mlx.core.erfinv.html | 54 +- .../python/_autosummary/mlx.core.eval.html | 52 +- .../python/_autosummary/mlx.core.exp.html | 54 +- .../_autosummary/mlx.core.expand_dims.html | 54 +- .../python/_autosummary/mlx.core.eye.html | 56 +- .../python/_autosummary/mlx.core.fft.fft.html | 54 +- .../_autosummary/mlx.core.fft.fft2.html | 54 +- .../_autosummary/mlx.core.fft.fftn.html | 54 +- .../_autosummary/mlx.core.fft.ifft.html | 54 +- .../_autosummary/mlx.core.fft.ifft2.html | 54 +- .../_autosummary/mlx.core.fft.ifftn.html | 54 +- .../_autosummary/mlx.core.fft.irfft.html | 54 +- .../_autosummary/mlx.core.fft.irfft2.html | 54 +- .../_autosummary/mlx.core.fft.irfftn.html | 54 +- .../_autosummary/mlx.core.fft.rfft.html | 54 +- .../_autosummary/mlx.core.fft.rfft2.html | 54 +- .../_autosummary/mlx.core.fft.rfftn.html | 54 +- .../python/_autosummary/mlx.core.flatten.html | 56 +- .../python/_autosummary/mlx.core.floor.html | 54 +- .../_autosummary/mlx.core.floor_divide.html | 54 +- .../python/_autosummary/mlx.core.full.html | 54 +- .../python/_autosummary/mlx.core.grad.html | 52 +- .../python/_autosummary/mlx.core.greater.html | 54 +- .../_autosummary/mlx.core.greater_equal.html | 54 +- .../_autosummary/mlx.core.identity.html | 56 +- .../python/_autosummary/mlx.core.inner.html | 54 +- .../python/_autosummary/mlx.core.isinf.html | 54 +- .../python/_autosummary/mlx.core.isnan.html | 54 +- .../_autosummary/mlx.core.isneginf.html | 56 +- .../_autosummary/mlx.core.isposinf.html | 56 +- .../python/_autosummary/mlx.core.jvp.html | 52 +- .../python/_autosummary/mlx.core.less.html | 54 +- .../_autosummary/mlx.core.less_equal.html | 54 +- .../_autosummary/mlx.core.linalg.norm.html | 54 +- .../_autosummary/mlx.core.linalg.qr.html | 56 +- .../_autosummary/mlx.core.linspace.html | 54 +- .../python/_autosummary/mlx.core.load.html | 54 +- .../python/_autosummary/mlx.core.log.html | 54 +- .../python/_autosummary/mlx.core.log10.html | 54 +- .../python/_autosummary/mlx.core.log1p.html | 54 +- .../python/_autosummary/mlx.core.log2.html | 54 +- .../_autosummary/mlx.core.logaddexp.html | 54 +- .../_autosummary/mlx.core.logical_and.html | 54 +- .../_autosummary/mlx.core.logical_not.html | 54 +- .../_autosummary/mlx.core.logical_or.html | 54 +- .../_autosummary/mlx.core.logsumexp.html | 54 +- .../python/_autosummary/mlx.core.matmul.html | 54 +- .../python/_autosummary/mlx.core.max.html | 54 +- .../python/_autosummary/mlx.core.maximum.html | 54 +- .../python/_autosummary/mlx.core.mean.html | 54 +- .../python/_autosummary/mlx.core.min.html | 54 +- .../python/_autosummary/mlx.core.minimum.html | 54 +- .../_autosummary/mlx.core.moveaxis.html | 54 +- .../_autosummary/mlx.core.multiply.html | 54 +- .../_autosummary/mlx.core.negative.html | 54 +- .../_autosummary/mlx.core.new_stream.html | 57 +- .../python/_autosummary/mlx.core.ones.html | 54 +- .../_autosummary/mlx.core.ones_like.html | 54 +- .../python/_autosummary/mlx.core.outer.html | 54 +- .../python/_autosummary/mlx.core.pad.html | 54 +- .../_autosummary/mlx.core.partition.html | 54 +- .../python/_autosummary/mlx.core.prod.html | 54 +- .../_autosummary/mlx.core.quantize.html | 54 +- .../mlx.core.quantized_matmul.html | 54 +- .../mlx.core.random.bernoulli.html | 54 +- .../mlx.core.random.categorical.html | 54 +- .../_autosummary/mlx.core.random.gumbel.html | 54 +- .../_autosummary/mlx.core.random.key.html | 52 +- .../_autosummary/mlx.core.random.normal.html | 54 +- .../_autosummary/mlx.core.random.randint.html | 54 +- .../_autosummary/mlx.core.random.seed.html | 52 +- .../_autosummary/mlx.core.random.split.html | 54 +- .../mlx.core.random.truncated_normal.html | 54 +- .../_autosummary/mlx.core.random.uniform.html | 56 +- .../_autosummary/mlx.core.reciprocal.html | 54 +- .../python/_autosummary/mlx.core.repeat.html | 56 +- .../python/_autosummary/mlx.core.reshape.html | 56 +- .../python/_autosummary/mlx.core.round.html | 54 +- .../python/_autosummary/mlx.core.rsqrt.html | 54 +- .../python/_autosummary/mlx.core.save.html | 52 +- .../_autosummary/mlx.core.save_gguf.html | 52 +- .../mlx.core.save_safetensors.html | 55 +- .../python/_autosummary/mlx.core.savez.html | 52 +- .../mlx.core.savez_compressed.html | 52 +- .../mlx.core.set_default_device.html | 61 +- .../mlx.core.set_default_stream.html | 70 +- .../python/_autosummary/mlx.core.sigmoid.html | 54 +- .../python/_autosummary/mlx.core.sign.html | 54 +- .../python/_autosummary/mlx.core.sin.html | 54 +- .../python/_autosummary/mlx.core.sinh.html | 54 +- .../python/_autosummary/mlx.core.softmax.html | 54 +- .../python/_autosummary/mlx.core.sort.html | 54 +- .../python/_autosummary/mlx.core.split.html | 54 +- .../python/_autosummary/mlx.core.sqrt.html | 54 +- .../python/_autosummary/mlx.core.square.html | 54 +- .../python/_autosummary/mlx.core.squeeze.html | 54 +- .../python/_autosummary/mlx.core.stack.html | 56 +- .../_autosummary/mlx.core.stop_gradient.html | 54 +- .../_autosummary/mlx.core.subtract.html | 54 +- .../python/_autosummary/mlx.core.sum.html | 54 +- .../_autosummary/mlx.core.swapaxes.html | 54 +- .../python/_autosummary/mlx.core.take.html | 54 +- .../mlx.core.take_along_axis.html | 54 +- .../python/_autosummary/mlx.core.tan.html | 54 +- .../python/_autosummary/mlx.core.tanh.html | 54 +- .../_autosummary/mlx.core.tensordot.html | 54 +- .../_autosummary/mlx.core.transpose.html | 54 +- .../python/_autosummary/mlx.core.tri.html | 56 +- .../python/_autosummary/mlx.core.tril.html | 56 +- .../python/_autosummary/mlx.core.triu.html | 56 +- .../_autosummary/mlx.core.value_and_grad.html | 52 +- .../python/_autosummary/mlx.core.var.html | 54 +- .../python/_autosummary/mlx.core.vjp.html | 52 +- .../python/_autosummary/mlx.core.vmap.html | 52 +- .../python/_autosummary/mlx.core.where.html | 54 +- .../python/_autosummary/mlx.core.zeros.html | 54 +- .../_autosummary/mlx.core.zeros_like.html | 54 +- .../_autosummary/mlx.nn.value_and_grad.html | 52 +- .../_autosummary/mlx.utils.tree_flatten.html | 52 +- .../_autosummary/mlx.utils.tree_map.html | 52 +- .../mlx.utils.tree_unflatten.html | 52 +- .../python/_autosummary/stream_class.html | 807 +++++++++++++++++ .../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 | 52 +- docs/build/html/python/data_types.html | 52 +- .../html/python/devices_and_streams.html | 75 +- docs/build/html/python/fft.html | 52 +- docs/build/html/python/linalg.html | 52 +- docs/build/html/python/nn.html | 56 +- .../python/nn/_autosummary/mlx.nn.ALiBi.html | 58 +- .../nn/_autosummary/mlx.nn.AvgPool1d.html | 817 +++++++++++++++++ .../nn/_autosummary/mlx.nn.AvgPool2d.html | 827 +++++++++++++++++ .../nn/_autosummary/mlx.nn.BatchNorm.html | 58 +- .../python/nn/_autosummary/mlx.nn.Conv1d.html | 52 +- .../python/nn/_autosummary/mlx.nn.Conv2d.html | 52 +- .../nn/_autosummary/mlx.nn.Dropout.html | 52 +- .../nn/_autosummary/mlx.nn.Dropout2d.html | 52 +- .../nn/_autosummary/mlx.nn.Dropout3d.html | 52 +- .../nn/_autosummary/mlx.nn.Embedding.html | 52 +- .../python/nn/_autosummary/mlx.nn.GELU.html | 52 +- .../nn/_autosummary/mlx.nn.GroupNorm.html | 52 +- .../nn/_autosummary/mlx.nn.InstanceNorm.html | 52 +- .../nn/_autosummary/mlx.nn.LayerNorm.html | 52 +- .../python/nn/_autosummary/mlx.nn.Linear.html | 58 +- .../nn/_autosummary/mlx.nn.MaxPool1d.html | 817 +++++++++++++++++ .../nn/_autosummary/mlx.nn.MaxPool2d.html | 827 +++++++++++++++++ .../python/nn/_autosummary/mlx.nn.Mish.html | 58 +- .../nn/_autosummary/mlx.nn.Module.apply.html | 52 +- .../mlx.nn.Module.apply_to_modules.html | 52 +- .../_autosummary/mlx.nn.Module.children.html | 52 +- .../nn/_autosummary/mlx.nn.Module.eval.html | 52 +- .../mlx.nn.Module.filter_and_map.html | 52 +- .../nn/_autosummary/mlx.nn.Module.freeze.html | 52 +- .../mlx.nn.Module.leaf_modules.html | 52 +- .../mlx.nn.Module.load_weights.html | 52 +- .../_autosummary/mlx.nn.Module.modules.html | 52 +- .../mlx.nn.Module.named_modules.html | 52 +- .../mlx.nn.Module.parameters.html | 52 +- .../mlx.nn.Module.save_weights.html | 52 +- .../nn/_autosummary/mlx.nn.Module.state.html | 52 +- .../nn/_autosummary/mlx.nn.Module.train.html | 52 +- .../mlx.nn.Module.trainable_parameters.html | 52 +- .../_autosummary/mlx.nn.Module.training.html | 52 +- .../_autosummary/mlx.nn.Module.unfreeze.html | 52 +- .../nn/_autosummary/mlx.nn.Module.update.html | 52 +- .../mlx.nn.Module.update_modules.html | 52 +- .../mlx.nn.MultiHeadAttention.html | 52 +- .../python/nn/_autosummary/mlx.nn.PReLU.html | 52 +- .../_autosummary/mlx.nn.QuantizedLinear.html | 52 +- .../nn/_autosummary/mlx.nn.RMSNorm.html | 52 +- .../python/nn/_autosummary/mlx.nn.ReLU.html | 52 +- .../python/nn/_autosummary/mlx.nn.RoPE.html | 76 +- .../python/nn/_autosummary/mlx.nn.SELU.html | 52 +- .../nn/_autosummary/mlx.nn.Sequential.html | 52 +- .../python/nn/_autosummary/mlx.nn.SiLU.html | 52 +- .../mlx.nn.SinusoidalPositionalEncoding.html | 52 +- .../nn/_autosummary/mlx.nn.Softshrink.html | 52 +- .../python/nn/_autosummary/mlx.nn.Step.html | 52 +- .../nn/_autosummary/mlx.nn.Transformer.html | 52 +- .../nn/_autosummary/mlx.nn.init.constant.html | 52 +- .../mlx.nn.init.glorot_normal.html | 52 +- .../mlx.nn.init.glorot_uniform.html | 52 +- .../_autosummary/mlx.nn.init.he_normal.html | 52 +- .../_autosummary/mlx.nn.init.he_uniform.html | 52 +- .../nn/_autosummary/mlx.nn.init.identity.html | 52 +- .../nn/_autosummary/mlx.nn.init.normal.html | 52 +- .../nn/_autosummary/mlx.nn.init.uniform.html | 52 +- .../_autosummary_functions/mlx.nn.gelu.html | 52 +- .../mlx.nn.gelu_approx.html | 52 +- .../mlx.nn.gelu_fast_approx.html | 52 +- .../mlx.nn.losses.binary_cross_entropy.html | 52 +- .../mlx.nn.losses.cosine_similarity_loss.html | 52 +- .../mlx.nn.losses.cross_entropy.html | 52 +- .../mlx.nn.losses.gaussian_nll_loss.html | 52 +- .../mlx.nn.losses.hinge_loss.html | 52 +- .../mlx.nn.losses.huber_loss.html | 52 +- .../mlx.nn.losses.kl_div_loss.html | 52 +- .../mlx.nn.losses.l1_loss.html | 52 +- .../mlx.nn.losses.log_cosh_loss.html | 52 +- .../mlx.nn.losses.margin_ranking_loss.html | 52 +- .../mlx.nn.losses.mse_loss.html | 52 +- .../mlx.nn.losses.nll_loss.html | 52 +- .../mlx.nn.losses.smooth_l1_loss.html | 52 +- .../mlx.nn.losses.triplet_loss.html | 52 +- .../_autosummary_functions/mlx.nn.mish.html | 52 +- .../_autosummary_functions/mlx.nn.prelu.html | 52 +- .../_autosummary_functions/mlx.nn.relu.html | 52 +- .../_autosummary_functions/mlx.nn.selu.html | 52 +- .../_autosummary_functions/mlx.nn.silu.html | 52 +- .../mlx.nn.softshrink.html | 52 +- .../_autosummary_functions/mlx.nn.step.html | 52 +- docs/build/html/python/nn/functions.html | 52 +- docs/build/html/python/nn/init.html | 52 +- docs/build/html/python/nn/layers.html | 64 +- docs/build/html/python/nn/losses.html | 52 +- docs/build/html/python/nn/module.html | 52 +- docs/build/html/python/ops.html | 60 +- docs/build/html/python/optimizers.html | 115 +-- .../_autosummary/mlx.optimizers.AdaDelta.html | 819 +++++++++++++++++ .../mlx.optimizers.Adafactor.html | 832 ++++++++++++++++++ .../_autosummary/mlx.optimizers.Adagrad.html | 816 +++++++++++++++++ .../_autosummary/mlx.optimizers.Adam.html | 821 +++++++++++++++++ .../_autosummary/mlx.optimizers.AdamW.html | 821 +++++++++++++++++ .../_autosummary/mlx.optimizers.Adamax.html | 821 +++++++++++++++++ .../_autosummary/mlx.optimizers.Lion.html | 824 +++++++++++++++++ ....optimizers.Optimizer.apply_gradients.html | 799 +++++++++++++++++ .../mlx.optimizers.Optimizer.init.html | 805 +++++++++++++++++ .../mlx.optimizers.Optimizer.state.html | 786 +++++++++++++++++ .../mlx.optimizers.Optimizer.update.html | 796 +++++++++++++++++ .../_autosummary/mlx.optimizers.RMSprop.html | 816 +++++++++++++++++ .../_autosummary/mlx.optimizers.SGD.html | 816 +++++++++++++++++ .../mlx.optimizers.cosine_decay.html | 807 +++++++++++++++++ .../mlx.optimizers.exponential_decay.html | 806 +++++++++++++++++ .../mlx.optimizers.step_decay.html | 807 +++++++++++++++++ .../python/optimizers/common_optimizers.html | 811 +++++++++++++++++ .../html/python/optimizers/optimizer.html | 809 +++++++++++++++++ .../html/python/optimizers/schedulers.html | 793 +++++++++++++++++ docs/build/html/python/random.html | 52 +- docs/build/html/python/transforms.html | 52 +- docs/build/html/python/tree_utils.html | 58 +- docs/build/html/search.html | 52 +- docs/build/html/searchindex.js | 2 +- docs/build/html/usage/compile.html | 54 +- .../build/html/usage/function_transforms.html | 52 +- docs/build/html/usage/indexing.html | 52 +- docs/build/html/usage/lazy_evaluation.html | 52 +- docs/build/html/usage/numpy.html | 52 +- docs/build/html/usage/quick_start.html | 52 +- docs/build/html/usage/saving_and_loading.html | 52 +- docs/build/html/usage/unified_memory.html | 52 +- docs/build/html/usage/using_streams.html | 56 +- 371 files changed, 32812 insertions(+), 6257 deletions(-) create mode 100644 docs/build/html/_sources/python/_autosummary/stream_class.rst create mode 100644 docs/build/html/_sources/python/_autosummary_stream/Stream.rst create mode 100644 docs/build/html/_sources/python/_autosummary_stream/mlx.core.Device.rst create mode 100644 docs/build/html/_sources/python/_autosummary_stream/mlx.core.Stream.rst create mode 100644 docs/build/html/_sources/python/nn/_autosummary/mlx.nn.AvgPool1d.rst create mode 100644 docs/build/html/_sources/python/nn/_autosummary/mlx.nn.AvgPool2d.rst create mode 100644 docs/build/html/_sources/python/nn/_autosummary/mlx.nn.MaxPool1d.rst create mode 100644 docs/build/html/_sources/python/nn/_autosummary/mlx.nn.MaxPool2d.rst create mode 100644 docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.AdaDelta.rst create mode 100644 docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.Adafactor.rst create mode 100644 docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.Adagrad.rst create mode 100644 docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.Adam.rst create mode 100644 docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.AdamW.rst create mode 100644 docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.Adamax.rst create mode 100644 docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.Lion.rst create mode 100644 docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.Optimizer.apply_gradients.rst create mode 100644 docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.Optimizer.init.rst create mode 100644 docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.Optimizer.state.rst create mode 100644 docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.Optimizer.update.rst create mode 100644 docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.RMSprop.rst create mode 100644 docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.SGD.rst create mode 100644 docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.cosine_decay.rst create mode 100644 docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.exponential_decay.rst create mode 100644 docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.step_decay.rst create mode 100644 docs/build/html/_sources/python/optimizers/common_optimizers.rst create mode 100644 docs/build/html/_sources/python/optimizers/optimizer.rst create mode 100644 docs/build/html/_sources/python/optimizers/schedulers.rst create mode 100644 docs/build/html/python/_autosummary/stream_class.html create mode 100644 docs/build/html/python/_autosummary_stream/Stream.html create mode 100644 docs/build/html/python/_autosummary_stream/mlx.core.Device.html create mode 100644 docs/build/html/python/_autosummary_stream/mlx.core.Stream.html create mode 100644 docs/build/html/python/nn/_autosummary/mlx.nn.AvgPool1d.html create mode 100644 docs/build/html/python/nn/_autosummary/mlx.nn.AvgPool2d.html create mode 100644 docs/build/html/python/nn/_autosummary/mlx.nn.MaxPool1d.html create mode 100644 docs/build/html/python/nn/_autosummary/mlx.nn.MaxPool2d.html create mode 100644 docs/build/html/python/optimizers/_autosummary/mlx.optimizers.AdaDelta.html create mode 100644 docs/build/html/python/optimizers/_autosummary/mlx.optimizers.Adafactor.html create mode 100644 docs/build/html/python/optimizers/_autosummary/mlx.optimizers.Adagrad.html create mode 100644 docs/build/html/python/optimizers/_autosummary/mlx.optimizers.Adam.html create mode 100644 docs/build/html/python/optimizers/_autosummary/mlx.optimizers.AdamW.html create mode 100644 docs/build/html/python/optimizers/_autosummary/mlx.optimizers.Adamax.html create mode 100644 docs/build/html/python/optimizers/_autosummary/mlx.optimizers.Lion.html create mode 100644 docs/build/html/python/optimizers/_autosummary/mlx.optimizers.Optimizer.apply_gradients.html create mode 100644 docs/build/html/python/optimizers/_autosummary/mlx.optimizers.Optimizer.init.html create mode 100644 docs/build/html/python/optimizers/_autosummary/mlx.optimizers.Optimizer.state.html create mode 100644 docs/build/html/python/optimizers/_autosummary/mlx.optimizers.Optimizer.update.html create mode 100644 docs/build/html/python/optimizers/_autosummary/mlx.optimizers.RMSprop.html create mode 100644 docs/build/html/python/optimizers/_autosummary/mlx.optimizers.SGD.html create mode 100644 docs/build/html/python/optimizers/_autosummary/mlx.optimizers.cosine_decay.html create mode 100644 docs/build/html/python/optimizers/_autosummary/mlx.optimizers.exponential_decay.html create mode 100644 docs/build/html/python/optimizers/_autosummary/mlx.optimizers.step_decay.html create mode 100644 docs/build/html/python/optimizers/common_optimizers.html create mode 100644 docs/build/html/python/optimizers/optimizer.html create mode 100644 docs/build/html/python/optimizers/schedulers.html diff --git a/docs/build/html/.buildinfo b/docs/build/html/.buildinfo index 0241e00e4..e1d1fbf95 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: b49cb089891263e82aedf5bc4cacbe8a +config: 59497ac668d2f3a880c24eaae6f1b8ae tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/build/html/_sources/dev/extensions.rst b/docs/build/html/_sources/dev/extensions.rst index 3563305bf..5f63c6337 100644 --- a/docs/build/html/_sources/dev/extensions.rst +++ b/docs/build/html/_sources/dev/extensions.rst @@ -35,7 +35,7 @@ However, you work with vector math libraries often and realize that the You would really like the part of your applications that does this operation on the CPU to be very fast - so you decide that you want it to rely on the ``axpby`` routine provided by the Accelerate_ framework. Continuing to impose -our assumptions on to you, let's also assume that you want to learn how add +our assumptions on to you, let's also assume that you want to learn how to add your own implementation for the gradients of your new operation while going over the ins-and-outs of the MLX framework. diff --git a/docs/build/html/_sources/python/_autosummary/mlx.core.Stream.rst b/docs/build/html/_sources/python/_autosummary/mlx.core.Stream.rst index 14a00e70b..9c8f4770e 100644 --- a/docs/build/html/_sources/python/_autosummary/mlx.core.Stream.rst +++ b/docs/build/html/_sources/python/_autosummary/mlx.core.Stream.rst @@ -1,28 +1,6 @@ -mlx.core.Stream +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 +.. autofunction:: stream \ No newline at end of file diff --git a/docs/build/html/_sources/python/_autosummary/stream_class.rst b/docs/build/html/_sources/python/_autosummary/stream_class.rst new file mode 100644 index 000000000..14a00e70b --- /dev/null +++ b/docs/build/html/_sources/python/_autosummary/stream_class.rst @@ -0,0 +1,28 @@ +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/Stream.rst b/docs/build/html/_sources/python/_autosummary_stream/Stream.rst new file mode 100644 index 000000000..14a00e70b --- /dev/null +++ b/docs/build/html/_sources/python/_autosummary_stream/Stream.rst @@ -0,0 +1,28 @@ +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 new file mode 100644 index 000000000..eafe9082b --- /dev/null +++ b/docs/build/html/_sources/python/_autosummary_stream/mlx.core.Device.rst @@ -0,0 +1,28 @@ +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 new file mode 100644 index 000000000..14a00e70b --- /dev/null +++ b/docs/build/html/_sources/python/_autosummary_stream/mlx.core.Stream.rst @@ -0,0 +1,28 @@ +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/devices_and_streams.rst b/docs/build/html/_sources/python/devices_and_streams.rst index bb9dfae2f..e16ab9875 100644 --- a/docs/build/html/_sources/python/devices_and_streams.rst +++ b/docs/build/html/_sources/python/devices_and_streams.rst @@ -9,9 +9,10 @@ Devices and Streams :toctree: _autosummary Device + Stream default_device set_default_device - Stream default_stream new_stream set_default_stream + stream diff --git a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.AvgPool1d.rst b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.AvgPool1d.rst new file mode 100644 index 000000000..55ec40f1b --- /dev/null +++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.AvgPool1d.rst @@ -0,0 +1,6 @@ +mlx.nn.AvgPool1d +================ + +.. currentmodule:: mlx.nn + +.. autoclass:: AvgPool1d \ No newline at end of file diff --git a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.AvgPool2d.rst b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.AvgPool2d.rst new file mode 100644 index 000000000..a31b6f432 --- /dev/null +++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.AvgPool2d.rst @@ -0,0 +1,6 @@ +mlx.nn.AvgPool2d +================ + +.. currentmodule:: mlx.nn + +.. autoclass:: AvgPool2d \ No newline at end of file diff --git a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.MaxPool1d.rst b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.MaxPool1d.rst new file mode 100644 index 000000000..43ac8cada --- /dev/null +++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.MaxPool1d.rst @@ -0,0 +1,6 @@ +mlx.nn.MaxPool1d +================ + +.. currentmodule:: mlx.nn + +.. autoclass:: MaxPool1d \ No newline at end of file diff --git a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.MaxPool2d.rst b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.MaxPool2d.rst new file mode 100644 index 000000000..ad93796f4 --- /dev/null +++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.MaxPool2d.rst @@ -0,0 +1,6 @@ +mlx.nn.MaxPool2d +================ + +.. currentmodule:: mlx.nn + +.. autoclass:: MaxPool2d \ 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 ef099ef2f..0f5fca9db 100644 --- a/docs/build/html/_sources/python/nn/layers.rst +++ b/docs/build/html/_sources/python/nn/layers.rst @@ -10,6 +10,8 @@ Layers :template: nn-module-template.rst ALiBi + AvgPool1d + AvgPool2d BatchNorm Conv1d Conv2d @@ -22,6 +24,8 @@ Layers InstanceNorm LayerNorm Linear + MaxPool1d + MaxPool2d Mish MultiHeadAttention PReLU diff --git a/docs/build/html/_sources/python/optimizers.rst b/docs/build/html/_sources/python/optimizers.rst index 4ef43d50f..f437ddc15 100644 --- a/docs/build/html/_sources/python/optimizers.rst +++ b/docs/build/html/_sources/python/optimizers.rst @@ -31,20 +31,6 @@ model's parameters and the **optimizer state**. .. toctree:: - optimizer - -.. currentmodule:: mlx.optimizers - -.. autosummary:: - :toctree: _autosummary - :template: optimizers-template.rst - - SGD - RMSprop - Adagrad - Adafactor - AdaDelta - Adam - AdamW - Adamax - Lion + optimizers/optimizer + optimizers/common_optimizers + optimizers/schedulers diff --git a/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.AdaDelta.rst b/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.AdaDelta.rst new file mode 100644 index 000000000..55792c434 --- /dev/null +++ b/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.AdaDelta.rst @@ -0,0 +1,19 @@ +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/optimizers/_autosummary/mlx.optimizers.Adafactor.rst b/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.Adafactor.rst new file mode 100644 index 000000000..9047eea41 --- /dev/null +++ b/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.Adafactor.rst @@ -0,0 +1,19 @@ +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/optimizers/_autosummary/mlx.optimizers.Adagrad.rst b/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.Adagrad.rst new file mode 100644 index 000000000..c12713e8a --- /dev/null +++ b/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.Adagrad.rst @@ -0,0 +1,19 @@ +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/optimizers/_autosummary/mlx.optimizers.Adam.rst b/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.Adam.rst new file mode 100644 index 000000000..9ca26adfa --- /dev/null +++ b/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.Adam.rst @@ -0,0 +1,19 @@ +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/optimizers/_autosummary/mlx.optimizers.AdamW.rst b/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.AdamW.rst new file mode 100644 index 000000000..b5259844f --- /dev/null +++ b/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.AdamW.rst @@ -0,0 +1,18 @@ +mlx.optimizers.AdamW +==================== + +.. currentmodule:: mlx.optimizers + +.. autoclass:: AdamW + + + + + .. rubric:: Methods + + .. autosummary:: + + ~AdamW.__init__ + ~AdamW.apply_single + + diff --git a/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.Adamax.rst b/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.Adamax.rst new file mode 100644 index 000000000..73dc7314d --- /dev/null +++ b/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.Adamax.rst @@ -0,0 +1,19 @@ +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/optimizers/_autosummary/mlx.optimizers.Lion.rst b/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.Lion.rst new file mode 100644 index 000000000..1454aada1 --- /dev/null +++ b/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.Lion.rst @@ -0,0 +1,19 @@ +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/optimizers/_autosummary/mlx.optimizers.Optimizer.apply_gradients.rst b/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.Optimizer.apply_gradients.rst new file mode 100644 index 000000000..763eeb293 --- /dev/null +++ b/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.Optimizer.apply_gradients.rst @@ -0,0 +1,6 @@ +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/optimizers/_autosummary/mlx.optimizers.Optimizer.init.rst b/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.Optimizer.init.rst new file mode 100644 index 000000000..e0245cf02 --- /dev/null +++ b/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.Optimizer.init.rst @@ -0,0 +1,6 @@ +mlx.optimizers.Optimizer.init +============================= + +.. currentmodule:: mlx.optimizers + +.. automethod:: Optimizer.init \ No newline at end of file diff --git a/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.Optimizer.state.rst b/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.Optimizer.state.rst new file mode 100644 index 000000000..e0bf31dbe --- /dev/null +++ b/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.Optimizer.state.rst @@ -0,0 +1,6 @@ +mlx.optimizers.Optimizer.state +============================== + +.. currentmodule:: mlx.optimizers + +.. autoproperty:: Optimizer.state \ No newline at end of file diff --git a/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.Optimizer.update.rst b/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.Optimizer.update.rst new file mode 100644 index 000000000..e7610999e --- /dev/null +++ b/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.Optimizer.update.rst @@ -0,0 +1,6 @@ +mlx.optimizers.Optimizer.update +=============================== + +.. currentmodule:: mlx.optimizers + +.. automethod:: Optimizer.update \ No newline at end of file diff --git a/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.RMSprop.rst b/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.RMSprop.rst new file mode 100644 index 000000000..d9ba20078 --- /dev/null +++ b/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.RMSprop.rst @@ -0,0 +1,19 @@ +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/optimizers/_autosummary/mlx.optimizers.SGD.rst b/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.SGD.rst new file mode 100644 index 000000000..4b6f397ec --- /dev/null +++ b/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.SGD.rst @@ -0,0 +1,19 @@ +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/optimizers/_autosummary/mlx.optimizers.cosine_decay.rst b/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.cosine_decay.rst new file mode 100644 index 000000000..051af2424 --- /dev/null +++ b/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.cosine_decay.rst @@ -0,0 +1,6 @@ +mlx.optimizers.cosine\_decay +============================ + +.. currentmodule:: mlx.optimizers + +.. autofunction:: cosine_decay \ No newline at end of file diff --git a/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.exponential_decay.rst b/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.exponential_decay.rst new file mode 100644 index 000000000..b5ceab510 --- /dev/null +++ b/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.exponential_decay.rst @@ -0,0 +1,6 @@ +mlx.optimizers.exponential\_decay +================================= + +.. currentmodule:: mlx.optimizers + +.. autofunction:: exponential_decay \ No newline at end of file diff --git a/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.step_decay.rst b/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.step_decay.rst new file mode 100644 index 000000000..2d691ecb2 --- /dev/null +++ b/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.step_decay.rst @@ -0,0 +1,6 @@ +mlx.optimizers.step\_decay +========================== + +.. currentmodule:: mlx.optimizers + +.. autofunction:: step_decay \ No newline at end of file diff --git a/docs/build/html/_sources/python/optimizers/common_optimizers.rst b/docs/build/html/_sources/python/optimizers/common_optimizers.rst new file mode 100644 index 000000000..41b3fba03 --- /dev/null +++ b/docs/build/html/_sources/python/optimizers/common_optimizers.rst @@ -0,0 +1,20 @@ +.. _common_optimizers: + +Common Optimizers +================= + +.. currentmodule:: mlx.optimizers + +.. autosummary:: + :toctree: _autosummary + :template: optimizers-template.rst + + SGD + RMSprop + Adagrad + Adafactor + AdaDelta + Adam + AdamW + Adamax + Lion diff --git a/docs/build/html/_sources/python/optimizers/optimizer.rst b/docs/build/html/_sources/python/optimizers/optimizer.rst new file mode 100644 index 000000000..cf6034dee --- /dev/null +++ b/docs/build/html/_sources/python/optimizers/optimizer.rst @@ -0,0 +1,23 @@ +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/python/optimizers/schedulers.rst b/docs/build/html/_sources/python/optimizers/schedulers.rst new file mode 100644 index 000000000..a83883ddb --- /dev/null +++ b/docs/build/html/_sources/python/optimizers/schedulers.rst @@ -0,0 +1,13 @@ +.. _schedulers: + +Schedulers +========== + +.. currentmodule:: mlx.optimizers + +.. autosummary:: + :toctree: _autosummary + + step_decay + exponential_decay + cosine_decay diff --git a/docs/build/html/_static/documentation_options.js b/docs/build/html/_static/documentation_options.js index ff2bcd035..a117f34ff 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.2.0', + VERSION: '0.3.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 fc78b923d..0c9ffa373 100644 --- a/docs/build/html/cpp/ops.html +++ b/docs/build/html/cpp/ops.html @@ -9,7 +9,7 @@ - Operations — MLX 0.2.0 documentation + Operations — MLX 0.3.0 documentation @@ -134,8 +134,8 @@ - MLX 0.2.0 documentation - Home - + MLX 0.3.0 documentation - Home + @@ -206,12 +206,13 @@
  • Devices and Streams
  • Operations