mirror of
				https://github.com/labmlai/annotated_deep_learning_paper_implementations.git
				synced 2025-10-31 18:58:43 +08:00 
			
		
		
		
	
		
			
				
	
	
		
			294 lines
		
	
	
		
			14 KiB
		
	
	
	
		
			HTML
		
	
	
	
	
	
			
		
		
	
	
			294 lines
		
	
	
		
			14 KiB
		
	
	
	
		
			HTML
		
	
	
	
	
	
| <!DOCTYPE html>
 | |
| <html lang="en">
 | |
| <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 bunch of utility functions and classes"/>
 | |
| 
 | |
|     <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="Utilities"/>
 | |
|     <meta name="twitter:description" content="A bunch of utility functions and classes"/>
 | |
|     <meta name="twitter:site" content="@labmlai"/>
 | |
|     <meta name="twitter:creator" content="@labmlai"/>
 | |
| 
 | |
|     <meta property="og:url" content="https://nn.labml.ai/utils/index.html"/>
 | |
|     <meta property="og:title" content="Utilities"/>
 | |
|     <meta property="og:image" content="https://avatars1.githubusercontent.com/u/64068543?s=400&v=4"/>
 | |
|     <meta property="og:site_name" content="Utilities"/>
 | |
|     <meta property="og:type" content="object"/>
 | |
|     <meta property="og:title" content="Utilities"/>
 | |
|     <meta property="og:description" content="A bunch of utility functions and classes"/>
 | |
| 
 | |
|     <title>Utilities</title>
 | |
|     <link rel="shortcut icon" href="/icon.png"/>
 | |
|     <link rel="stylesheet" href="../pylit.css?v=1">
 | |
|     <link rel="canonical" href="https://nn.labml.ai/utils/index.html"/>
 | |
|     <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/katex@0.13.18/dist/katex.min.css" integrity="sha384-zTROYFVGOfTw7JV7KUu8udsvW2fx4lWOsCEDqhBreBwlHI4ioVRtmIvEThzJHGET" crossorigin="anonymous">
 | |
| 
 | |
|     <!-- 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">utils</a>
 | |
|             </p>
 | |
|             <p>
 | |
|                 <a href="https://github.com/sponsors/labmlai" target="_blank">
 | |
|                     <img alt="Sponsor"
 | |
|                          src="https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub&color=%23fe8e86"
 | |
|                          style="max-width:100%;"/></a>
 | |
|                 <a href="https://github.com/labmlai/annotated_deep_learning_paper_implementations" target="_blank">
 | |
|                     <img alt="Github"
 | |
|                          src="https://img.shields.io/github/stars/labmlai/annotated_deep_learning_paper_implementations?style=social"
 | |
|                          style="max-width:100%;"/></a>
 | |
|                 <a href="https://twitter.com/labmlai" rel="nofollow" target="_blank">
 | |
|                     <img alt="Twitter"
 | |
|                          src="https://img.shields.io/twitter/follow/labmlai?style=social"
 | |
|                          style="max-width:100%;"/></a>
 | |
|             </p>
 | |
|             <p>
 | |
|                 <a href="https://github.com/labmlai/annotated_deep_learning_paper_implementations/tree/master/labml_nn/utils/__init__.py" target="_blank">
 | |
|                     View code on Github</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>Utilities</h1>
 | |
| 
 | |
|         </div>
 | |
|         <div class='code'>
 | |
|             <div class="highlight"><pre><span class="lineno">10</span><span></span><span class="kn">import</span> <span class="nn">copy</span>
 | |
| <span class="lineno">11</span>
 | |
| <span class="lineno">12</span><span class="kn">from</span> <span class="nn">torch.utils.data</span> <span class="kn">import</span> <span class="n">Dataset</span><span class="p">,</span> <span class="n">IterableDataset</span>
 | |
| <span class="lineno">13</span>
 | |
| <span class="lineno">14</span><span class="kn">from</span> <span class="nn">labml_helpers.module</span> <span class="kn">import</span> <span class="n">M</span><span class="p">,</span> <span class="n">TypedModuleList</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>Clone Module</h2>
 | |
| <p>Make a <code  class="highlight"><span></span><span class="n">nn</span><span class="o">.</span><span class="n">ModuleList</span></code>
 | |
|  with clones of a given module</p>
 | |
| 
 | |
|         </div>
 | |
|         <div class='code'>
 | |
