mirror of
https://github.com/ml-explore/mlx.git
synced 2025-06-26 10:41:14 +08:00
185 lines
9.5 KiB
HTML
185 lines
9.5 KiB
HTML
<!DOCTYPE html>
|
||
<html class="writer-html5" lang="en" >
|
||
<head>
|
||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||
<title>mlx.optimizers.Optimizer — MLX 0.0.0 documentation</title>
|
||
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
|
||
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
|
||
<!--[if lt IE 9]>
|
||
<script src="../../_static/js/html5shiv.min.js"></script>
|
||
<![endif]-->
|
||
|
||
<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/js/theme.js"></script>
|
||
<link rel="index" title="Index" href="../../genindex.html" />
|
||
<link rel="search" title="Search" href="../../search.html" />
|
||
<link rel="next" title="mlx.optimizers.SGD" href="mlx.optimizers.SGD.html" />
|
||
<link rel="prev" title="mlx.optimizers.OptimizerState" href="mlx.optimizers.OptimizerState.html" />
|
||
</head>
|
||
|
||
<body class="wy-body-for-nav">
|
||
<div class="wy-grid-for-nav">
|
||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||
<div class="wy-side-scroll">
|
||
<div class="wy-side-nav-search" >
|
||
|
||
|
||
|
||
<a href="../../index.html" class="icon icon-home">
|
||
MLX
|
||
</a>
|
||
<div class="version">
|
||
0.0.0
|
||
</div>
|
||
<div role="search">
|
||
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
|
||
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||
<input type="hidden" name="check_keywords" value="yes" />
|
||
<input type="hidden" name="area" value="default" />
|
||
</form>
|
||
</div>
|
||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||
<p class="caption" role="heading"><span class="caption-text">Install</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../install.html">Build and Install</a></li>
|
||
</ul>
|
||
<p class="caption" role="heading"><span class="caption-text">Usage</span></p>
|
||
<ul>
|
||
<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 class="caption" role="heading"><span class="caption-text">Examples</span></p>
|
||
<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>
|
||
<p class="caption" role="heading"><span class="caption-text">Further Reading</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../dev/extensions.html">Developer Documentation</a></li>
|
||
</ul>
|
||
<p class="caption" role="heading"><span class="caption-text">Python API Reference</span></p>
|
||
<ul class="current">
|
||
<li class="toctree-l1"><a class="reference internal" href="../array.html">Array</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../devices_and_streams.html">Devices and Streams</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../ops.html">Operations</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../random.html">Random</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../transforms.html">Transforms</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../fft.html">FFT</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../nn.html">Neural Networks</a></li>
|
||
<li class="toctree-l1 current"><a class="reference internal" href="../optimizers.html">Optimizers</a><ul class="current">
|
||
<li class="toctree-l2"><a class="reference internal" href="mlx.optimizers.OptimizerState.html">mlx.optimizers.OptimizerState</a></li>
|
||
<li class="toctree-l2 current"><a class="current reference internal" href="#">mlx.optimizers.Optimizer</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="mlx.optimizers.SGD.html">mlx.optimizers.SGD</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="mlx.optimizers.Adam.html">mlx.optimizers.Adam</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../tree_utils.html">Tree Utils</a></li>
|
||
</ul>
|
||
<p class="caption" role="heading"><span class="caption-text">C++ API Reference</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../cpp/ops.html">Operations</a></li>
|
||
</ul>
|
||
|
||
</div>
|
||
</div>
|
||
</nav>
|
||
|
||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||
<a href="../../index.html">MLX</a>
|
||
</nav>
|
||
|
||
<div class="wy-nav-content">
|
||
<div class="rst-content">
|
||
<div role="navigation" aria-label="Page navigation">
|
||
<ul class="wy-breadcrumbs">
|
||
<li><a href="../../index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||
<li class="breadcrumb-item"><a href="../optimizers.html">Optimizers</a></li>
|
||
<li class="breadcrumb-item active">mlx.optimizers.Optimizer</li>
|
||
<li class="wy-breadcrumbs-aside">
|
||
<a href="../../_sources/python/_autosummary/mlx.optimizers.Optimizer.rst.txt" rel="nofollow"> View page source</a>
|
||
</li>
|
||
</ul>
|
||
<hr/>
|
||
</div>
|
||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||
<div itemprop="articleBody">
|
||
|
||
<section id="mlx-optimizers-optimizer">
|
||
<h1>mlx.optimizers.Optimizer<a class="headerlink" href="#mlx-optimizers-optimizer" title="Permalink to this heading"></a></h1>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="mlx.optimizers.Optimizer">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mlx.optimizers.</span></span><span class="sig-name descname"><span class="pre">Optimizer</span></span><a class="headerlink" href="#mlx.optimizers.Optimizer" title="Permalink to this definition"></a></dt>
|
||
<dd><p>The base class for all optimizers. It allows us to implement an
|
||
optimizer on a per-parameter basis and apply it to a parameter tree.</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="mlx.optimizers.Optimizer.state">
|
||
<span class="sig-name descname"><span class="pre">state</span></span><a class="headerlink" href="#mlx.optimizers.Optimizer.state" title="Permalink to this definition"></a></dt>
|
||
<dd><p>It holds the optimizer’s state dictionary.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="mlx.optimizers.OptimizerState.html#mlx.optimizers.OptimizerState" title="mlx.optimizers.OptimizerState"><em>OptimizerState</em></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<p class="rubric">Methods</p>
|
||
<table class="autosummary longtable docutils align-default">
|
||
<tbody>
|
||
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">__init__</span></code>()</p></td>
|
||
<td><p></p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">apply_gradients</span></code>(gradients, model)</p></td>
|
||
<td><p>Apply the gradients to the parameters and return the updated parameters.</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">apply_single</span></code>(gradient, parameter, state)</p></td>
|
||
<td><p>To be extended by the children classes to implement each optimizer's update.</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">update</span></code>(model, gradients)</p></td>
|
||
<td><p>Apply the gradients to the parameters of the model and update the model with the new parameters.</p></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||
<a href="mlx.optimizers.OptimizerState.html" class="btn btn-neutral float-left" title="mlx.optimizers.OptimizerState" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||
<a href="mlx.optimizers.SGD.html" class="btn btn-neutral float-right" title="mlx.optimizers.SGD" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||
</div>
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>© Copyright 2023, MLX Contributors.</p>
|
||
</div>
|
||
|
||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||
|
||
|
||
</footer>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<script>
|
||
jQuery(function () {
|
||
SphinxRtdTheme.Navigation.enable(true);
|
||
});
|
||
</script>
|
||
|
||
</body>
|
||
</html> |