docs update

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

Hide file tree

Showing 50 changed files with 646 additions and 772 deletions.
diff --git a/docs_src/_build/.doctrees/api/index.doctree b/docs_src/_build/.doctrees/api/index.doctree
diff --git a/docs_src/_build/.doctrees/api/nn.doctree b/docs_src/_build/.doctrees/api/nn.doctree
diff --git a/docs_src/_build/.doctrees/api/util/collect_results.doctree b/docs_src/_build/.doctrees/api/util/collect_results.doctree
diff --git a/docs_src/_build/.doctrees/api/util/estimate.doctree b/docs_src/_build/.doctrees/api/util/estimate.doctree
diff --git a/docs_src/_build/.doctrees/api/util/index.doctree b/docs_src/_build/.doctrees/api/util/index.doctree
diff --git a/docs_src/_build/.doctrees/api/util/models.doctree b/docs_src/_build/.doctrees/api/util/models.doctree
diff --git a/docs_src/_build/.doctrees/basic_usage.doctree b/docs_src/_build/.doctrees/basic_usage.doctree
diff --git a/docs_src/_build/.doctrees/environment.pickle b/docs_src/_build/.doctrees/environment.pickle
diff --git a/docs_src/_build/.doctrees/index.doctree b/docs_src/_build/.doctrees/index.doctree
diff --git a/docs_src/_build/api/index.html b/docs_src/_build/api/index.html
@@ -4,8 +4,8 @@
 <head>
   <meta charset="utf-8">
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
-      <title>API - MemSave PyTorch documentation</title>
-    <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="nn" href="nn.html" /><link rel="prev" title="Installation" href="../basic_usage.html" />
+      <title>API Reference - MemSave PyTorch documentation</title>
+    <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="nn" href="nn.html" /><link rel="prev" title="Installation / Quickstart" href="../basic_usage.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"))}
@@ -24,7 +24,7 @@
   --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="API"/>
+    <meta property="og:type" content="website"/><meta property="og:title" content="API Reference"/>
 <meta name="twitter:card" content="summary"/>
   </head>
 <body><div class="document"><div class="sy-head">
@@ -71,10 +71,23 @@
       <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</a></li>
-<li class="toctree-l1 current"><a class="current reference internal" href="#">API</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="nn.html">nn</a></li>
-<li class="toctree-l2"><a class="reference internal" href="util/index.html">util</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../basic_usage.html">Installation / Quickstart</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">API Reference</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="nn.html">nn</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="nn/memsave_torch.nn.MemSaveConv2d.html">MemSaveConv2d</a></li>
+<li class="toctree-l3"><a class="reference internal" href="nn/memsave_torch.nn.MemSaveLinear.html">MemSaveLinear</a></li>
+<li class="toctree-l3"><a class="reference internal" href="nn/memsave_torch.nn.MemSaveReLU.html">MemSaveReLU</a></li>
+<li class="toctree-l3"><a class="reference internal" href="nn/memsave_torch.nn.MemSaveMaxPool2d.html">MemSaveMaxPool2d</a></li>
+<li class="toctree-l3"><a class="reference internal" href="nn/memsave_torch.nn.MemSaveBatchNorm2d.html">MemSaveBatchNorm2d</a></li>
+<li class="toctree-l3"><a class="reference internal" href="nn/memsave_torch.nn.MemSaveLayerNorm.html">MemSaveLayerNorm</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="util/index.html">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>
@@ -89,14 +102,7 @@
     <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"><code class="xref py py-mod docutils literal notranslate"><span class="pre">memsave_torch.nn</span></code></a></li>
-</ul>
-
-  </div><div id="ethical-ad-placement" data-ea-publisher="readthedocs"></div>
+    <div class="sy-scrollbar sy-rside-inner px-6 xl:top-16 xl:sticky xl:pl-0 pt-6 pb-4"><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>
@@ -118,7 +124,7 @@ <h3>On this page</h3>
       </li>
 
       <li itemprop="itemListElement" itemscope itemtype="https://schema.org/ListItem">
