mirror of
https://github.com/ml-explore/mlx.git
synced 2025-06-26 02:33:21 +08:00
846 lines
71 KiB
HTML
846 lines
71 KiB
HTML
|
||
|
||
<!DOCTYPE html>
|
||
|
||
|
||
<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/" />
|
||
|
||
<title>mlx.nn.Module — MLX 0.0.4 documentation</title>
|
||
|
||
|
||
|
||
<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 = 'python/nn/module';</script>
|
||
<link rel="index" title="Index" href="../../genindex.html" />
|
||
<link rel="search" title="Search" href="../../search.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="../../index.html">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<img src="../../_static/mlx_logo.png" class="logo__image only-light" alt="MLX 0.0.4 documentation - Home"/>
|
||
<script>document.write(`<img src="../../_static/mlx_logo.png" class="logo__image only-dark" alt="MLX 0.0.4 documentation - Home"/>`);</script>
|
||
|
||
|
||
</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">
|
||
<li class="toctree-l1"><a class="reference internal" href="../../install.html">Build and Install</a></li>
|
||
</ul>
|
||
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Usage</span></p>
|
||
<ul class="nav bd-sidenav">
|
||
<li class="toctree-l1"><a class="reference internal" href="../../quick_start.html">Quick Start Guide</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../using_streams.html">Using Streams</a></li>
|
||
</ul>
|
||
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Examples</span></p>
|
||
<ul class="nav bd-sidenav">
|
||
<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>
|
||
<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="../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="../_autosummary/mlx.core.array.html">mlx.core.array</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.array.astype.html">mlx.core.array.astype</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.array.item.html">mlx.core.array.item</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.array.tolist.html">mlx.core.array.tolist</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.array.dtype.html">mlx.core.array.dtype</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.array.ndim.html">mlx.core.array.ndim</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.array.shape.html">mlx.core.array.shape</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.array.size.html">mlx.core.array.size</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.Dtype.html">mlx.core.Dtype</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.array.abs.html">mlx.core.array.abs</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.array.all.html">mlx.core.array.all</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.array.any.html">mlx.core.array.any</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.array.argmax.html">mlx.core.array.argmax</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.array.argmin.html">mlx.core.array.argmin</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.array.cos.html">mlx.core.array.cos</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.array.dtype.html">mlx.core.array.dtype</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.array.exp.html">mlx.core.array.exp</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.array.log.html">mlx.core.array.log</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.array.log1p.html">mlx.core.array.log1p</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.array.logsumexp.html">mlx.core.array.logsumexp</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.array.max.html">mlx.core.array.max</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.array.mean.html">mlx.core.array.mean</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.array.min.html">mlx.core.array.min</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.array.prod.html">mlx.core.array.prod</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.array.reciprocal.html">mlx.core.array.reciprocal</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.array.reshape.html">mlx.core.array.reshape</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.array.rsqrt.html">mlx.core.array.rsqrt</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.array.sin.html">mlx.core.array.sin</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.array.split.html">mlx.core.array.split</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.array.sqrt.html">mlx.core.array.sqrt</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.array.square.html">mlx.core.array.square</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.array.sum.html">mlx.core.array.sum</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.array.transpose.html">mlx.core.array.transpose</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.array.T.html">mlx.core.array.T</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.array.var.html">mlx.core.array.var</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1 has-children"><a class="reference internal" href="../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="../_autosummary/mlx.core.Device.html">mlx.core.Device</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.default_device.html">mlx.core.default_device</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.set_default_device.html">mlx.core.set_default_device</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.Stream.html">mlx.core.Stream</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.default_stream.html">mlx.core.default_stream</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.new_stream.html">mlx.core.new_stream</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_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="../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="../_autosummary/mlx.core.abs.html">mlx.core.abs</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.add.html">mlx.core.add</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.all.html">mlx.core.all</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.allclose.html">mlx.core.allclose</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.any.html">mlx.core.any</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.arange.html">mlx.core.arange</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.arccos.html">mlx.core.arccos</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.arccosh.html">mlx.core.arccosh</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.arcsin.html">mlx.core.arcsin</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.arcsinh.html">mlx.core.arcsinh</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.arctan.html">mlx.core.arctan</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.arctanh.html">mlx.core.arctanh</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.argmax.html">mlx.core.argmax</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.argmin.html">mlx.core.argmin</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.argpartition.html">mlx.core.argpartition</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.argsort.html">mlx.core.argsort</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.array_equal.html">mlx.core.array_equal</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.broadcast_to.html">mlx.core.broadcast_to</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.concatenate.html">mlx.core.concatenate</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.convolve.html">mlx.core.convolve</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.conv1d.html">mlx.core.conv1d</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.conv2d.html">mlx.core.conv2d</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.cos.html">mlx.core.cos</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.cosh.html">mlx.core.cosh</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.divide.html">mlx.core.divide</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.equal.html">mlx.core.equal</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.erf.html">mlx.core.erf</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.erfinv.html">mlx.core.erfinv</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.exp.html">mlx.core.exp</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.expand_dims.html">mlx.core.expand_dims</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.full.html">mlx.core.full</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.greater.html">mlx.core.greater</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.greater_equal.html">mlx.core.greater_equal</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.less.html">mlx.core.less</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.less_equal.html">mlx.core.less_equal</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.load.html">mlx.core.load</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.log.html">mlx.core.log</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.log2.html">mlx.core.log2</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.log10.html">mlx.core.log10</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.log1p.html">mlx.core.log1p</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.logaddexp.html">mlx.core.logaddexp</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.logical_not.html">mlx.core.logical_not</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.logsumexp.html">mlx.core.logsumexp</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.matmul.html">mlx.core.matmul</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.max.html">mlx.core.max</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.maximum.html">mlx.core.maximum</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.mean.html">mlx.core.mean</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.min.html">mlx.core.min</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.minimum.html">mlx.core.minimum</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.multiply.html">mlx.core.multiply</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.negative.html">mlx.core.negative</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.ones.html">mlx.core.ones</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.ones_like.html">mlx.core.ones_like</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.partition.html">mlx.core.partition</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.pad.html">mlx.core.pad</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.prod.html">mlx.core.prod</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.reciprocal.html">mlx.core.reciprocal</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.reshape.html">mlx.core.reshape</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.rsqrt.html">mlx.core.rsqrt</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.save.html">mlx.core.save</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.savez.html">mlx.core.savez</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.savez_compressed.html">mlx.core.savez_compressed</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.sigmoid.html">mlx.core.sigmoid</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.sign.html">mlx.core.sign</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.sin.html">mlx.core.sin</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.sinh.html">mlx.core.sinh</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.softmax.html">mlx.core.softmax</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.sort.html">mlx.core.sort</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.split.html">mlx.core.split</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.sqrt.html">mlx.core.sqrt</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.square.html">mlx.core.square</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.squeeze.html">mlx.core.squeeze</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.stop_gradient.html">mlx.core.stop_gradient</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.subtract.html">mlx.core.subtract</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.sum.html">mlx.core.sum</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.take.html">mlx.core.take</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.take_along_axis.html">mlx.core.take_along_axis</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.tan.html">mlx.core.tan</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.tanh.html">mlx.core.tanh</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.transpose.html">mlx.core.transpose</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.var.html">mlx.core.var</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.where.html">mlx.core.where</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.zeros.html">mlx.core.zeros</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_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="../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="../_autosummary/mlx.core.random.seed.html">mlx.core.random.seed</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.random.key.html">mlx.core.random.key</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.random.split.html">mlx.core.random.split</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.random.bernoulli.html">mlx.core.random.bernoulli</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.random.categorical.html">mlx.core.random.categorical</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.random.gumbel.html">mlx.core.random.gumbel</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.random.normal.html">mlx.core.random.normal</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.random.randint.html">mlx.core.random.randint</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.random.uniform.html">mlx.core.random.uniform</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_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="../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="../_autosummary/mlx.core.eval.html">mlx.core.eval</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.grad.html">mlx.core.grad</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.value_and_grad.html">mlx.core.value_and_grad</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.jvp.html">mlx.core.jvp</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.vjp.html">mlx.core.vjp</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.vmap.html">mlx.core.vmap</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1 has-children"><a class="reference internal" href="../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="../_autosummary/mlx.core.fft.fft.html">mlx.core.fft.fft</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.fft.ifft.html">mlx.core.fft.ifft</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.fft.fft2.html">mlx.core.fft.fft2</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.fft.ifft2.html">mlx.core.fft.ifft2</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.fft.fftn.html">mlx.core.fft.fftn</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.fft.ifftn.html">mlx.core.fft.ifftn</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.fft.rfft.html">mlx.core.fft.rfft</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.fft.irfft.html">mlx.core.fft.irfft</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.fft.rfft2.html">mlx.core.fft.rfft2</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.fft.irfft2.html">mlx.core.fft.irfft2</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.fft.rfftn.html">mlx.core.fft.rfftn</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.core.fft.irfftn.html">mlx.core.fft.irfftn</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1 has-children"><a class="reference internal" href="../nn.html">Neural Networks</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="../_autosummary/mlx.nn.value_and_grad.html">mlx.nn.value_and_grad</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.nn.Embedding.html">mlx.nn.Embedding</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.nn.ReLU.html">mlx.nn.ReLU</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.nn.GELU.html">mlx.nn.GELU</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.nn.SiLU.html">mlx.nn.SiLU</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.nn.Linear.html">mlx.nn.Linear</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.nn.Conv1d.html">mlx.nn.Conv1d</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.nn.Conv2d.html">mlx.nn.Conv2d</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.nn.LayerNorm.html">mlx.nn.LayerNorm</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.nn.RMSNorm.html">mlx.nn.RMSNorm</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.nn.GroupNorm.html">mlx.nn.GroupNorm</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.nn.RoPE.html">mlx.nn.RoPE</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.nn.MultiHeadAttention.html">mlx.nn.MultiHeadAttention</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.nn.Sequential.html">mlx.nn.Sequential</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary_functions/mlx.nn.gelu.html">mlx.nn.gelu</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary_functions/mlx.nn.gelu_approx.html">mlx.nn.gelu_approx</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary_functions/mlx.nn.gelu_fast_approx.html">mlx.nn.gelu_fast_approx</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary_functions/mlx.nn.relu.html">mlx.nn.relu</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary_functions/mlx.nn.silu.html">mlx.nn.silu</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1 has-children"><a class="reference internal" href="../optimizers.html">Optimizers</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>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.optimizers.OptimizerState.html">mlx.optimizers.OptimizerState</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.optimizers.Optimizer.html">mlx.optimizers.Optimizer</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.optimizers.SGD.html">mlx.optimizers.SGD</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.optimizers.Adam.html">mlx.optimizers.Adam</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1 has-children"><a class="reference internal" href="../tree_utils.html">Tree Utils</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-l2"><a class="reference internal" href="../_autosummary/mlx.utils.tree_flatten.html">mlx.utils.tree_flatten</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_autosummary/mlx.utils.tree_unflatten.html">mlx.utils.tree_unflatten</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../_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">
|
||
<li class="toctree-l1"><a class="reference internal" href="../../cpp/ops.html">Operations</a></li>
|
||
</ul>
|
||
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Further Reading</span></p>
|
||
<ul class="nav bd-sidenav">
|
||
<li class="toctree-l1"><a class="reference internal" href="../../dev/extensions.html">Developer Documentation</a></li>
|
||
</ul>
|
||
|
||
</div>
|
||
</nav></div>
|
||
</div>
|
||
|
||
|
||
<div class="sidebar-primary-items__end sidebar-primary__section">
|
||
</div>
|
||
|
||
<div id="rtd-footer-container"></div>
|
||
|
||
|
||
</div>
|
||
|
||
<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"
|
||
>
|
||
|
||
|
||
<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/python/nn/module.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>
|
||
|
||
</ul>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
<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.nn.Module</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">
|
||
|
||
<section id="mlx-nn-module">
|
||
<h1>mlx.nn.Module<a class="headerlink" href="#mlx-nn-module" title="Permalink to this heading">#</a></h1>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="mlx.nn.Module">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mlx.nn.</span></span><span class="sig-name descname"><span class="pre">Module</span></span><a class="headerlink" href="#mlx.nn.Module" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Base class for building neural networks with MLX.</p>
|
||
<p>All the layers provided in <code class="xref py py-mod docutils literal notranslate"><span class="pre">mlx.nn.layers</span></code> subclass this class and
|
||
your models should do the same.</p>
|
||
<p>A <code class="docutils literal notranslate"><span class="pre">Module</span></code> can contain other <code class="docutils literal notranslate"><span class="pre">Module</span></code> instances or <a class="reference internal" href="../_autosummary/mlx.core.array.html#mlx.core.array" title="mlx.core.array"><code class="xref py py-class docutils literal notranslate"><span class="pre">mlx.core.array</span></code></a>
|
||
instances in arbitrary nesting of python lists or dicts. The <code class="docutils literal notranslate"><span class="pre">Module</span></code>
|
||
then allows recursively extracting all the <a class="reference internal" href="../_autosummary/mlx.core.array.html#mlx.core.array" title="mlx.core.array"><code class="xref py py-class docutils literal notranslate"><span class="pre">mlx.core.array</span></code></a> instances
|
||
using <a class="reference internal" href="#mlx.nn.Module.parameters" title="mlx.nn.Module.parameters"><code class="xref py py-meth docutils literal notranslate"><span class="pre">mlx.nn.Module.parameters()</span></code></a>.</p>
|
||
<p>In addition, the <code class="docutils literal notranslate"><span class="pre">Module</span></code> has the concept of trainable and non trainable
|
||
parameters (called “frozen”). When using <a class="reference internal" href="../_autosummary/mlx.nn.value_and_grad.html#mlx.nn.value_and_grad" title="mlx.nn.value_and_grad"><code class="xref py py-func docutils literal notranslate"><span class="pre">mlx.nn.value_and_grad()</span></code></a>
|
||
the gradients are returned only with respect to the trainable parameters.
|
||
All arrays in a module are trainable unless they are added in the “frozen”
|
||
set by calling <a class="reference internal" href="#mlx.nn.Module.freeze" title="mlx.nn.Module.freeze"><code class="xref py py-meth docutils literal notranslate"><span class="pre">freeze()</span></code></a>.</p>
|
||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">mlx.core</span> <span class="k">as</span> <span class="nn">mx</span>
|
||
<span class="kn">import</span> <span class="nn">mlx.nn</span> <span class="k">as</span> <span class="nn">nn</span>
|
||
|
||
<span class="k">class</span> <span class="nc">MyMLP</span><span class="p">(</span><span class="n">nn</span><span class="o">.</span><span class="n">Module</span><span class="p">):</span>
|
||
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">in_dims</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">out_dims</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">hidden_dims</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">16</span><span class="p">):</span>
|
||
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span>
|
||
|
||
<span class="bp">self</span><span class="o">.</span><span class="n">in_proj</span> <span class="o">=</span> <span class="n">nn</span><span class="o">.</span><span class="n">Linear</span><span class="p">(</span><span class="n">in_dims</span><span class="p">,</span> <span class="n">hidden_dims</span><span class="p">)</span>
|
||
<span class="bp">self</span><span class="o">.</span><span class="n">out_proj</span> <span class="o">=</span> <span class="n">nn</span><span class="o">.</span><span class="n">Linear</span><span class="p">(</span><span class="n">hidden_dims</span><span class="p">,</span> <span class="n">out_dims</span><span class="p">)</span>
|
||
|
||
<span class="k">def</span> <span class="fm">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="p">):</span>
|
||
<span class="n">x</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">in_proj</span><span class="p">(</span><span class="n">x</span><span class="p">)</span>
|
||
<span class="n">x</span> <span class="o">=</span> <span class="n">mx</span><span class="o">.</span><span class="n">maximum</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
|
||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">out_proj</span><span class="p">(</span><span class="n">x</span><span class="p">)</span>
|
||
|
||
<span class="n">model</span> <span class="o">=</span> <span class="n">MyMLP</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
|
||
|
||
<span class="c1"># All the model parameters are created but since MLX is lazy by</span>
|
||
<span class="c1"># default, they are not evaluated yet. Calling `mx.eval` actually</span>
|
||
<span class="c1"># allocates memory and initializes the parameters.</span>
|
||
<span class="n">mx</span><span class="o">.</span><span class="n">eval</span><span class="p">(</span><span class="n">model</span><span class="o">.</span><span class="n">parameters</span><span class="p">())</span>
|
||
|
||
<span class="c1"># Setting a parameter to a new value is as simply as accessing that</span>
|
||
<span class="c1"># parameter and assigning a new array to it.</span>
|
||
<span class="n">model</span><span class="o">.</span><span class="n">in_proj</span><span class="o">.</span><span class="n">weight</span> <span class="o">=</span> <span class="n">model</span><span class="o">.</span><span class="n">in_proj</span><span class="o">.</span><span class="n">weight</span> <span class="o">*</span> <span class="mi">2</span>
|
||
<span class="n">mx</span><span class="o">.</span><span class="n">eval</span><span class="p">(</span><span class="n">model</span><span class="o">.</span><span class="n">parameters</span><span class="p">())</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="mlx.nn.Module.apply">
|
||
<span class="sig-name descname"><span class="pre">apply</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">map_fn</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.12)"><span class="pre">Callable</span></a><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="../_autosummary/mlx.core.array.html#mlx.core.array" title="mlx.core.array"><span class="pre">array</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="../_autosummary/mlx.core.array.html#mlx.core.array" title="mlx.core.array"><span class="pre">array</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filter_fn</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.12)"><span class="pre">Optional</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.12)"><span class="pre">Callable</span></a><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mlx.nn.Module" title="mlx.nn.Module"><span class="pre">Module</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.12)"><span class="pre">Any</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><span class="pre">bool</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mlx.nn.Module.apply" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Map all the parameters using the provided <code class="docutils literal notranslate"><span class="pre">map_fn</span></code> and immediately
|
||
update the module with the mapped parameters.</p>
|
||
<p>For instance running <code class="docutils literal notranslate"><span class="pre">model.apply(lambda</span> <span class="pre">x:</span> <span class="pre">x.astype(mx.float16))</span></code>
|
||
casts all parameters to 16 bit floats.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>map_fn</strong> (<em>Callable</em>) – Maps an array to another array</p></li>
|
||
<li><p><strong>filter_fn</strong> (<em>Callable</em><em>, </em><em>optional</em>) – Filter to select which arrays to
|
||
map (default: <code class="xref py py-meth docutils literal notranslate"><span class="pre">Module.valid_parameter_filter()</span></code>).</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="mlx.nn.Module.apply_to_modules">
|
||
<span class="sig-name descname"><span class="pre">apply_to_modules</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">apply_fn</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.12)"><span class="pre">Callable</span></a><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#mlx.nn.Module" title="mlx.nn.Module"><span class="pre">Module</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.12)"><span class="pre">Any</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mlx.nn.Module.apply_to_modules" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Apply a function to all the modules in this instance (including this
|
||
instance).</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>apply_fn</strong> (<em>Callable</em>) – The function to apply to the modules.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="mlx.nn.Module.children">
|
||
<span class="sig-name descname"><span class="pre">children</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mlx.nn.Module.children" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Return the direct descendants of this Module instance.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="mlx.nn.Module.filter_and_map">
|
||
<span class="sig-name descname"><span class="pre">filter_and_map</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filter_fn</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.12)"><span class="pre">Callable</span></a><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mlx.nn.Module" title="mlx.nn.Module"><span class="pre">Module</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.12)"><span class="pre">Any</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><span class="pre">bool</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">map_fn</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.12)"><span class="pre">Optional</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.12)"><span class="pre">Callable</span></a><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_leaf_fn</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.12)"><span class="pre">Optional</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.12)"><span class="pre">Callable</span></a><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mlx.nn.Module" title="mlx.nn.Module"><span class="pre">Module</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.12)"><span class="pre">Any</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><span class="pre">bool</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mlx.nn.Module.filter_and_map" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Recursively filter the contents of the module using <code class="docutils literal notranslate"><span class="pre">filter_fn</span></code>,
|
||
namely only select keys and values where <code class="docutils literal notranslate"><span class="pre">filter_fn</span></code> returns true.</p>
|
||
<p>This is used to implement <a class="reference internal" href="#mlx.nn.Module.parameters" title="mlx.nn.Module.parameters"><code class="xref py py-meth docutils literal notranslate"><span class="pre">parameters()</span></code></a> and <a class="reference internal" href="#mlx.nn.Module.trainable_parameters" title="mlx.nn.Module.trainable_parameters"><code class="xref py py-meth docutils literal notranslate"><span class="pre">trainable_parameters()</span></code></a>
|
||
but it can also be used to extract any subset of the module’s parameters.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>filter_fn</strong> (<em>Callable</em>) – Given a value, the key in which it is found
|
||
and the containing module, decide whether to keep the value or
|
||
drop it.</p></li>
|
||
<li><p><strong>map_fn</strong> (<em>Callable</em><em>, </em><em>optional</em>) – Optionally transform the value before
|
||
returning it.</p></li>
|
||
<li><p><strong>is_leaf_fn</strong> (<em>Callable</em><em>, </em><em>optional</em>) – Given a value, the key in which it
|
||
is found and the containing module decide if it is a leaf.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>A dictionary containing the contents of the module recursively filtered</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="mlx.nn.Module.freeze">
|
||
<span class="sig-name descname"><span class="pre">freeze</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">recurse</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><span class="pre">bool</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">keys</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.12)"><span class="pre">Optional</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Union" title="(in Python v3.12)"><span class="pre">Union</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.List" title="(in Python v3.12)"><span class="pre">List</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">strict</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><span class="pre">bool</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mlx.nn.Module.freeze" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Freeze the Module’s parameters or some of them. Freezing a parameter means not
|
||
computing gradients for it.</p>
|
||
<p>This function is idempotent ie freezing a frozen model is a noop.</p>
|
||
<p>For instance to only train the attention parameters from a transformer:</p>
|
||
<blockquote>
|
||
<div><p>model = …
|
||
model.freeze()
|
||
model.apply_to_modules(lambda k, v: v.unfreeze() if k.endswith(“attention”) else None)</p>
|
||
</div></blockquote>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>recurse</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a><em>, </em><em>optional</em>) – If True then freeze the parameters of the
|
||
submodules as well (default: True).</p></li>
|
||
<li><p><strong>keys</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em> or </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.12)"><em>list</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em>]</em><em>, </em><em>optional</em>) – If provided then only these
|
||
parameters will be frozen otherwise all the parameters of a
|
||
module. For instance freeze all biases by calling
|
||
<code class="docutils literal notranslate"><span class="pre">module.freeze(keys="bias")</span></code>.</p></li>
|
||
<li><p><strong>strict</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a><em>, </em><em>optional</em>) – If set to True validate that the passed keys exist
|
||
(default: False).</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="mlx.nn.Module.leaf_modules">
|
||
<span class="sig-name descname"><span class="pre">leaf_modules</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mlx.nn.Module.leaf_modules" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Return the submodules that do not contain other modules.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="mlx.nn.Module.load_weights">
|
||
<span class="sig-name descname"><span class="pre">load_weights</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mlx.nn.Module.load_weights" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Load and update the model’s weights from a <cite>.npz</cite> file.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="mlx.nn.Module.modules">
|
||
<span class="sig-name descname"><span class="pre">modules</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mlx.nn.Module.modules" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Return a list with all the modules in this instance.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>A list of <a class="reference internal" href="#mlx.nn.Module" title="mlx.nn.Module"><code class="xref py py-class docutils literal notranslate"><span class="pre">mlx.nn.Module</span></code></a> instances.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="mlx.nn.Module.named_modules">
|
||
<span class="sig-name descname"><span class="pre">named_modules</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mlx.nn.Module.named_modules" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Return a list with all the modules in this instance and their name
|
||
with dot notation.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>A list of tuples (str, <a class="reference internal" href="#mlx.nn.Module" title="mlx.nn.Module"><code class="xref py py-class docutils literal notranslate"><span class="pre">mlx.nn.Module</span></code></a>).</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="mlx.nn.Module.parameters">
|
||
<span class="sig-name descname"><span class="pre">parameters</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mlx.nn.Module.parameters" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Recursively return all the <a class="reference internal" href="../_autosummary/mlx.core.array.html#mlx.core.array" title="mlx.core.array"><code class="xref py py-class docutils literal notranslate"><span class="pre">mlx.core.array</span></code></a> members of this Module
|
||
as a dict of dicts and lists.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="mlx.nn.Module.save_weights">
|
||
<span class="sig-name descname"><span class="pre">save_weights</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mlx.nn.Module.save_weights" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Save the model’s weights to a <cite>.npz</cite> file.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="mlx.nn.Module.trainable_parameters">
|
||
<span class="sig-name descname"><span class="pre">trainable_parameters</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mlx.nn.Module.trainable_parameters" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Recursively return all the non frozen <a class="reference internal" href="../_autosummary/mlx.core.array.html#mlx.core.array" title="mlx.core.array"><code class="xref py py-class docutils literal notranslate"><span class="pre">mlx.core.array</span></code></a> members of
|
||
this Module as a dict of dicts and lists.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="mlx.nn.Module.unfreeze">
|
||
<span class="sig-name descname"><span class="pre">unfreeze</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">recurse</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><span class="pre">bool</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">keys</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.12)"><span class="pre">Optional</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Union" title="(in Python v3.12)"><span class="pre">Union</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.List" title="(in Python v3.12)"><span class="pre">List</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">strict</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><span class="pre">bool</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mlx.nn.Module.unfreeze" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Unfreeze the Module’s parameters or some of them.</p>
|
||
<p>This function is idempotent ie unfreezing a model that is not frozen is
|
||
a noop.</p>
|
||
<p>For instance to only train the biases one can do:</p>
|
||
<blockquote>
|
||
<div><p>model = …
|
||
model.freeze()
|
||
model.unfreeze(keys=”bias”)</p>
|
||
</div></blockquote>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>recurse</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a><em>, </em><em>optional</em>) – If True then unfreeze the parameters of the
|
||
submodules as well (default: True).</p></li>
|
||
<li><p><strong>keys</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em> or </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.12)"><em>list</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em>]</em><em>, </em><em>optional</em>) – If provided then only these
|
||
parameters will be unfrozen otherwise all the parameters of a
|
||
module. For instance unfreeze all biases by calling
|
||
<code class="docutils literal notranslate"><span class="pre">module.unfreeze(keys="bias")</span></code>.</p></li>
|
||
<li><p><strong>strict</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a><em>, </em><em>optional</em>) – If set to True validate that the passed keys exist
|
||
(default: False).</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="mlx.nn.Module.update">
|
||
<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">parameters</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><span class="pre">dict</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mlx.nn.Module.update" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Replace the parameters of this Module with the provided ones in the
|
||
dict of dicts and lists.</p>
|
||
<p>Commonly used by the optimizer to change the model to the updated
|
||
(optimized) parameters. Also used by the <a class="reference internal" href="../_autosummary/mlx.nn.value_and_grad.html#mlx.nn.value_and_grad" title="mlx.nn.value_and_grad"><code class="xref py py-meth docutils literal notranslate"><span class="pre">mlx.nn.value_and_grad()</span></code></a> to set the
|
||
tracers in the model in order to compute gradients.</p>
|
||
<p>The passed in parameters dictionary need not be a full dictionary
|
||
similar to <a class="reference internal" href="#mlx.nn.Module.parameters" title="mlx.nn.Module.parameters"><code class="xref py py-meth docutils literal notranslate"><span class="pre">parameters()</span></code></a>. Only the provided locations will be
|
||
updated.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>parameters</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><em>dict</em></a>) – A complete or partial dictionary of the modules
|
||
parameters.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</section>
|
||
|
||
|
||
</article>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<footer class="prev-next-footer">
|
||
|
||
<div class="prev-next-area">
|
||
</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>
|
||
|
||
</div>
|
||
|
||
<div class="footer-item">
|
||
|
||
|
||
<p class="copyright">
|
||
|
||
© Copyright 2023, MLX Contributors.
|
||
<br/>
|
||
|
||
</p>
|
||
|
||
</div>
|
||
|
||
<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>
|
||
|
||
<footer class="bd-footer">
|
||
</footer>
|
||
</body>
|
||
</html> |