add wrongly ignored requirements.txt files + docs update

plutonium-239 · Apr 13, 2024 · 5e39242 · 5e39242
1 parent 0d4db94
commit 5e39242
Show file tree

Hide file tree

Showing 26 changed files with 2,007 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
 **/__pycache__
 *.txt
-*.csv
+*.csv
+!requirements.txt
diff --git a/docs_src/_build/.doctrees/api/nn/memsave_torch.nn.MemSaveBatchNorm2d.doctree b/docs_src/_build/.doctrees/api/nn/memsave_torch.nn.MemSaveBatchNorm2d.doctree
diff --git a/docs_src/_build/.doctrees/api/nn/memsave_torch.nn.MemSaveConv2d.doctree b/docs_src/_build/.doctrees/api/nn/memsave_torch.nn.MemSaveConv2d.doctree
diff --git a/docs_src/_build/.doctrees/api/nn/memsave_torch.nn.MemSaveLayerNorm.doctree b/docs_src/_build/.doctrees/api/nn/memsave_torch.nn.MemSaveLayerNorm.doctree
diff --git a/docs_src/_build/.doctrees/api/nn/memsave_torch.nn.MemSaveLinear.doctree b/docs_src/_build/.doctrees/api/nn/memsave_torch.nn.MemSaveLinear.doctree
diff --git a/docs_src/_build/.doctrees/api/nn/memsave_torch.nn.MemSaveMaxPool2d.doctree b/docs_src/_build/.doctrees/api/nn/memsave_torch.nn.MemSaveMaxPool2d.doctree
diff --git a/docs_src/_build/.doctrees/api/nn/memsave_torch.nn.MemSaveReLU.doctree b/docs_src/_build/.doctrees/api/nn/memsave_torch.nn.MemSaveReLU.doctree
diff --git a/docs_src/_build/_static/twemoji.css b/docs_src/_build/_static/twemoji.css
@@ -0,0 +1,6 @@
+img.emoji {
+    height: 1em;
+    width: 1em;
+    margin: 0 .05em 0 .1em;
+    vertical-align: -0.1em;
+}
diff --git a/docs_src/_build/_static/twemoji.js b/docs_src/_build/_static/twemoji.js
@@ -0,0 +1,10 @@
+function addEvent(element, eventName, fn) {
+    if (element.addEventListener)
+        element.addEventListener(eventName, fn, false);
+    else if (element.attachEvent)
+        element.attachEvent('on' + eventName, fn);
+}
+
+addEvent(window, 'load', function() {
+    twemoji.parse(document.body, {'folder': 'svg', 'ext': '.svg'});
+});
diff --git a/docs_src/_build/api/nn/memsave_torch.nn.MemSaveBatchNorm2d.html b/docs_src/_build/api/nn/memsave_torch.nn.MemSaveBatchNorm2d.html
@@ -0,0 +1,282 @@
+
+  <!DOCTYPE html>
+<html lang="en" data-accent-color="pink" data-content_root="">
+<head>
+  <meta charset="utf-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+      <title>MemSaveBatchNorm2d - MemSave PyTorch documentation</title>
+    <link rel="index" title="Index" href="../../genindex.html" /><link rel="search" title="Search" href="../../search.html" /><link rel="next" title="MemSaveLayerNorm" href="memsave_torch.nn.MemSaveLayerNorm.html" /><link rel="prev" title="MemSaveMaxPool2d" href="memsave_torch.nn.MemSaveMaxPool2d.html" />
+
+  <script>
+    function setColorMode(t){let e=document.documentElement;e.setAttribute("data-color-mode",t);let a=window.matchMedia&&window.matchMedia("(prefers-color-scheme: dark)").matches,s=t;"auto"===t&&(s=a?"dark":"light"),"light"===s?(e.classList.remove("dark"),e.classList.add("light")):(e.classList.remove("light"),e.classList.add("dark"))}
+    setColorMode(sessionStorage._theme||"auto");
+  </script><link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=aecf457f" />
+    <link rel="stylesheet" type="text/css" href="../../_static/shibuya.css?v=d42a0c83" />
+    <link rel="stylesheet" type="text/css" href="../../_static/copybutton.css?v=76b2166b" />
+    <link media="print" rel="stylesheet" type="text/css" href="../../_static/print.css?v=20ff2c19" />
+    <link rel="stylesheet" type="text/css" href="../../_static/style.css?v=06a6c44e" />
+    <link rel="preconnect" href="https://fonts.googleapis.com">
+<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
+<link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&display=swap" rel="stylesheet">
+<style>
+:root {
+  --sy-f-text: "Inter", var(--sy-f-sys), var(--sy-f-cjk), sans-serif;
+  --sy-f-heading: "Inter", var(--sy-f-sys), var(--sy-f-cjk), sans-serif;
+}
+</style>
+    <meta property="og:type" content="website"/><meta property="og:title" content="MemSaveBatchNorm2d"/>
+<meta name="twitter:card" content="summary"/>
+  </head>
+<body><div class="document"><div class="sy-head">
+  <div class="sy-head-blur"></div>
+  <div class="sy-head-inner sy-container mx-auto">
+    <a class="sy-head-brand mr-4" href="../../index.html">
+
+
+      <strong>MemSave PyTorch</strong>
+    </a>
+    <div class="sy-head-links" id="NavLinks">
+      <nav class="sy-head-nav"></nav>
+      <div class="sy-head-extra flex items-center print:hidden">
+<form class="searchbox flex items-center" action="../../search.html" method="get">
+  <input type="text" name="q" placeholder="Search" />
+  <kbd>/</kbd>
+</form>
+
+
+        <div class="sy-head-social flex items-center">
+        </div>
+      </div>
+    </div>
+    <div class="sy-head-actions flex items-center shrink-0 print:hidden">
+      <button class="js-theme theme-switch flex items-center"
+        data-aria-auto="Switch to light color mode"
+        data-aria-light="Switch to dark color mode"
+        data-aria-dark="Switch to auto color mode">
+        <i class="i-icon theme-icon"></i>
+      </button>
+      <button class="md:hidden flex items-center js-menu" aria-label="Menu" type="button" aria-controls="NavLinks" aria-expanded="false">
+        <div class="hamburger">
+          <span class="hamburger_1"></span>
+          <span class="hamburger_2 -translate-x-2"></span>
+          <span class="hamburger_3 -translate-x-1"></span>
+        </div>
+      </button>
+    </div>
+  </div>
+</div>
+<div class="sy-page sy-container flex mx-auto">
+  <aside id="lside" class="sy-lside md:w-72 md:shrink-0 print:hidden">
+    <div class="sy-lside-inner md:sticky">
+      <div class="sy-scrollbar p-6">
+        <div class="globaltoc" data-expand-depth="0"><p class="caption" role="heading"><span class="caption-text">Getting started</span></p>
+<ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="../../basic_usage.html">Installation / Quickstart</a></li>
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">API Reference</a><ul class="current">
+<li class="toctree-l2 current"><a class="reference internal" href="../nn.html">nn</a><ul class="current">
+<li class="toctree-l3"><a class="reference internal" href="memsave_torch.nn.MemSaveConv2d.html">MemSaveConv2d</a></li>
+<li class="toctree-l3"><a class="reference internal" href="memsave_torch.nn.MemSaveLinear.html">MemSaveLinear</a></li>
+<li class="toctree-l3"><a class="reference internal" href="memsave_torch.nn.MemSaveReLU.html">MemSaveReLU</a></li>
+<li class="toctree-l3"><a class="reference internal" href="memsave_torch.nn.MemSaveMaxPool2d.html">MemSaveMaxPool2d</a></li>
+<li class="toctree-l3 current"><a class="current reference internal" href="#">MemSaveBatchNorm2d</a></li>
+<li class="toctree-l3"><a class="reference internal" href="memsave_torch.nn.MemSaveLayerNorm.html">MemSaveLayerNorm</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="../util/index.html">experiments/util ⚠️</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="../util/collect_results.html">ResultsCollector</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../util/estimate.html">estimate.py</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../util/models.html">Models</a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+
+        </div>
+      </div>
+
+    </div>
+  </aside>
+  <div class="lside-overlay js-menu" role="button" aria-label="Close left sidebar" aria-controls="lside" aria-expanded="false"></div>
+  <aside id="rside" class="sy-rside pb-3 w-64 shrink-0 order-last">
+    <button class="rside-close js-menu xl:hidden" aria-label="Close Table of Contents" type="button" aria-controls="rside" aria-expanded="false">
+      <i class="i-icon close"></i>
+    </button>
+    <div class="sy-scrollbar sy-rside-inner px-6 xl:top-16 xl:sticky xl:pl-0 pt-6 pb-4">
+  <div class="localtoc">
+    <h3>On this page</h3>
+    <ul>
+<li><a class="reference internal" href="#memsave_torch.nn.MemSaveBatchNorm2d"><code class="docutils literal notranslate"><span class="pre">MemSaveBatchNorm2d</span></code></a><ul>
+<li><a class="reference internal" href="#memsave_torch.nn.MemSaveBatchNorm2d.forward"><code class="docutils literal notranslate"><span class="pre">MemSaveBatchNorm2d.forward()</span></code></a></li>
+<li><a class="reference internal" href="#memsave_torch.nn.MemSaveBatchNorm2d.from_nn_BatchNorm2d"><code class="docutils literal notranslate"><span class="pre">MemSaveBatchNorm2d.from_nn_BatchNorm2d()</span></code></a></li>
+</ul>
+</li>
+</ul>
+
+  </div><div id="ethical-ad-placement" data-ea-publisher="readthedocs"></div>
+    </div>
+  </aside>
+  <div class="rside-overlay js-menu" role="button" aria-label="Close Table of Contents" aria-controls="rside" aria-expanded="false"></div>
+  <main class="sy-main w-full max-sm:max-w-full print:pt-6">
+    <div class="sy-breadcrumbs" role="navigation">
+  <div class="sy-breadcrumbs-inner flex items-center">
+    <div class="md:hidden mr-3">
+      <button class="js-menu" aria-label="Menu" type="button" aria-controls="lside" aria-expanded="false">
+        <i class="i-icon menu"></i>
+      </button>
+    </div>
+    <ol class="flex-1" itemscope itemtype="https://schema.org/BreadcrumbList">
+
+
+      <li itemprop="itemListElement" itemscope itemtype="https://schema.org/ListItem">
+        <a itemprop="item" href="../../index.html"><span itemprop="name">MemSave PyTorch</span></a>
+        <span>/</span>
+        <meta itemprop="position" content="1" />
+      </li>
+
+      <li itemprop="itemListElement" itemscope itemtype="https://schema.org/ListItem">
+        <a itemprop="item" href="../index.html"><span itemprop="name">API Reference</span></a>
+        <span>/</span>
+        <meta itemprop="position" content="2" />
+      </li>
+
+      <li itemprop="itemListElement" itemscope itemtype="https://schema.org/ListItem">
+        <a itemprop="item" href="../nn.html"><span itemprop="name">nn</span></a>
+        <span>/</span>
+        <meta itemprop="position" content="3" />
+      </li>
+
+      <li itemprop="itemListElement" itemscope itemtype="https://schema.org/ListItem">
+        <strong itemprop="name">MemSaveBatchNorm2d</strong>
+        <meta itemprop="position" content="4" />
+      </li>
+
+
+    </ol>
+    <div class="xl:hidden ml-1">
+      <button class="js-menu" aria-label="Show table of contents" type="button" aria-controls="rside"
+        aria-expanded="false">
+        <i class="i-icon outdent"></i>
+      </button>
+    </div>
+  </div>
+</div>
+    <div class="flex flex-col break-words justify-between">
+      <div class="min-w-0 max-w-6xl px-6 pb-6 pt-8 xl:px-12">
+        <article class="yue" role="main">
+          <section id="memsavebatchnorm2d">
+<h1>MemSaveBatchNorm2d<a class="headerlink" href="#memsavebatchnorm2d" title="Permalink to this heading">¶</a></h1>
+<dl class="py class">
+<dt class="sig sig-object py" id="memsave_torch.nn.MemSaveBatchNorm2d">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">memsave_torch.nn.</span></span><span class="sig-name descname"><span class="pre">MemSaveBatchNorm2d</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">num_features</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">eps</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1e-05</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">momentum</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">affine</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">track_running_stats</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">device</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dtype</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#memsave_torch.nn.MemSaveBatchNorm2d" title="Permalink to this definition">¶</a></dt>
+<dd><p>MemSaveBatchNorm2d.</p>
+<p>Inits a BatchNorm2d layer with the given params</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>num_features</strong> – num_features</p></li>
+<li><p><strong>eps</strong> – eps</p></li>
+<li><p><strong>momentum</strong> – momentum</p></li>
+<li><p><strong>affine</strong> – affine</p></li>
+<li><p><strong>track_running_stats</strong> – track_running_stats</p></li>
+<li><p><strong>device</strong> – device</p></li>
+<li><p><strong>dtype</strong> – dtype</p></li>
+</ul>
+</dd>
+</dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="memsave_torch.nn.MemSaveBatchNorm2d.forward">
+<span class="sig-name descname"><span class="pre">forward</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#memsave_torch.nn.MemSaveBatchNorm2d.forward" title="Permalink to this definition">¶</a></dt>
+<dd><p>Forward pass.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>x</strong> – Input to the network [B, C, H, W]</p>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>Output [B, C, H, W]</p>
+</dd>
+<dt class="field-odd">Return type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference external" href="https://pytorch.org/docs/stable/tensors.html#torch.Tensor" title="(in PyTorch v2.2)">torch.Tensor</a></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="memsave_torch.nn.MemSaveBatchNorm2d.from_nn_BatchNorm2d">
+<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_nn_BatchNorm2d</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bn2d</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://pytorch.org/docs/stable/generated/torch.nn.BatchNorm2d.html#torch.nn.BatchNorm2d" title="(in PyTorch v2.2)"><span class="pre">BatchNorm2d</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#memsave_torch.nn.MemSaveBatchNorm2d.from_nn_BatchNorm2d" title="Permalink to this definition">¶</a></dt>
+<dd><p>Converts a nn.BatchNorm2d layer to MemSaveBatchNorm2d.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>bn2d</strong> – The nn.BatchNorm2d layer</p>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>The MemSaveBatchNorm2d object</p>
+</dd>
+<dt class="field-odd">Return type<span class="colon">:</span></dt>
+<dd class="field-odd"><p>obj</p>
+</dd>
+</dl>
+</dd></dl>
+
+</dd></dl>
+
+</section>
+
+        </article>
+
+        <div class="navigation flex print:hidden">
+  <div class="navigation-prev">
+    <a href="memsave_torch.nn.MemSaveMaxPool2d.html">
+      <i class="i-icon chevron"></i>
+      <div class="page-info">
+        <span>Previous</span>
+
+        <div class="title">MemSaveMaxPool2d</div>
+
+      </div>
+    </a>
+  </div>
+  <div class="navigation-next">
+    <a href="memsave_torch.nn.MemSaveLayerNorm.html">
+      <div class="page-info">
+        <span>Next</span>
+        <div class="title">MemSaveLayerNorm</div>
+      </div>
+      <i class="i-icon chevron"></i>
+    </a>
+  </div>
+</div>
+
+      </div>
+    </div>
+  </main>
+</div>
+<footer class="sy-foot">
+  <div class="sy-foot-inner sy-container mx-auto">
+
+    <div class="sy-foot-reserved md:flex justify-between items-center">
+      <div class="sy-foot-copyright"><p>2024, Samarth Bhatia, Felix Dangel</p>
+
+        <p>
+          Made with
+
+          <a href="https://www.sphinx-doc.org/">Sphinx</a> and
+
+          <a href="https://shibuya.lepture.com">Shibuya theme</a>.
+        </p>
+      </div>
+      <div class="sy-foot-socials">
+      </div>
+    </div>
+  </div>
+</footer></div>
+      <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=b3ba4146"></script>
+      <script src="../../_static/doctools.js?v=888ff710"></script>
+      <script src="../../_static/sphinx_highlight.js?v=4825356b"></script>
+      <script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
+      <script src="../../_static/copybutton.js?v=f281be69"></script>
+      <script src="../../_static/shibuya.js?v=999236dc"></script>
+      <script src="../../_static/autoscroll.js?v=f3ffc328"></script>
+
+</body>
+</html>