mirror of
				https://github.com/labmlai/annotated_deep_learning_paper_implementations.git
				synced 2025-10-30 18:27:03 +08:00 
			
		
		
		
	
		
			
				
	
	
		
			217 lines
		
	
	
		
			13 KiB
		
	
	
	
		
			HTML
		
	
	
	
	
	
			
		
		
	
	
			217 lines
		
	
	
		
			13 KiB
		
	
	
	
		
			HTML
		
	
	
	
	
	
| <!DOCTYPE html>
 | |
| <html>
 | |
| <head>
 | |
|     <meta http-equiv="content-type" content="text/html;charset=utf-8"/>
 | |
|     <meta name="viewport" content="width=device-width, initial-scale=1.0"/>
 | |
|     <meta name="description" content="A simple PyTorch implementation/tutorial of Adam optimizer with warm-up."/>
 | |
| 
 | |
|     <meta name="twitter:card" content="summary"/>
 | |
|     <meta name="twitter:image:src" content="https://avatars1.githubusercontent.com/u/64068543?s=400&v=4"/>
 | |
|     <meta name="twitter:title" content="Adam optimizer with warm-up"/>
 | |
|     <meta name="twitter:description" content="A simple PyTorch implementation/tutorial of Adam optimizer with warm-up."/>
 | |
|     <meta name="twitter:site" content="@labmlai"/>
 | |
|     <meta name="twitter:creator" content="@labmlai"/>
 | |
| 
 | |
|     <meta property="og:url" content="https://nn.labml.ai/optimizers/adam_warmup.html"/>
 | |
|     <meta property="og:title" content="Adam optimizer with warm-up"/>
 | |
|     <meta property="og:image" content="https://avatars1.githubusercontent.com/u/64068543?s=400&v=4"/>
 | |
|     <meta property="og:site_name" content="LabML Neural Networks"/>
 | |
|     <meta property="og:type" content="object"/>
 | |
|     <meta property="og:title" content="Adam optimizer with warm-up"/>
 | |
|     <meta property="og:description" content="A simple PyTorch implementation/tutorial of Adam optimizer with warm-up."/>
 | |
| 
 | |
|     <title>Adam optimizer with warm-up</title>
 | |
|     <link rel="shortcut icon" href="/icon.png"/>
 | |
|     <link rel="stylesheet" href="../pylit.css">
 | |
|     <link rel="canonical" href="https://nn.labml.ai/optimizers/adam_warmup.html"/>
 | |
|     <!-- Global site tag (gtag.js) - Google Analytics -->
 | |
|     <script async src="https://www.googletagmanager.com/gtag/js?id=G-4V3HC8HBLH"></script>
 | |
|     <script>
 | |
|         window.dataLayer = window.dataLayer || [];
 | |
| 
 | |
|         function gtag() {
 | |
|             dataLayer.push(arguments);
 | |
|         }
 | |
| 
 | |
|         gtag('js', new Date());
 | |
| 
 | |
|         gtag('config', 'G-4V3HC8HBLH');
 | |
|     </script>
 | |
| </head>
 | |
| <body>
 | |
| <div id='container'>
 | |
|     <div id="background"></div>
 | |
|     <div class='section'>
 | |
|         <div class='docs'>
 | |
|             <p>
 | |
|                 <a class="parent" href="/">home</a>
 | |
|                 <a class="parent" href="index.html">optimizers</a>
 | |
|             </p>
 | |
|             <p>
 | |
| 
 | |
|                 <a href="https://github.com/lab-ml/labml_nn/tree/master/labml_nn/optimizers/adam_warmup.py">
 | |
|                     <img alt="Github"
 | |
|                          src="https://img.shields.io/github/stars/lab-ml/nn?style=social"
 | |
|                          style="max-width:100%;"/></a>
 | |
|                 <a href="https://join.slack.com/t/labforml/shared_invite/zt-egj9zvq9-Dl3hhZqobexgT7aVKnD14g/"
 | |
|                    rel="nofollow">
 | |
|                     <img alt="Join Slact"
 | |
|                          src="https://img.shields.io/badge/slack-chat-green.svg?logo=slack"
 | |
|                          style="max-width:100%;"/></a>
 | |
|                 <a href="https://twitter.com/labmlai"
 | |
|                    rel="nofollow">
 | |
|                     <img alt="Twitter"
 | |
|                          src="https://img.shields.io/twitter/follow/labmlai?style=social"
 | |
|                          style="max-width:100%;"/></a>
 | |
|             </p>
 | |
|         </div>
 | |
|     </div>
 | |
|     <div class='section' id='section-0'>
 | |
|         <div class='docs doc-strings'>
 | |
|                 <div class='section-link'>
 | |
|                     <a href='#section-0'>#</a>
 | |
|                 </div>
 | |
