2023-12-06 04:10:03 +08:00
2023-11-30 04:41:56 +08:00
<!DOCTYPE html>
2023-12-06 04:10:03 +08:00
< html lang = "en" data-content_root = "" >
< head >
< meta charset = "utf-8" / >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" / > < meta name = "generator" content = "Docutils 0.18.1: http://docutils.sourceforge.net/" / >
2024-01-04 12:14:05 +08:00
< title > MLX — MLX 0.0.7 documentation< / title >
2023-12-06 04:10:03 +08:00
< script data-cfasync = "false" >
document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
document.documentElement.dataset.theme = localStorage.getItem("theme") || "light";
< / script >
<!-- Loaded before other Sphinx assets -->
< link href = "_static/styles/theme.css?digest=5b4479735964841361fd" rel = "stylesheet" / >
< link href = "_static/styles/bootstrap.css?digest=5b4479735964841361fd" rel = "stylesheet" / >
< link href = "_static/styles/pydata-sphinx-theme.css?digest=5b4479735964841361fd" rel = "stylesheet" / >
< link href = "_static/vendor/fontawesome/6.1.2/css/all.min.css?digest=5b4479735964841361fd" rel = "stylesheet" / >
< link rel = "preload" as = "font" type = "font/woff2" crossorigin href = "_static/vendor/fontawesome/6.1.2/webfonts/fa-solid-900.woff2" / >
< link rel = "preload" as = "font" type = "font/woff2" crossorigin href = "_static/vendor/fontawesome/6.1.2/webfonts/fa-brands-400.woff2" / >
< link rel = "preload" as = "font" type = "font/woff2" crossorigin href = "_static/vendor/fontawesome/6.1.2/webfonts/fa-regular-400.woff2" / >
< link rel = "stylesheet" type = "text/css" href = "_static/pygments.css" / >
< link rel = "stylesheet" href = "_static/styles/sphinx-book-theme.css?digest=14f4ca6b54d191a8c7657f6c759bf11a5fb86285" type = "text/css" / >
<!-- Pre - loaded scripts that we'll load fully later -->
< link rel = "preload" as = "script" href = "_static/scripts/bootstrap.js?digest=5b4479735964841361fd" / >
< link rel = "preload" as = "script" href = "_static/scripts/pydata-sphinx-theme.js?digest=5b4479735964841361fd" / >
< script src = "_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=5b4479735964841361fd" > < / script >
< script data-url_root = "./" id = "documentation_options" src = "_static/documentation_options.js" > < / script >
< script src = "_static/jquery.js" > < / script >
< script src = "_static/underscore.js" > < / script >
< script src = "_static/_sphinx_javascript_frameworks_compat.js" > < / script >
< script src = "_static/doctools.js" > < / script >
< script src = "_static/scripts/sphinx-book-theme.js?digest=5a5c038af52cf7bc1a1ec88eea08e6366ee68824" > < / script >
< script > DOCUMENTATION _OPTIONS . pagename = 'index' ; < / script >
2023-11-30 04:41:56 +08:00
< link rel = "index" title = "Index" href = "genindex.html" / >
< link rel = "search" title = "Search" href = "search.html" / >
2023-12-06 04:10:03 +08:00
< link rel = "next" title = "Build and Install" href = "install.html" / >
< meta name = "viewport" content = "width=device-width, initial-scale=1" / >
< meta name = "docsearch:language" content = "en" / >
< / head >
< body data-bs-spy = "scroll" data-bs-target = ".bd-toc-nav" data-offset = "180" data-bs-root-margin = "0px 0px -60%" data-default-mode = "" >
< a class = "skip-link" href = "#main-content" > Skip to main content< / a >
< div id = "pst-scroll-pixel-helper" > < / div >
< button type = "button" class = "btn rounded-pill" id = "pst-back-to-top" >
< i class = "fa-solid fa-arrow-up" > < / i >
Back to top
< / button >
< input type = "checkbox"
class="sidebar-toggle"
name="__primary"
id="__primary"/>
< label class = "overlay overlay-primary" for = "__primary" > < / label >
< input type = "checkbox"
class="sidebar-toggle"
name="__secondary"
id="__secondary"/>
< label class = "overlay overlay-secondary" for = "__secondary" > < / label >
< div class = "search-button__wrapper" >
< div class = "search-button__overlay" > < / div >
< div class = "search-button__search-container" >
< form class = "bd-search d-flex align-items-center"
action="search.html"
method="get">
< i class = "fa-solid fa-magnifying-glass" > < / i >
< input type = "search"
class="form-control"
name="q"
id="search-input"
placeholder="Search..."
aria-label="Search..."
autocomplete="off"
autocorrect="off"
autocapitalize="off"
spellcheck="false"/>
< span class = "search-button__kbd-shortcut" > < kbd class = "kbd-shortcut__modifier" > Ctrl< / kbd > +< kbd > K< / kbd > < / span >
< / form > < / div >
< / div >
< nav class = "bd-header navbar navbar-expand-lg bd-navbar" >
< / nav >
< div class = "bd-container" >
< div class = "bd-container__inner bd-page-width" >
< div class = "bd-sidebar-primary bd-sidebar" >
< div class = "sidebar-header-items sidebar-primary__section" >
< / div >
< div class = "sidebar-primary-items__start sidebar-primary__section" >
< div class = "sidebar-primary-item" >
< a class = "navbar-brand logo" href = "#" >
2024-01-04 12:14:05 +08:00
< img src = "_static/mlx_logo.png" class = "logo__image only-light" alt = "MLX 0.0.7 documentation - Home" / >
< script > document . write ( ` <img src="_static/mlx_logo.png" class="logo__image only-dark" alt="MLX 0.0.7 documentation - Home"/> ` ) ; < / script >
2023-12-06 04:10:03 +08:00
< / a > < / div >
< div class = "sidebar-primary-item" > < nav class = "bd-links" id = "bd-docs-nav" aria-label = "Main" >
< div class = "bd-toc-item navbar-nav active" >
< p aria-level = "2" class = "caption" role = "heading" > < span class = "caption-text" > Install< / span > < / p >
< ul class = "nav bd-sidenav" >
2023-11-30 04:41:56 +08:00
< li class = "toctree-l1" > < a class = "reference internal" href = "install.html" > Build and Install< / a > < / li >
< / ul >
2023-12-06 04:10:03 +08:00
< p aria-level = "2" class = "caption" role = "heading" > < span class = "caption-text" > Usage< / span > < / p >
< ul class = "nav bd-sidenav" >
2023-11-30 04:41:56 +08:00
< li class = "toctree-l1" > < a class = "reference internal" href = "quick_start.html" > Quick Start Guide< / a > < / li >
2023-12-08 11:46:44 +08:00
< li class = "toctree-l1" > < a class = "reference internal" href = "unified_memory.html" > Unified Memory< / a > < / li >
2023-11-30 04:41:56 +08:00
< li class = "toctree-l1" > < a class = "reference internal" href = "using_streams.html" > Using Streams< / a > < / li >
< / ul >
2023-12-06 04:10:03 +08:00
< p aria-level = "2" class = "caption" role = "heading" > < span class = "caption-text" > Examples< / span > < / p >
< ul class = "nav bd-sidenav" >
2023-11-30 04:41:56 +08:00
< li class = "toctree-l1" > < a class = "reference internal" href = "examples/linear_regression.html" > Linear Regression< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "examples/mlp.html" > Multi-Layer Perceptron< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "examples/llama-inference.html" > LLM inference< / a > < / li >
< / ul >
2023-12-06 04:10:03 +08:00
< p aria-level = "2" class = "caption" role = "heading" > < span class = "caption-text" > Python API Reference< / span > < / p >
< ul class = "nav bd-sidenav" >
< li class = "toctree-l1 has-children" > < a class = "reference internal" href = "python/array.html" > Array< / a > < input class = "toctree-checkbox" id = "toctree-checkbox-1" name = "toctree-checkbox-1" type = "checkbox" / > < label class = "toctree-toggle" for = "toctree-checkbox-1" > < i class = "fa-solid fa-chevron-down" > < / i > < / label > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.array.html" > mlx.core.array< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.array.astype.html" > mlx.core.array.astype< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.array.item.html" > mlx.core.array.item< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.array.tolist.html" > mlx.core.array.tolist< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.array.dtype.html" > mlx.core.array.dtype< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.array.ndim.html" > mlx.core.array.ndim< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.array.shape.html" > mlx.core.array.shape< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.array.size.html" > mlx.core.array.size< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.Dtype.html" > mlx.core.Dtype< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.array.abs.html" > mlx.core.array.abs< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.array.all.html" > mlx.core.array.all< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.array.any.html" > mlx.core.array.any< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.array.argmax.html" > mlx.core.array.argmax< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.array.argmin.html" > mlx.core.array.argmin< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.array.cos.html" > mlx.core.array.cos< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.array.dtype.html" > mlx.core.array.dtype< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.array.exp.html" > mlx.core.array.exp< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.array.log.html" > mlx.core.array.log< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.array.log1p.html" > mlx.core.array.log1p< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.array.logsumexp.html" > mlx.core.array.logsumexp< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.array.max.html" > mlx.core.array.max< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.array.mean.html" > mlx.core.array.mean< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.array.min.html" > mlx.core.array.min< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.array.prod.html" > mlx.core.array.prod< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.array.reciprocal.html" > mlx.core.array.reciprocal< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.array.reshape.html" > mlx.core.array.reshape< / a > < / li >
2023-12-22 14:13:41 +08:00
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.array.round.html" > mlx.core.array.round< / a > < / li >
2023-12-06 04:10:03 +08:00
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.array.rsqrt.html" > mlx.core.array.rsqrt< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.array.sin.html" > mlx.core.array.sin< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.array.split.html" > mlx.core.array.split< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.array.sqrt.html" > mlx.core.array.sqrt< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.array.square.html" > mlx.core.array.square< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.array.sum.html" > mlx.core.array.sum< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.array.transpose.html" > mlx.core.array.transpose< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.array.T.html" > mlx.core.array.T< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.array.var.html" > mlx.core.array.var< / a > < / li >
2023-11-30 04:41:56 +08:00
< / ul >
2023-12-06 04:10:03 +08:00
< / li >
< li class = "toctree-l1 has-children" > < a class = "reference internal" href = "python/devices_and_streams.html" > Devices and Streams< / a > < input class = "toctree-checkbox" id = "toctree-checkbox-2" name = "toctree-checkbox-2" type = "checkbox" / > < label class = "toctree-toggle" for = "toctree-checkbox-2" > < i class = "fa-solid fa-chevron-down" > < / i > < / label > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.Device.html" > mlx.core.Device< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.default_device.html" > mlx.core.default_device< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.set_default_device.html" > mlx.core.set_default_device< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.Stream.html" > mlx.core.Stream< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.default_stream.html" > mlx.core.default_stream< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.new_stream.html" > mlx.core.new_stream< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.set_default_stream.html" > mlx.core.set_default_stream< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l1 has-children" > < a class = "reference internal" href = "python/ops.html" > Operations< / a > < input class = "toctree-checkbox" id = "toctree-checkbox-3" name = "toctree-checkbox-3" type = "checkbox" / > < label class = "toctree-toggle" for = "toctree-checkbox-3" > < i class = "fa-solid fa-chevron-down" > < / i > < / label > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.abs.html" > mlx.core.abs< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.add.html" > mlx.core.add< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.all.html" > mlx.core.all< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.allclose.html" > mlx.core.allclose< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.any.html" > mlx.core.any< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.arange.html" > mlx.core.arange< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.arccos.html" > mlx.core.arccos< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.arccosh.html" > mlx.core.arccosh< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.arcsin.html" > mlx.core.arcsin< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.arcsinh.html" > mlx.core.arcsinh< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.arctan.html" > mlx.core.arctan< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.arctanh.html" > mlx.core.arctanh< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.argmax.html" > mlx.core.argmax< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.argmin.html" > mlx.core.argmin< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.argpartition.html" > mlx.core.argpartition< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.argsort.html" > mlx.core.argsort< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.array_equal.html" > mlx.core.array_equal< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.broadcast_to.html" > mlx.core.broadcast_to< / a > < / li >
2023-12-18 05:23:03 +08:00
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.ceil.html" > mlx.core.ceil< / a > < / li >
2023-12-22 14:13:41 +08:00
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.clip.html" > mlx.core.clip< / a > < / li >
2023-12-06 04:10:03 +08:00
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.concatenate.html" > mlx.core.concatenate< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.convolve.html" > mlx.core.convolve< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.conv1d.html" > mlx.core.conv1d< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.conv2d.html" > mlx.core.conv2d< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.cos.html" > mlx.core.cos< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.cosh.html" > mlx.core.cosh< / a > < / li >
2023-12-22 14:13:41 +08:00
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.dequantize.html" > mlx.core.dequantize< / a > < / li >
2023-12-06 04:10:03 +08:00
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.divide.html" > mlx.core.divide< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.equal.html" > mlx.core.equal< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.erf.html" > mlx.core.erf< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.erfinv.html" > mlx.core.erfinv< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.exp.html" > mlx.core.exp< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.expand_dims.html" > mlx.core.expand_dims< / a > < / li >
2023-12-14 06:46:24 +08:00
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.eye.html" > mlx.core.eye< / a > < / li >
2023-12-18 05:23:03 +08:00
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.flatten.html" > mlx.core.flatten< / a > < / li >
2023-12-22 14:13:41 +08:00
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.floor.html" > mlx.core.floor< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.floor_divide.html" > mlx.core.floor_divide< / a > < / li >
2023-12-06 04:10:03 +08:00
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.full.html" > mlx.core.full< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.greater.html" > mlx.core.greater< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.greater_equal.html" > mlx.core.greater_equal< / a > < / li >
2023-12-14 06:46:24 +08:00
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.identity.html" > mlx.core.identity< / a > < / li >
2023-12-06 04:10:03 +08:00
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.less.html" > mlx.core.less< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.less_equal.html" > mlx.core.less_equal< / a > < / li >
2023-12-22 14:13:41 +08:00
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.linspace.html" > mlx.core.linspace< / a > < / li >
2023-12-06 04:10:03 +08:00
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.load.html" > mlx.core.load< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.log.html" > mlx.core.log< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.log2.html" > mlx.core.log2< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.log10.html" > mlx.core.log10< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.log1p.html" > mlx.core.log1p< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.logaddexp.html" > mlx.core.logaddexp< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.logical_not.html" > mlx.core.logical_not< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.logsumexp.html" > mlx.core.logsumexp< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.matmul.html" > mlx.core.matmul< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.max.html" > mlx.core.max< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.maximum.html" > mlx.core.maximum< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.mean.html" > mlx.core.mean< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.min.html" > mlx.core.min< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.minimum.html" > mlx.core.minimum< / a > < / li >
2023-12-18 05:23:03 +08:00
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.moveaxis.html" > mlx.core.moveaxis< / a > < / li >
2023-12-06 04:10:03 +08:00
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.multiply.html" > mlx.core.multiply< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.negative.html" > mlx.core.negative< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.ones.html" > mlx.core.ones< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.ones_like.html" > mlx.core.ones_like< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.partition.html" > mlx.core.partition< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.pad.html" > mlx.core.pad< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.prod.html" > mlx.core.prod< / a > < / li >
2023-12-22 14:13:41 +08:00
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.quantize.html" > mlx.core.quantize< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.quantized_matmul.html" > mlx.core.quantized_matmul< / a > < / li >
2023-12-06 04:10:03 +08:00
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.reciprocal.html" > mlx.core.reciprocal< / a > < / li >
2024-01-04 12:14:05 +08:00
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.repeat.html" > mlx.core.repeat< / a > < / li >
2023-12-06 04:10:03 +08:00
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.reshape.html" > mlx.core.reshape< / a > < / li >
2023-12-22 14:13:41 +08:00
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.round.html" > mlx.core.round< / a > < / li >
2023-12-06 04:10:03 +08:00
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.rsqrt.html" > mlx.core.rsqrt< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.save.html" > mlx.core.save< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.savez.html" > mlx.core.savez< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.savez_compressed.html" > mlx.core.savez_compressed< / a > < / li >
2024-01-04 12:14:05 +08:00
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.save_safetensors.html" > mlx.core.save_safetensors< / a > < / li >
2023-12-06 04:10:03 +08:00
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.sigmoid.html" > mlx.core.sigmoid< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.sign.html" > mlx.core.sign< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.sin.html" > mlx.core.sin< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.sinh.html" > mlx.core.sinh< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.softmax.html" > mlx.core.softmax< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.sort.html" > mlx.core.sort< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.split.html" > mlx.core.split< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.sqrt.html" > mlx.core.sqrt< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.square.html" > mlx.core.square< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.squeeze.html" > mlx.core.squeeze< / a > < / li >
2023-12-18 05:23:03 +08:00
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.stack.html" > mlx.core.stack< / a > < / li >
2023-12-06 04:10:03 +08:00
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.stop_gradient.html" > mlx.core.stop_gradient< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.subtract.html" > mlx.core.subtract< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.sum.html" > mlx.core.sum< / a > < / li >
2023-12-18 05:23:03 +08:00
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.swapaxes.html" > mlx.core.swapaxes< / a > < / li >
2023-12-06 04:10:03 +08:00
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.take.html" > mlx.core.take< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.take_along_axis.html" > mlx.core.take_along_axis< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.tan.html" > mlx.core.tan< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.tanh.html" > mlx.core.tanh< / a > < / li >
2024-01-04 12:14:05 +08:00
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.tensordot.html" > mlx.core.tensordot< / a > < / li >
2023-12-06 04:10:03 +08:00
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.transpose.html" > mlx.core.transpose< / a > < / li >
2023-12-18 05:23:03 +08:00
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.tri.html" > mlx.core.tri< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.tril.html" > mlx.core.tril< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.triu.html" > mlx.core.triu< / a > < / li >
2023-12-06 04:10:03 +08:00
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.var.html" > mlx.core.var< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.where.html" > mlx.core.where< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.zeros.html" > mlx.core.zeros< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.zeros_like.html" > mlx.core.zeros_like< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l1 has-children" > < a class = "reference internal" href = "python/random.html" > Random< / a > < input class = "toctree-checkbox" id = "toctree-checkbox-4" name = "toctree-checkbox-4" type = "checkbox" / > < label class = "toctree-toggle" for = "toctree-checkbox-4" > < i class = "fa-solid fa-chevron-down" > < / i > < / label > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.random.seed.html" > mlx.core.random.seed< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.random.key.html" > mlx.core.random.key< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.random.split.html" > mlx.core.random.split< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.random.bernoulli.html" > mlx.core.random.bernoulli< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.random.categorical.html" > mlx.core.random.categorical< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.random.gumbel.html" > mlx.core.random.gumbel< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.random.normal.html" > mlx.core.random.normal< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.random.randint.html" > mlx.core.random.randint< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.random.uniform.html" > mlx.core.random.uniform< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.random.truncated_normal.html" > mlx.core.random.truncated_normal< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l1 has-children" > < a class = "reference internal" href = "python/transforms.html" > Transforms< / a > < input class = "toctree-checkbox" id = "toctree-checkbox-5" name = "toctree-checkbox-5" type = "checkbox" / > < label class = "toctree-toggle" for = "toctree-checkbox-5" > < i class = "fa-solid fa-chevron-down" > < / i > < / label > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.eval.html" > mlx.core.eval< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.grad.html" > mlx.core.grad< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.value_and_grad.html" > mlx.core.value_and_grad< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.jvp.html" > mlx.core.jvp< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.vjp.html" > mlx.core.vjp< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.vmap.html" > mlx.core.vmap< / a > < / li >
2023-12-18 05:23:03 +08:00
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.simplify.html" > mlx.core.simplify< / a > < / li >
2023-12-06 04:10:03 +08:00
< / ul >
< / li >
< li class = "toctree-l1 has-children" > < a class = "reference internal" href = "python/fft.html" > FFT< / a > < input class = "toctree-checkbox" id = "toctree-checkbox-6" name = "toctree-checkbox-6" type = "checkbox" / > < label class = "toctree-toggle" for = "toctree-checkbox-6" > < i class = "fa-solid fa-chevron-down" > < / i > < / label > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.fft.fft.html" > mlx.core.fft.fft< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.fft.ifft.html" > mlx.core.fft.ifft< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.fft.fft2.html" > mlx.core.fft.fft2< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.fft.ifft2.html" > mlx.core.fft.ifft2< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.fft.fftn.html" > mlx.core.fft.fftn< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.fft.ifftn.html" > mlx.core.fft.ifftn< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.fft.rfft.html" > mlx.core.fft.rfft< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.fft.irfft.html" > mlx.core.fft.irfft< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.fft.rfft2.html" > mlx.core.fft.rfft2< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.fft.irfft2.html" > mlx.core.fft.irfft2< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.fft.rfftn.html" > mlx.core.fft.rfftn< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.fft.irfftn.html" > mlx.core.fft.irfftn< / a > < / li >
< / ul >
< / li >
2024-01-04 12:14:05 +08:00
< li class = "toctree-l1 has-children" > < a class = "reference internal" href = "python/linalg.html" > Linear Algebra< / a > < input class = "toctree-checkbox" id = "toctree-checkbox-7" name = "toctree-checkbox-7" type = "checkbox" / > < label class = "toctree-toggle" for = "toctree-checkbox-7" > < i class = "fa-solid fa-chevron-down" > < / i > < / label > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.core.linalg.norm.html" > mlx.core.linalg.norm< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l1 has-children" > < a class = "reference internal" href = "python/nn.html" > Neural Networks< / a > < input class = "toctree-checkbox" id = "toctree-checkbox-8" name = "toctree-checkbox-8" type = "checkbox" / > < label class = "toctree-toggle" for = "toctree-checkbox-8" > < i class = "fa-solid fa-chevron-down" > < / i > < / label > < ul >
2023-12-06 04:10:03 +08:00
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.nn.value_and_grad.html" > mlx.nn.value_and_grad< / a > < / li >
2024-01-04 12:14:05 +08:00
< li class = "toctree-l2 has-children" > < a class = "reference internal" href = "python/nn/module.html" > Module< / a > < input class = "toctree-checkbox" id = "toctree-checkbox-9" name = "toctree-checkbox-9" type = "checkbox" / > < label class = "toctree-toggle" for = "toctree-checkbox-9" > < i class = "fa-solid fa-chevron-down" > < / i > < / label > < ul >
< li class = "toctree-l3" > < a class = "reference internal" href = "python/nn/_autosummary/mlx.nn.Module.training.html" > mlx.nn.Module.training< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "python/nn/_autosummary/mlx.nn.Module.apply.html" > mlx.nn.Module.apply< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "python/nn/_autosummary/mlx.nn.Module.apply_to_modules.html" > mlx.nn.Module.apply_to_modules< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "python/nn/_autosummary/mlx.nn.Module.children.html" > mlx.nn.Module.children< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "python/nn/_autosummary/mlx.nn.Module.eval.html" > mlx.nn.Module.eval< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "python/nn/_autosummary/mlx.nn.Module.filter_and_map.html" > mlx.nn.Module.filter_and_map< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "python/nn/_autosummary/mlx.nn.Module.freeze.html" > mlx.nn.Module.freeze< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "python/nn/_autosummary/mlx.nn.Module.leaf_modules.html" > mlx.nn.Module.leaf_modules< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "python/nn/_autosummary/mlx.nn.Module.load_weights.html" > mlx.nn.Module.load_weights< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "python/nn/_autosummary/mlx.nn.Module.modules.html" > mlx.nn.Module.modules< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "python/nn/_autosummary/mlx.nn.Module.named_modules.html" > mlx.nn.Module.named_modules< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "python/nn/_autosummary/mlx.nn.Module.parameters.html" > mlx.nn.Module.parameters< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "python/nn/_autosummary/mlx.nn.Module.save_weights.html" > mlx.nn.Module.save_weights< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "python/nn/_autosummary/mlx.nn.Module.train.html" > mlx.nn.Module.train< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "python/nn/_autosummary/mlx.nn.Module.trainable_parameters.html" > mlx.nn.Module.trainable_parameters< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "python/nn/_autosummary/mlx.nn.Module.unfreeze.html" > mlx.nn.Module.unfreeze< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "python/nn/_autosummary/mlx.nn.Module.update.html" > mlx.nn.Module.update< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "python/nn/_autosummary/mlx.nn.Module.update_modules.html" > mlx.nn.Module.update_modules< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l2 has-children" > < a class = "reference internal" href = "python/nn/layers.html" > Layers< / a > < input class = "toctree-checkbox" id = "toctree-checkbox-10" name = "toctree-checkbox-10" type = "checkbox" / > < label class = "toctree-toggle" for = "toctree-checkbox-10" > < i class = "fa-solid fa-chevron-down" > < / i > < / label > < ul >
< li class = "toctree-l3" > < a class = "reference internal" href = "python/nn/_autosummary/mlx.nn.Sequential.html" > mlx.nn.Sequential< / a > < / li >
2023-12-18 05:23:03 +08:00
< li class = "toctree-l3" > < a class = "reference internal" href = "python/nn/_autosummary/mlx.nn.ReLU.html" > mlx.nn.ReLU< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "python/nn/_autosummary/mlx.nn.PReLU.html" > mlx.nn.PReLU< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "python/nn/_autosummary/mlx.nn.GELU.html" > mlx.nn.GELU< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "python/nn/_autosummary/mlx.nn.SiLU.html" > mlx.nn.SiLU< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "python/nn/_autosummary/mlx.nn.Step.html" > mlx.nn.Step< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "python/nn/_autosummary/mlx.nn.SELU.html" > mlx.nn.SELU< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "python/nn/_autosummary/mlx.nn.Mish.html" > mlx.nn.Mish< / a > < / li >
2024-01-04 12:14:05 +08:00
< li class = "toctree-l3" > < a class = "reference internal" href = "python/nn/_autosummary/mlx.nn.Embedding.html" > mlx.nn.Embedding< / a > < / li >
2023-12-18 05:23:03 +08:00
< li class = "toctree-l3" > < a class = "reference internal" href = "python/nn/_autosummary/mlx.nn.Linear.html" > mlx.nn.Linear< / a > < / li >
2024-01-04 12:14:05 +08:00
< li class = "toctree-l3" > < a class = "reference internal" href = "python/nn/_autosummary/mlx.nn.QuantizedLinear.html" > mlx.nn.QuantizedLinear< / a > < / li >
2023-12-18 05:23:03 +08:00
< li class = "toctree-l3" > < a class = "reference internal" href = "python/nn/_autosummary/mlx.nn.Conv1d.html" > mlx.nn.Conv1d< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "python/nn/_autosummary/mlx.nn.Conv2d.html" > mlx.nn.Conv2d< / a > < / li >
2024-01-04 12:14:05 +08:00
< li class = "toctree-l3" > < a class = "reference internal" href = "python/nn/_autosummary/mlx.nn.BatchNorm.html" > mlx.nn.BatchNorm< / a > < / li >
2023-12-18 05:23:03 +08:00
< li class = "toctree-l3" > < a class = "reference internal" href = "python/nn/_autosummary/mlx.nn.LayerNorm.html" > mlx.nn.LayerNorm< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "python/nn/_autosummary/mlx.nn.RMSNorm.html" > mlx.nn.RMSNorm< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "python/nn/_autosummary/mlx.nn.GroupNorm.html" > mlx.nn.GroupNorm< / a > < / li >
2024-01-04 12:14:05 +08:00
< li class = "toctree-l3" > < a class = "reference internal" href = "python/nn/_autosummary/mlx.nn.InstanceNorm.html" > mlx.nn.InstanceNorm< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "python/nn/_autosummary/mlx.nn.Dropout.html" > mlx.nn.Dropout< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "python/nn/_autosummary/mlx.nn.Dropout2d.html" > mlx.nn.Dropout2d< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "python/nn/_autosummary/mlx.nn.Dropout3d.html" > mlx.nn.Dropout3d< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "python/nn/_autosummary/mlx.nn.Transformer.html" > mlx.nn.Transformer< / a > < / li >
2023-12-18 05:23:03 +08:00
< li class = "toctree-l3" > < a class = "reference internal" href = "python/nn/_autosummary/mlx.nn.MultiHeadAttention.html" > mlx.nn.MultiHeadAttention< / a > < / li >
2024-01-04 12:14:05 +08:00
< li class = "toctree-l3" > < a class = "reference internal" href = "python/nn/_autosummary/mlx.nn.ALiBi.html" > mlx.nn.ALiBi< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "python/nn/_autosummary/mlx.nn.RoPE.html" > mlx.nn.RoPE< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "python/nn/_autosummary/mlx.nn.SinusoidalPositionalEncoding.html" > mlx.nn.SinusoidalPositionalEncoding< / a > < / li >
2023-12-06 04:10:03 +08:00
< / ul >
< / li >
2024-01-04 12:14:05 +08:00
< li class = "toctree-l2 has-children" > < a class = "reference internal" href = "python/nn/functions.html" > Functions< / a > < input class = "toctree-checkbox" id = "toctree-checkbox-11" name = "toctree-checkbox-11" type = "checkbox" / > < label class = "toctree-toggle" for = "toctree-checkbox-11" > < i class = "fa-solid fa-chevron-down" > < / i > < / label > < ul >
2023-12-18 05:23:03 +08:00
< li class = "toctree-l3" > < a class = "reference internal" href = "python/nn/_autosummary_functions/mlx.nn.gelu.html" > mlx.nn.gelu< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "python/nn/_autosummary_functions/mlx.nn.gelu_approx.html" > mlx.nn.gelu_approx< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "python/nn/_autosummary_functions/mlx.nn.gelu_fast_approx.html" > mlx.nn.gelu_fast_approx< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "python/nn/_autosummary_functions/mlx.nn.relu.html" > mlx.nn.relu< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "python/nn/_autosummary_functions/mlx.nn.prelu.html" > mlx.nn.prelu< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "python/nn/_autosummary_functions/mlx.nn.silu.html" > mlx.nn.silu< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "python/nn/_autosummary_functions/mlx.nn.step.html" > mlx.nn.step< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "python/nn/_autosummary_functions/mlx.nn.selu.html" > mlx.nn.selu< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "python/nn/_autosummary_functions/mlx.nn.mish.html" > mlx.nn.mish< / a > < / li >
< / ul >
< / li >
2024-01-04 12:14:05 +08:00
< li class = "toctree-l2 has-children" > < a class = "reference internal" href = "python/nn/losses.html" > Loss Functions< / a > < input class = "toctree-checkbox" id = "toctree-checkbox-12" name = "toctree-checkbox-12" type = "checkbox" / > < label class = "toctree-toggle" for = "toctree-checkbox-12" > < i class = "fa-solid fa-chevron-down" > < / i > < / label > < ul >
2023-12-18 05:23:03 +08:00
< li class = "toctree-l3" > < a class = "reference internal" href = "python/nn/_autosummary_functions/mlx.nn.losses.binary_cross_entropy.html" > mlx.nn.losses.binary_cross_entropy< / a > < / li >
2023-12-22 14:13:41 +08:00
< li class = "toctree-l3" > < a class = "reference internal" href = "python/nn/_autosummary_functions/mlx.nn.losses.cross_entropy.html" > mlx.nn.losses.cross_entropy< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "python/nn/_autosummary_functions/mlx.nn.losses.kl_div_loss.html" > mlx.nn.losses.kl_div_loss< / a > < / li >
2023-12-18 05:23:03 +08:00
< li class = "toctree-l3" > < a class = "reference internal" href = "python/nn/_autosummary_functions/mlx.nn.losses.l1_loss.html" > mlx.nn.losses.l1_loss< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "python/nn/_autosummary_functions/mlx.nn.losses.mse_loss.html" > mlx.nn.losses.mse_loss< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "python/nn/_autosummary_functions/mlx.nn.losses.nll_loss.html" > mlx.nn.losses.nll_loss< / a > < / li >
2023-12-22 14:13:41 +08:00
< li class = "toctree-l3" > < a class = "reference internal" href = "python/nn/_autosummary_functions/mlx.nn.losses.smooth_l1_loss.html" > mlx.nn.losses.smooth_l1_loss< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "python/nn/_autosummary_functions/mlx.nn.losses.triplet_loss.html" > mlx.nn.losses.triplet_loss< / a > < / li >
2024-01-04 12:14:05 +08:00
< li class = "toctree-l3" > < a class = "reference internal" href = "python/nn/_autosummary_functions/mlx.nn.losses.hinge_loss.html" > mlx.nn.losses.hinge_loss< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "python/nn/_autosummary_functions/mlx.nn.losses.huber_loss.html" > mlx.nn.losses.huber_loss< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "python/nn/_autosummary_functions/mlx.nn.losses.log_cosh_loss.html" > mlx.nn.losses.log_cosh_loss< / a > < / li >
2023-12-18 05:23:03 +08:00
< / ul >
< / li >
< / ul >
< / li >
2024-01-04 12:14:05 +08:00
< li class = "toctree-l1 has-children" > < a class = "reference internal" href = "python/optimizers.html" > Optimizers< / a > < input class = "toctree-checkbox" id = "toctree-checkbox-13" name = "toctree-checkbox-13" type = "checkbox" / > < label class = "toctree-toggle" for = "toctree-checkbox-13" > < i class = "fa-solid fa-chevron-down" > < / i > < / label > < ul >
2023-12-06 04:10:03 +08:00
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.optimizers.OptimizerState.html" > mlx.optimizers.OptimizerState< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.optimizers.Optimizer.html" > mlx.optimizers.Optimizer< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.optimizers.SGD.html" > mlx.optimizers.SGD< / a > < / li >
2023-12-18 05:23:03 +08:00
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.optimizers.RMSprop.html" > mlx.optimizers.RMSprop< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.optimizers.Adagrad.html" > mlx.optimizers.Adagrad< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.optimizers.AdaDelta.html" > mlx.optimizers.AdaDelta< / a > < / li >
2023-12-06 04:10:03 +08:00
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.optimizers.Adam.html" > mlx.optimizers.Adam< / a > < / li >
2023-12-18 05:23:03 +08:00
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.optimizers.AdamW.html" > mlx.optimizers.AdamW< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.optimizers.Adamax.html" > mlx.optimizers.Adamax< / a > < / li >
2023-12-22 14:13:41 +08:00
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.optimizers.Lion.html" > mlx.optimizers.Lion< / a > < / li >
2023-12-06 04:10:03 +08:00
< / ul >
< / li >
2024-01-04 12:14:05 +08:00
< li class = "toctree-l1 has-children" > < a class = "reference internal" href = "python/tree_utils.html" > Tree Utils< / a > < input class = "toctree-checkbox" id = "toctree-checkbox-14" name = "toctree-checkbox-14" type = "checkbox" / > < label class = "toctree-toggle" for = "toctree-checkbox-14" > < i class = "fa-solid fa-chevron-down" > < / i > < / label > < ul >
2023-12-06 04:10:03 +08:00
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.utils.tree_flatten.html" > mlx.utils.tree_flatten< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.utils.tree_unflatten.html" > mlx.utils.tree_unflatten< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python/_autosummary/mlx.utils.tree_map.html" > mlx.utils.tree_map< / a > < / li >
< / ul >
< / li >
< / ul >
< p aria-level = "2" class = "caption" role = "heading" > < span class = "caption-text" > C++ API Reference< / span > < / p >
< ul class = "nav bd-sidenav" >
2023-11-30 04:41:56 +08:00
< li class = "toctree-l1" > < a class = "reference internal" href = "cpp/ops.html" > Operations< / a > < / li >
2023-11-30 04:46:18 +08:00
< / ul >
2023-12-06 04:10:03 +08:00
< p aria-level = "2" class = "caption" role = "heading" > < span class = "caption-text" > Further Reading< / span > < / p >
< ul class = "nav bd-sidenav" >
2023-11-30 04:46:18 +08:00
< li class = "toctree-l1" > < a class = "reference internal" href = "dev/extensions.html" > Developer Documentation< / a > < / li >
2023-11-30 04:41:56 +08:00
< / ul >
2023-12-06 04:10:03 +08:00
< / div >
< / nav > < / div >
< / div >
< div class = "sidebar-primary-items__end sidebar-primary__section" >
< / div >
< div id = "rtd-footer-container" > < / div >
2023-11-30 04:41:56 +08:00
< / div >
2023-12-06 04:10:03 +08:00
< main id = "main-content" class = "bd-main" >
< div class = "sbt-scroll-pixel-helper" > < / div >
< div class = "bd-content" >
< div class = "bd-article-container" >
< div class = "bd-header-article" >
< div class = "header-article-items header-article__inner" >
< div class = "header-article-items__start" >
< div class = "header-article-item" > < label class = "sidebar-toggle primary-toggle btn btn-sm" for = "__primary" title = "Toggle primary sidebar" data-bs-placement = "bottom" data-bs-toggle = "tooltip" >
< span class = "fa-solid fa-bars" > < / span >
< / label > < / div >
< / div >
< div class = "header-article-items__end" >
< div class = "header-article-item" >
< div class = "article-header-buttons" >
< a href = "https://github.com/ml-explore/mlx" target = "_blank"
class="btn btn-sm btn-source-repository-button"
title="Source repository"
data-bs-placement="bottom" data-bs-toggle="tooltip"
>
2023-11-30 04:41:56 +08:00
2023-12-06 04:10:03 +08:00
< span class = "btn__icon-container" >
< i class = "fab fa-github" > < / i >
< / span >
< / a >
< div class = "dropdown dropdown-download-buttons" >
< button class = "btn dropdown-toggle" type = "button" data-bs-toggle = "dropdown" aria-expanded = "false" aria-label = "Download this page" >
< i class = "fas fa-download" > < / i >
< / button >
< ul class = "dropdown-menu" >
< li > < a href = "_sources/index.rst" target = "_blank"
class="btn btn-sm btn-download-source-button dropdown-item"
title="Download source file"
data-bs-placement="left" data-bs-toggle="tooltip"
>
< span class = "btn__icon-container" >
< i class = "fas fa-file" > < / i >
< / span >
< span class = "btn__text-container" > .rst< / span >
< / a >
< / li >
< li >
< button onclick = "window.print()"
class="btn btn-sm btn-download-pdf-button dropdown-item"
title="Print to PDF"
data-bs-placement="left" data-bs-toggle="tooltip"
>
< span class = "btn__icon-container" >
< i class = "fas fa-file-pdf" > < / i >
< / span >
< span class = "btn__text-container" > .pdf< / span >
< / button >
< / li >
2023-11-30 04:41:56 +08:00
< / ul >
< / div >
2023-12-06 04:10:03 +08:00
< button onclick = "toggleFullScreen()"
class="btn btn-sm btn-fullscreen-button"
title="Fullscreen mode"
data-bs-placement="bottom" data-bs-toggle="tooltip"
>
< span class = "btn__icon-container" >
< i class = "fas fa-expand" > < / i >
< / span >
< / button >
< script >
document.write(`
< button class = "btn btn-sm navbar-btn theme-switch-button" title = "light/dark" aria-label = "light/dark" data-bs-placement = "bottom" data-bs-toggle = "tooltip" >
< span class = "theme-switch nav-link" data-mode = "light" > < i class = "fa-solid fa-sun fa-lg" > < / i > < / span >
< span class = "theme-switch nav-link" data-mode = "dark" > < i class = "fa-solid fa-moon fa-lg" > < / i > < / span >
< span class = "theme-switch nav-link" data-mode = "auto" > < i class = "fa-solid fa-circle-half-stroke fa-lg" > < / i > < / span >
< / button >
`);
< / script >
< script >
document.write(`
< button class = "btn btn-sm navbar-btn search-button search-button__button" title = "Search" aria-label = "Search" data-bs-placement = "bottom" data-bs-toggle = "tooltip" >
< i class = "fa-solid fa-magnifying-glass fa-lg" > < / i >
< / button >
`);
< / script >
< / div > < / div >
< / div >
< / div >
< / div >
< div id = "jb-print-docs-body" class = "onlyprint" >
< h1 > MLX< / h1 >
<!-- Table of contents -->
< div id = "print-main-content" >
< div id = "jb-print-toc" >
< / div >
< / div >
< / div >
< div id = "searchbox" > < / div >
< article class = "bd-article" role = "main" >
2023-11-30 04:41:56 +08:00
< section id = "mlx" >
2023-12-06 04:10:03 +08:00
< h1 > MLX< a class = "headerlink" href = "#mlx" title = "Permalink to this heading" > #< / a > < / h1 >
2023-12-06 06:18:20 +08:00
< p > MLX is a NumPy-like array framework designed for efficient and flexible machine
learning on Apple silicon, brought to you by Apple machine learning research.< / p >
2023-12-06 04:10:03 +08:00
< p > The Python API closely follows NumPy with a few exceptions. MLX also has a
fully featured C++ API which closely follows the Python API.< / p >
< p > The main differences between MLX and NumPy are:< / p >
< blockquote >
< div > < ul class = "simple" >
< li > < p > < strong > Composable function transformations< / strong > : MLX has composable function
transformations for automatic differentiation, automatic vectorization,
and computation graph optimization.< / p > < / li >
< li > < p > < strong > Lazy computation< / strong > : Computations in MLX are lazy. Arrays are only
materialized when needed.< / p > < / li >
< li > < p > < strong > Multi-device< / strong > : Operations can run on any of the supported devices (CPU,
GPU, …)< / p > < / li >
< / ul >
< / div > < / blockquote >
2023-12-06 06:18:20 +08:00
< p > The design of MLX is inspired by frameworks like < a class = "reference external" href = "https://pytorch.org/" > PyTorch< / a > , < a class = "reference external" href = "https://github.com/google/jax" > Jax< / a > , and
2024-01-04 12:14:05 +08:00
< a class = "reference external" href = "https://arrayfire.org/" > ArrayFire< / a > . A notable difference from these
2023-12-06 04:10:03 +08:00
frameworks and MLX is the < em > unified memory model< / em > . Arrays in MLX live in shared
memory. Operations on MLX arrays can be performed on any of the supported
device types without performing data copies. Currently supported device types
are the CPU and GPU.< / p >
2023-11-30 04:41:56 +08:00
< div class = "toctree-wrapper compound" >
2023-12-06 04:10:03 +08:00
< p aria-level = "2" class = "caption" role = "heading" > < span class = "caption-text" > Install< / span > < / p >
2023-11-30 04:41:56 +08:00
< ul >
< li class = "toctree-l1" > < a class = "reference internal" href = "install.html" > Build and Install< / a > < / li >
< / ul >
< / div >
< div class = "toctree-wrapper compound" >
2023-12-06 04:10:03 +08:00
< p aria-level = "2" class = "caption" role = "heading" > < span class = "caption-text" > Usage< / span > < / p >
2023-11-30 04:41:56 +08:00
< ul >
< li class = "toctree-l1" > < a class = "reference internal" href = "quick_start.html" > Quick Start Guide< / a > < / li >
2023-12-08 11:46:44 +08:00
< li class = "toctree-l1" > < a class = "reference internal" href = "unified_memory.html" > Unified Memory< / a > < / li >
2023-11-30 04:41:56 +08:00
< li class = "toctree-l1" > < a class = "reference internal" href = "using_streams.html" > Using Streams< / a > < / li >
< / ul >
< / div >
< div class = "toctree-wrapper compound" >
2023-12-06 04:10:03 +08:00
< p aria-level = "2" class = "caption" role = "heading" > < span class = "caption-text" > Examples< / span > < / p >
2023-11-30 04:41:56 +08:00
< ul >
< li class = "toctree-l1" > < a class = "reference internal" href = "examples/linear_regression.html" > Linear Regression< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "examples/mlp.html" > Multi-Layer Perceptron< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "examples/llama-inference.html" > LLM inference< / a > < / li >
< / ul >
< / div >
< div class = "toctree-wrapper compound" >
2023-12-06 04:10:03 +08:00
< p aria-level = "2" class = "caption" role = "heading" > < span class = "caption-text" > Python API Reference< / span > < / p >
2023-11-30 04:41:56 +08:00
< ul >
< li class = "toctree-l1" > < a class = "reference internal" href = "python/array.html" > Array< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "python/devices_and_streams.html" > Devices and Streams< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "python/ops.html" > Operations< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "python/random.html" > Random< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "python/transforms.html" > Transforms< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "python/fft.html" > FFT< / a > < / li >
2024-01-04 12:14:05 +08:00
< li class = "toctree-l1" > < a class = "reference internal" href = "python/linalg.html" > Linear Algebra< / a > < / li >
2023-11-30 04:41:56 +08:00
< li class = "toctree-l1" > < a class = "reference internal" href = "python/nn.html" > Neural Networks< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "python/optimizers.html" > Optimizers< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "python/tree_utils.html" > Tree Utils< / a > < / li >
< / ul >
< / div >
< div class = "toctree-wrapper compound" >
2023-12-06 04:10:03 +08:00
< p aria-level = "2" class = "caption" role = "heading" > < span class = "caption-text" > C++ API Reference< / span > < / p >
2023-11-30 04:41:56 +08:00
< ul >
< li class = "toctree-l1" > < a class = "reference internal" href = "cpp/ops.html" > Operations< / a > < / li >
< / ul >
< / div >
2023-11-30 04:46:18 +08:00
< div class = "toctree-wrapper compound" >
2023-12-06 04:10:03 +08:00
< p aria-level = "2" class = "caption" role = "heading" > < span class = "caption-text" > Further Reading< / span > < / p >
2023-11-30 04:46:18 +08:00
< ul >
< li class = "toctree-l1" > < a class = "reference internal" href = "dev/extensions.html" > Developer Documentation< / a > < / li >
< / ul >
< / div >
2023-11-30 04:41:56 +08:00
< / section >
2023-12-06 04:10:03 +08:00
< / article >
2023-11-30 04:41:56 +08:00
2023-12-06 04:10:03 +08:00
< footer class = "prev-next-footer" >
< div class = "prev-next-area" >
< a class = "right-next"
href="install.html"
title="next page">
< div class = "prev-next-info" >
< p class = "prev-next-subtitle" > next< / p >
< p class = "prev-next-title" > Build and Install< / p >
< / div >
< i class = "fa-solid fa-angle-right" > < / i >
< / a >
< / div >
< / footer >
< / div >
< / div >
< footer class = "bd-footer-content" >
< div class = "bd-footer-content__inner container" >
< div class = "footer-item" >
< p class = "component-author" >
By MLX Contributors
< / p >
2023-11-30 04:41:56 +08:00
< / div >
2023-12-06 04:10:03 +08:00
< div class = "footer-item" >
2023-11-30 04:41:56 +08:00
2023-12-06 04:10:03 +08:00
< p class = "copyright" >
© Copyright 2023, MLX Contributors.
< br / >
< / p >
2023-11-30 04:41:56 +08:00
< / div >
2023-12-06 04:10:03 +08:00
< div class = "footer-item" >
< / div >
< div class = "footer-item" >
< / div >
< / div >
< / footer >
< / main >
< / div >
< / div >
<!-- Scripts loaded after <body> so the DOM is not blocked -->
< script src = "_static/scripts/bootstrap.js?digest=5b4479735964841361fd" > < / script >
< script src = "_static/scripts/pydata-sphinx-theme.js?digest=5b4479735964841361fd" > < / script >
2023-11-30 04:41:56 +08:00
2023-12-06 04:10:03 +08:00
< footer class = "bd-footer" >
< / footer >
< / body >
2023-11-30 04:41:56 +08:00
< / html >