-        <strong itemprop="name">API</strong>
+        <strong itemprop="name">API Reference</strong>
         <meta itemprop="position" content="2" />
       </li>
 
@@ -135,21 +141,30 @@ <h3>On this page</h3>
     <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="api">
-<h1>API<a class="headerlink" href="#api" title="Permalink to this heading">¶</a></h1>
+          <section id="api-reference">
+<h1>API Reference<a class="headerlink" href="#api-reference" title="Permalink to this heading">¶</a></h1>
 <div class="toctree-wrapper compound">
 <p class="caption" role="heading"><span class="caption-text">Available Modules</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="nn.html">nn</a></li>
-<li class="toctree-l1"><a class="reference internal" href="util/index.html">util</a></li>
+<li class="toctree-l1"><a class="reference internal" href="nn.html">nn</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="nn/memsave_torch.nn.MemSaveConv2d.html">MemSaveConv2d</a></li>
+<li class="toctree-l2"><a class="reference internal" href="nn/memsave_torch.nn.MemSaveLinear.html">MemSaveLinear</a></li>
+<li class="toctree-l2"><a class="reference internal" href="nn/memsave_torch.nn.MemSaveReLU.html">MemSaveReLU</a></li>
+<li class="toctree-l2"><a class="reference internal" href="nn/memsave_torch.nn.MemSaveMaxPool2d.html">MemSaveMaxPool2d</a></li>
+<li class="toctree-l2"><a class="reference internal" href="nn/memsave_torch.nn.MemSaveBatchNorm2d.html">MemSaveBatchNorm2d</a></li>
+<li class="toctree-l2"><a class="reference internal" href="nn/memsave_torch.nn.MemSaveLayerNorm.html">MemSaveLayerNorm</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="util/index.html">util ⚠️</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="util/collect_results.html">ResultsCollector</a></li>
+<li class="toctree-l2"><a class="reference internal" href="util/estimate.html">estimate.py</a></li>
+<li class="toctree-l2"><a class="reference internal" href="util/models.html">Models</a></li>
+</ul>
+</li>
 </ul>
 </div>
 <span class="target" id="module-memsave_torch"></span><p>memsave_torch package</p>
-<p>The <code class="docutils literal notranslate"><span class="pre">memsave_torch</span></code> package consists of two main modules <a class="reference internal" href="nn.html#module-memsave_torch.nn" title="memsave_torch.nn"><code class="xref py py-mod docutils literal notranslate"><span class="pre">nn</span></code></a> and <a class="reference internal" href="util/index.html#module-memsave_torch.util" title="memsave_torch.util"><code class="xref py py-mod docutils literal notranslate"><span class="pre">util</span></code></a></p>
-<section id="memsave-torch-nn">
-<h2><a class="reference internal" href="nn.html#module-memsave_torch.nn" title="memsave_torch.nn"><code class="xref py py-mod docutils literal notranslate"><span class="pre">memsave_torch.nn</span></code></a><a class="headerlink" href="#memsave-torch-nn" title="Permalink to this heading">¶</a></h2>
-<p>This module tries to mirror the <code class="docutils literal notranslate"><span class="pre">torch.nn</span></code> module, offering the following layers to be readily replaced by calling the <code class="xref py py-func docutils literal notranslate"><span class="pre">convert_to_memory_saving()</span></code> function:</p>
-</section>
+<p>The <code class="docutils literal notranslate"><span class="pre">memsave_torch</span></code> package consists of one main module: <a class="reference internal" href="nn.html#module-memsave_torch.nn" title="memsave_torch.nn"><code class="xref py py-mod docutils literal notranslate"><span class="pre">nn</span></code></a></p>
 </section>
 
         </article>
@@ -161,7 +176,7 @@ <h2><a class="reference internal" href="nn.html#module-memsave_torch.nn" title="
       <div class="page-info">
         <span>Previous</span>
 
-        <div class="title">Installation</div>
+        <div class="title">Installation / Quickstart</div>
 
       </div>
     </a>