|                 <h1>Adam Optimizer with Warmup</h1>
 | |
| <p>This extends <a href="amsgrad.html">AMSGrad optimizer</a> and adds a warmup stage.</p>
 | |
|             </div>
 | |
|             <div class='code'>
 | |
|                 <div class="highlight"><pre><span class="lineno">12</span><span></span><span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Dict</span>
 | |
| <span class="lineno">13</span>
 | |
| <span class="lineno">14</span><span class="kn">from</span> <span class="nn">labml_nn.optimizers</span> <span class="kn">import</span> <span class="n">WeightDecay</span>
 | |
| <span class="lineno">15</span><span class="kn">from</span> <span class="nn">labml_nn.optimizers.amsgrad</span> <span class="kn">import</span> <span class="n">AMSGrad</span></pre></div>
 | |
|             </div>
 | |
|         </div>
 | |
|     <div class='section' id='section-1'>
 | |
|         <div class='docs doc-strings'>
 | |
|                 <div class='section-link'>
 | |
|                     <a href='#section-1'>#</a>
 | |
|                 </div>
 | |
|                 <h2>Adam Optimizer with Warmup</h2>
 | |
| <p>This class extends from AMSGrad optimizer defined in <a href="amsgrad.html"><code>amsgrad.py</code></a>.</p>
 | |
|             </div>
 | |
|             <div class='code'>
 | |
|                 <div class="highlight"><pre><span class="lineno">18</span><span class="k">class</span> <span class="nc">AdamWarmup</span><span class="p">(</span><span class="n">AMSGrad</span><span class="p">):</span></pre></div>
 | |
|             </div>
 | |
|         </div>
 | |
|     <div class='section' id='section-2'>
 | |
|         <div class='docs doc-strings'>
 | |
|                 <div class='section-link'>
 | |
|                     <a href='#section-2'>#</a>
 | |
|                 </div>
 | |
|                 <h3>Initialize the optimizer</h3>
 | |
| <ul>
 | |
| <li><code>params</code> is the list of parameters</li>
 | |
| <li><code>lr</code> is the learning rate $\alpha$</li>
 | |
| <li><code>betas</code> is a tuple of ($\beta_1$, $\beta_2$)</li>
 | |
| <li><code>eps</code> is $\hat{\epsilon}$ or $\epsilon$ based on <code>optimized_update</code></li>
 | |
| <li><code>weight_decay</code> is an instance of class <code>WeightDecay</code> defined in <a href="index.html"><code>__init__.py</code></a></li>
 | |
| <li>‘optimized_update’ is a flag whether to optimize the bias correction of the second moment
 | |
|   by doing it after adding $\epsilon$</li>
 | |
| <li><code>amsgrad</code> is a flag indicating whether to use AMSGrad or fallback to plain Adam</li>
 | |
| <li><code>warmup</code> number of warmup steps</li>
 | |
| <li><code>defaults</code> is a dictionary of default for group values.
 | |
|  This is useful when you want to extend the class <code>AdamWarmup</code>.</li>
 | |
| </ul>
 | |
|             </div>
 | |
|             <div class='code'>
 | |
|                 <div class="highlight"><pre><span class="lineno">24</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">params</span><span class="p">,</span> <span class="n">lr</span><span class="o">=</span><span class="mf">1e-3</span><span class="p">,</span> <span class="n">betas</span><span class="o">=</span><span class="p">(</span><span class="mf">0.9</span><span class="p">,</span> <span class="mf">0.999</span><span class="p">),</span> <span class="n">eps</span><span class="o">=</span><span class="mf">1e-16</span><span class="p">,</span>
 | |
| <span class="lineno">25</span>                 <span class="n">weight_decay</span><span class="p">:</span> <span class="n">WeightDecay</span> <span class="o">=</span> <span class="n">WeightDecay</span><span class="p">(),</span>
 | |
| <span class="lineno">26</span>                 <span class="n">optimized_update</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span><span class="p">,</span>
 | |
| <span class="lineno">27</span>                 <span class="n">amsgrad</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">warmup</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">defaults</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span></pre></div>
 | |
|             </div>
 | |
|         </div>
 | |
|     <div class='section' id='section-3'>
 | |
|             <div class='docs'>
 | |
|                 <div class='section-link'>
 | |
|                     <a href='#section-3'>#</a>
 | |
|                 </div>
 | |
|                 
 | |
|             </div>
 | |
|             <div class='code'>
 | |
|                 <div class="highlight"><pre><span class="lineno">44</span>        <span class="n">defaults</span> <span class="o">=</span> <span class="p">{}</span> <span class="k">if</span> <span class="n">defaults</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span> <span class="n">defaults</span>
 | |