|             <div class="highlight"><pre><span class="lineno">17</span><span class="k">def</span> <span class="nf">clone_module_list</span><span class="p">(</span><span class="n">module</span><span class="p">:</span> <span class="n">M</span><span class="p">,</span> <span class="n">n</span><span class="p">:</span> <span class="nb">int</span><span class="p">)</span> <span class="o">-></span> <span class="n">TypedModuleList</span><span class="p">[</span><span class="n">M</span><span class="p">]:</span></pre></div>
 | |
|         </div>
 | |
|     </div>
 | |
|     <div class='section' id='section-2'>
 | |
|         <div class='docs'>
 | |
|             <div class='section-link'>
 | |
|                 <a href='#section-2'>#</a>
 | |
|             </div>
 | |
|             
 | |
|         </div>
 | |
|         <div class='code'>
 | |
|             <div class="highlight"><pre><span class="lineno">23</span>    <span class="k">return</span> <span class="n">TypedModuleList</span><span class="p">([</span><span class="n">copy</span><span class="o">.</span><span class="n">deepcopy</span><span class="p">(</span><span class="n">module</span><span class="p">)</span> <span class="k">for</span> <span class="n">_</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">n</span><span class="p">)])</span></pre></div>
 | |
|         </div>
 | |
|     </div>
 | |
|     <div class='section' id='section-3'>
 | |
|         <div class='docs doc-strings'>
 | |
|             <div class='section-link'>
 | |
|                 <a href='#section-3'>#</a>
 | |
|             </div>
 | |
|             <p> <a id="cycle_dataloader"></a></p>
 | |
| <h2>Cycle Data Loader</h2>
 | |
| <p>Infinite loader that recycles the data loader after each epoch</p>
 | |
| 
 | |
|         </div>
 | |
|         <div class='code'>
 | |
|             <div class="highlight"><pre><span class="lineno">26</span><span class="k">def</span> <span class="nf">cycle_dataloader</span><span class="p">(</span><span class="n">data_loader</span><span class="p">):</span></pre></div>
 | |
|         </div>
 | |
|     </div>
 | |
|     <div class='section' id='section-4'>
 | |
|         <div class='docs'>
 | |
|             <div class='section-link'>
 | |
|                 <a href='#section-4'>#</a>
 | |
|             </div>
 | |
|             
 | |
|         </div>
 | |
|         <div class='code'>
 | |
|             <div class="highlight"><pre><span class="lineno">34</span>    <span class="k">while</span> <span class="kc">True</span><span class="p">:</span>
 | |
| <span class="lineno">35</span>        <span class="k">for</span> <span class="n">batch</span> <span class="ow">in</span> <span class="n">data_loader</span><span class="p">:</span>
 | |
| <span class="lineno">36</span>            <span class="k">yield</span> <span class="n">batch</span></pre></div>
 | |
|         </div>
 | |
|     </div>
 | |
|     <div class='section' id='section-5'>
 | |
|         <div class='docs doc-strings'>
 | |
|             <div class='section-link'>
 | |
|                 <a href='#section-5'>#</a>
 | |
|             </div>
 | |
|             <p> <a id="map_style_dataset"></a></p>
 | |
| <h2>Map Style Dataset</h2>
 | |
| <p>This converts an <a href="https://pytorch.org/docs/stable/data.html#torch.utils.data.IterableDataset"><code  class="highlight"><span></span><span class="n">IterableDataset</span></code>
 | |
| </a> to a <a href="https://pytorch.org/docs/stable/data.html#map-style-datasets">map-style dataset</a> so that we can shuffle the dataset.</p>
 | |
| <p><em>This only works when the dataset size is small and can be held in memory.</em></p>
 | |
| 
 | |
|         </div>
 | |
|         <div class='code'>
 | |
|             <div class="highlight"><pre><span class="lineno">39</span><span class="k">class</span> <span class="nc">MapStyleDataset</span><span class="p">(</span><span class="n">Dataset</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>
 | |
|             
 | |
|         </div>
 | |
|         <div class='code'>
 | |
|             <div class="highlight"><pre><span class="lineno">52</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">dataset</span><span class="p">:</span> <span class="n">IterableDataset</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>Load the data to memory </p>
 | |
| 
 | |
|         </div>
 | |
|         <div class='code'>
 | |
|             <div class="highlight"><pre><span class="lineno">54</span>        <span class="bp">self</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="p">[</span><span class="n">d</span> <span class="k">for</span> <span class="n">d</span> <span class="ow">in</span> <span class="n">dataset</span><span class="p">]</span></pre></div>
 | |
|         </div>
 | |
|     </div>
 | |
|     <div class='section' id='section-8'>
 | |
|         <div class='docs doc-strings'>
 | |
|             <div class='section-link'>
 | |
|                 <a href='#section-8'>#</a>
 | |
|             </div>
 | |
|             <p>Get a sample by index </p>
 | |
| 
 | |
|         </div>
 | |
|         <div class='code'>
 | |
|             <div class="highlight"><pre><span class="lineno">56</span>    <span class="k">def</span> <span class="fm">__getitem__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">idx</span><span class="p">:</span> <span class="nb">int</span><span class="p">):</span></pre></div>
 | |
|         </div>
 | |
|     </div>
 | |
|     <div class='section' id='section-9'>
 | |
|         <div class='docs'>
 | |
|             <div class='section-link'>
 | |
|                 <a href='#section-9'>#</a>
 | |
|             </div>
 | |
|             
 | |
|         </div>
 | |
|         <div class='code'>
 | |
|             <div class="highlight"><pre><span class="lineno">58</span>        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">[</span><span class="n">idx</span><span class="p">]</span></pre></div>
 | |
|         </div>
 | |
|     </div>
 | |
|     <div class='section' id='section-10'>
 | |
|         <div class='docs doc-strings'>
 | |
|             <div class='section-link'>
 | |
|                 <a href='#section-10'>#</a>
 | |
|             </div>
 | |
|             <p>Create an iterator </p>
 | |
| 
 | |
|         </div>
 | |
|         <div class='code'>
 | |
|             <div class="highlight"><pre><span class="lineno">60</span>    <span class="k">def</span> <span class="fm">__iter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span></pre></div>
 | |
|         </div>
 | |
|     </div>
 | |
|     <div class='section' id='section-11'>
 | |
|         <div class='docs'>
 | |
|             <div class='section-link'>
 | |
|                 <a href='#section-11'>#</a>
 | |
|             </div>
 | |
|             
 | |
|         </div>
 | |
|         <div class='code'>
 | |
|             <div class="highlight"><pre><span class="lineno">62</span>        <span class="k">return</span> <span class="nb">iter</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">)</span></pre></div>
 | |
|         </div>
 | |
|     </div>
 | |
|     <div class='section' id='section-12'>
 | |
|         <div class='docs doc-strings'>
 | |
|             <div class='section-link'>
 | |
|                 <a href='#section-12'>#</a>
 | |
|             </div>
 | |
|             <p>Size of the dataset </p>
 | |
| 
 | |
|         </div>
 | |
|         <div class='code'>
 | |
|             <div class="highlight"><pre><span class="lineno">64</span>    <span class="k">def</span> <span class="fm">__len__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span></pre></div>
 | |
|         </div>
 | |
|     </div>
 | |
|     <div class='section' id='section-13'>
 | |
|         <div class='docs'>
 | |
|             <div class='section-link'>
 | |
|                 <a href='#section-13'>#</a>
 | |
|             </div>
 | |
|             
 | |
|         </div>
 | |
|         <div class='code'>
 | |
|             <div class="highlight"><pre><span class="lineno">66</span>        <span class="k">return</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">)</span></pre></div>
 | |
|         </div>
 | |
|     </div>
 | |
|     <div class='footer'>
 | |
|         <a href="https://papers.labml.ai">Trending Research Papers</a>
 | |
|         <a href="https://labml.ai">labml.ai</a>
 | |
|     </div>
 | |
| </div>
 | |
| <script src=../interactive.js?v=1"></script>
 | |
| <script>
 | |
|     function handleImages() {
 | |
|         var images = document.querySelectorAll('p>img')
 | |
| 
 | |
|         for (var i = 0; i < images.length; ++i) {
 | |
|             handleImage(images[i])
 | |
|         }
 | |
|     }
 | |
| 
 | |
|     function handleImage(img) {
 | |
|         img.parentElement.style.textAlign = 'center'
 | |
| 
 | |
|         var modal = document.createElement('div')
 | |
|         modal.id = 'modal'
 | |
| 
 | |
|         var modalContent = document.createElement('div')
 | |
|         modal.appendChild(modalContent)
 | |
| 
 | |
|         var modalImage = document.createElement('img')
 | |
|         modalContent.appendChild(modalImage)
 | |
| 
 | |
|         var span = document.createElement('span')
 | |
|         span.classList.add('close')
 | |
|         span.textContent = 'x'
 | |
|         modal.appendChild(span)
 | |
| 
 | |
|         img.onclick = function () {
 | |
|             console.log('clicked')
 | |
|             document.body.appendChild(modal)
 | |
|             modalImage.src = img.src
 | |
|         }
 | |
| 
 | |
|         span.onclick = function () {
 | |
|             document.body.removeChild(modal)
 | |
|         }
 | |
|     }
 | |
| 
 | |
|     handleImages()
 | |
| </script>
 | |
| </body>
 | |
| </html> | 