| <span class="lineno">45</span>        <span class="n">defaults</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="nb">dict</span><span class="p">(</span><span class="n">warmup</span><span class="o">=</span><span class="n">warmup</span><span class="p">))</span>
 | |
| <span class="lineno">46</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="n">params</span><span class="p">,</span> <span class="n">lr</span><span class="p">,</span> <span class="n">betas</span><span class="p">,</span> <span class="n">eps</span><span class="p">,</span> <span class="n">weight_decay</span><span class="p">,</span> <span class="n">optimized_update</span><span class="p">,</span> <span class="n">amsgrad</span><span class="p">,</span> <span class="n">defaults</span><span class="p">)</span></pre></div>
 | |
|             </div>
 | |
|         </div>
 | |
|     <div class='section' id='section-4'>
 | |
|         <div class='docs doc-strings'>
 | |
|                 <div class='section-link'>
 | |
|                     <a href='#section-4'>#</a>
 | |
|                 </div>
 | |
|                 <h3>Get learning-rate</h3>
 | |
| <p>
 | |
| <script type="math/tex; mode=display">\alpha \min \bigg(1, \frac{t}{w}\bigg)</script>
 | |
| where $w$ is the number of warmup steps.</p>
 | |
|             </div>
 | |
|             <div class='code'>
 | |
|                 <div class="highlight"><pre><span class="lineno">48</span>    <span class="k">def</span> <span class="nf">get_lr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">state</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">any</span><span class="p">],</span> <span class="n">group</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">any</span><span class="p">]):</span></pre></div>
 | |
|             </div>
 | |
|         </div>
 | |
|     <div class='section' id='section-5'>
 | |
|             <div class='docs'>
 | |
|                 <div class='section-link'>
 | |
|                     <a href='#section-5'>#</a>
 | |
|                 </div>
 | |
|                 <p>If we are in warmup stage</p>
 | |
|             </div>
 | |
|             <div class='code'>
 | |
|                 <div class="highlight"><pre><span class="lineno">56</span>        <span class="k">if</span> <span class="n">group</span><span class="p">[</span><span class="s1">'warmup'</span><span class="p">]</span> <span class="o">></span> <span class="n">state</span><span class="p">[</span><span class="s1">'step'</span><span class="p">]:</span></pre></div>
 | |
|             </div>
 | |
|         </div>
 | |
|     <div class='section' id='section-6'>
 | |
|             <div class='docs'>
 | |
|                 <div class='section-link'>
 | |
|                     <a href='#section-6'>#</a>
 | |
|                 </div>
 | |
|                 <p>A linearly increasing learning rate from $0$ to $\alpha$</p>
 | |
|             </div>
 | |
|             <div class='code'>
 | |
|                 <div class="highlight"><pre><span class="lineno">58</span>            <span class="k">return</span> <span class="mf">1e-8</span> <span class="o">+</span> <span class="n">state</span><span class="p">[</span><span class="s1">'step'</span><span class="p">]</span> <span class="o">*</span> <span class="n">group</span><span class="p">[</span><span class="s1">'lr'</span><span class="p">]</span> <span class="o">/</span> <span class="n">group</span><span class="p">[</span><span class="s1">'warmup'</span><span class="p">]</span>
 | |
| <span class="lineno">59</span>        <span class="k">else</span><span class="p">:</span></pre></div>
 | |
|             </div>
 | |
|         </div>
 | |
|     <div class='section' id='section-7'>
 | |
|             <div class='docs'>
 | |
|                 <div class='section-link'>
 | |
|                     <a href='#section-7'>#</a>
 | |
|                 </div>
 | |
|                 <p>Constant learning rate $\alpha$</p>
 | |
|             </div>
 | |
|             <div class='code'>
 | |
|                 <div class="highlight"><pre><span class="lineno">61</span>            <span class="k">return</span> <span class="n">group</span><span class="p">[</span><span class="s1">'lr'</span><span class="p">]</span></pre></div>
 | |
|             </div>
 | |
|         </div>
 | |
|     </div>
 | |
| </div>
 | |
| <script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.4/MathJax.js?config=TeX-AMS_HTML">
 | |
| </script>
 | |
| <!-- MathJax configuration -->
 | |
| <script type="text/x-mathjax-config">
 | |
|     MathJax.Hub.Config({
 | |
|         tex2jax: {
 | |
|             inlineMath: [ ['$','$'] ],
 | |
|             displayMath: [ ['$$','$$'] ],
 | |
|             processEscapes: true,
 | |
|             processEnvironments: true
 | |
|         },
 | |
|         // Center justify equations in code and markdown cells. Elsewhere
 | |
|         // we use CSS to left justify single line equations in code cells.
 | |
|         displayAlign: 'center',
 | |
|         "HTML-CSS": { fonts: ["TeX"] }
 | |
|     });
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| </script>
 | |
| </body>
 | |
| </html> | 
