Add more sphinx content

gdalsanto · Sep 22, 2024 · daa15e4 · daa15e4
1 parent fb52c67
commit daa15e4
Show file tree

Hide file tree

Showing 23 changed files with 324 additions and 1,023 deletions.
diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree
diff --git a/docs/_build/doctrees/processor/dsp.doctree b/docs/_build/doctrees/processor/dsp.doctree
diff --git a/docs/_build/doctrees/system/recursion.doctree b/docs/_build/doctrees/system/recursion.doctree
diff --git a/docs/_build/html/.buildinfo b/docs/_build/html/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 3e4084a9a87a65b9b5e04fcbae264eb6
+config: 69acc6be0ee05af365182cd753a9a5aa
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/system/recursion.rst → docs/_build/html/.nojekyll b/docs/system/recursion.rst → docs/_build/html/.nojekyll
diff --git a/docs/_build/html/_sources/index.rst.txt b/docs/_build/html/_sources/index.rst.txt
@@ -3,14 +3,28 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to FLAMO's documentation!
+FLAMO
 =================================
 
+``FLAMO`` is an open-source frequecy-sampling library for audio-module optimization in ``PyTorch``.
+The code can be found in `this github repository <https://github.com/gdalsanto/flamo>`_.
+
+Installation
+---------------------------
+
+.. code-block:: bash
+    
+    pip install flamo
+
+
+Contents 
+--------------------------
+
 .. toctree::
    :maxdepth: 2
-   :caption: Contents:
-
+   :caption: Differentiable Digitial Signal Processor:
 
+   processor/dsp
 
 Indices and tables
 ==================

diff --git a/docs/_build/html/_sources/processor/dsp.rst.txt b/docs/_build/html/_sources/processor/dsp.rst.txt
@@ -0,0 +1,2 @@
+.. autoclass:: flamo.processor.dsp.Transform
+   :members:
diff --git a/docs/_build/html/_sources/system/recursion.rst.txt b/docs/_build/html/_sources/system/recursion.rst.txt
diff --git a/docs/_build/html/_static/documentation_options.js b/docs/_build/html/_static/documentation_options.js
@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: '0.0.1',
+    VERSION: '0.0.3',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/docs/_build/html/genindex.html b/docs/_build/html/genindex.html
@@ -4,10 +4,10 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Index &#8212; FLAMO 0.0.1 documentation</title>
+    <title>Index &#8212; FLAMO 0.0.3 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=61cd365c" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=12dfc556" />
-    <script src="_static/documentation_options.js?v=d45e8c67"></script>
+    <script src="_static/documentation_options.js?v=47de8214"></script>
     <script src="_static/doctools.js?v=9a2dae69"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="index" title="Index" href="#" />
@@ -33,8 +33,26 @@
 <h1 id="index">Index</h1>
 
 <div class="genindex-jumpbox">
+ <a href="#F"><strong>F</strong></a>
+ | <a href="#T"><strong>T</strong></a>
 
 </div>
+<h2 id="F">F</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="processor/dsp.html#flamo.processor.dsp.Transform.forward">forward() (flamo.processor.dsp.Transform method)</a>
+</li>
+  </ul></td>
+</tr></table>
+
+<h2 id="T">T</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="processor/dsp.html#flamo.processor.dsp.Transform">Transform (class in flamo.processor.dsp)</a>
+</li>
+  </ul></td>
+</tr></table>
+
 
 
           </div>
@@ -53,6 +71,10 @@ <h1 class="logo"><a href="index.html">FLAMO</a></h1>
 
 
 <h3>Navigation</h3>
+<p class="caption" role="heading"><span class="caption-text">Differentiable Digitial Signal Processor:</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="processor/dsp.html"><code class="docutils literal notranslate"><span class="pre">Transform</span></code></a></li>
+</ul>
 
 <div class="relations">
 <h3>Related Topics</h3>

diff --git a/docs/_build/html/index.html b/docs/_build/html/index.html
@@ -5,14 +5,15 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
-    <title>Welcome to FLAMO’s documentation! &#8212; FLAMO 0.0.1 documentation</title>
+    <title>FLAMO &#8212; FLAMO 0.0.3 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=61cd365c" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=12dfc556" />
-    <script src="_static/documentation_options.js?v=d45e8c67"></script>
+    <script src="_static/documentation_options.js?v=47de8214"></script>
     <script src="_static/doctools.js?v=9a2dae69"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
+    <link rel="next" title="&lt;no title&gt;" href="processor/dsp.html" />
 
   <link rel="stylesheet" href="_static/custom.css" type="text/css" />
 
@@ -30,11 +31,29 @@
 
           <div class="body" role="main">
 
-  <section id="welcome-to-flamo-s-documentation">
-<h1>Welcome to FLAMO’s documentation!<a class="headerlink" href="#welcome-to-flamo-s-documentation" title="Link to this heading">¶</a></h1>
+  <section id="flamo">
+<h1>FLAMO<a class="headerlink" href="#flamo" title="Link to this heading">¶</a></h1>
+<p><code class="docutils literal notranslate"><span class="pre">FLAMO</span></code> is an open-source frequecy-sampling library for audio-module optimization in <code class="docutils literal notranslate"><span class="pre">PyTorch</span></code>.
+The code can be found in <a class="reference external" href="https://github.com/gdalsanto/flamo">this github repository</a>.</p>
+<section id="installation">
+<h2>Installation<a class="headerlink" href="#installation" title="Link to this heading">¶</a></h2>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>flamo
+</pre></div>
+</div>
+</section>
+<section id="contents">
+<h2>Contents<a class="headerlink" href="#contents" title="Link to this heading">¶</a></h2>
 <div class="toctree-wrapper compound">
+<p class="caption" role="heading"><span class="caption-text">Differentiable Digitial Signal Processor:</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="processor/dsp.html"><code class="docutils literal notranslate"><span class="pre">Transform</span></code></a><ul>
+<li class="toctree-l2"><a class="reference internal" href="processor/dsp.html#flamo.processor.dsp.Transform.forward"><code class="docutils literal notranslate"><span class="pre">Transform.forward()</span></code></a></li>
+</ul>
+</li>
+</ul>
 </div>
 </section>
+</section>
 <section id="indices-and-tables">
 <h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Link to this heading">¶</a></h1>
 <ul class="simple">
@@ -61,11 +80,16 @@ <h1 class="logo"><a href="#">FLAMO</a></h1>
 
 
 <h3>Navigation</h3>
+<p class="caption" role="heading"><span class="caption-text">Differentiable Digitial Signal Processor:</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="processor/dsp.html"><code class="docutils literal notranslate"><span class="pre">Transform</span></code></a></li>
+</ul>
 
 <div class="relations">
 <h3>Related Topics</h3>
 <ul>
   <li><a href="#">Documentation overview</a><ul>
+      <li>Next: <a href="processor/dsp.html" title="next chapter">&lt;no title&gt;</a></li>
   </ul></li>
 </ul>
 </div>

diff --git a/docs/_build/html/objects.inv b/docs/_build/html/objects.inv
diff --git a/docs/_build/html/processor/dsp.html b/docs/_build/html/processor/dsp.html
@@ -0,0 +1,125 @@
+<!DOCTYPE html>
+
+<html lang="en" data-content_root="../">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
+
+    <title>&lt;no title&gt; &#8212; FLAMO 0.0.3 documentation</title>
+    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=61cd365c" />
+    <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=12dfc556" />
+    <script src="../_static/documentation_options.js?v=47de8214"></script>
+    <script src="../_static/doctools.js?v=9a2dae69"></script>
+    <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" />
+    <link rel="prev" title="FLAMO" href="../index.html" />
+
+  <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
+
+
+
+
+
+  </head><body>
+
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+
+
+          <div class="body" role="main">
+
+  <dl class="py class">
+<dt class="sig sig-object py" id="flamo.processor.dsp.Transform">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">flamo.processor.dsp.</span></span><span class="sig-name descname"><span class="pre">Transform</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">transform=&lt;function</span> <span class="pre">Transform.&lt;lambda&gt;&gt;</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#flamo.processor.dsp.Transform" title="Link to this definition">¶</a></dt>
+<dd><dl class="py method">
+<dt class="sig sig-object py" id="flamo.processor.dsp.Transform.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="#flamo.processor.dsp.Transform.forward" title="Link to this definition">¶</a></dt>
+<dd><p>Define the computation performed at every call.</p>
+<p>Should be overridden by all subclasses.</p>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>Although the recipe for forward pass needs to be defined within
+this function, one should call the <code class="xref py py-class docutils literal notranslate"><span class="pre">Module</span></code> instance afterwards
+instead of this since the former takes care of running the
+registered hooks while the latter silently ignores them.</p>
+</div>
+</dd></dl>
+
+</dd></dl>
+
+
+
+          </div>
+
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+        <div class="sphinxsidebarwrapper">
+<h1 class="logo"><a href="../index.html">FLAMO</a></h1>
+
+
+
+
+
+
+
+
+<h3>Navigation</h3>
+<p class="caption" role="heading"><span class="caption-text">Differentiable Digitial Signal Processor:</span></p>
+<ul class="current">
+<li class="toctree-l1 current"><a class="current reference internal" href="#"><code class="docutils literal notranslate"><span class="pre">Transform</span></code></a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#flamo.processor.dsp.Transform.forward"><code class="docutils literal notranslate"><span class="pre">Transform.forward()</span></code></a></li>
+</ul>
+</li>
+</ul>
+
+<div class="relations">
+<h3>Related Topics</h3>
+<ul>
+  <li><a href="../index.html">Documentation overview</a><ul>
+      <li>Previous: <a href="../index.html" title="previous chapter">FLAMO</a></li>
+  </ul></li>
+</ul>
+</div>
+<search id="searchbox" style="display: none" role="search">
+  <h3 id="searchlabel">Quick search</h3>
+    <div class="searchformwrapper">
+    <form class="search" action="../search.html" method="get">
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+      <input type="submit" value="Go" />
+    </form>
+    </div>
+</search>
+<script>document.getElementById('searchbox').style.display = "block"</script>
+
+
+
+
+
+
+
+
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="footer">
+      &#169;2024, Gloria Dal Santo; Gian Marco De Bortoli; Sebastian J. Schlecht.
+
+      |
+      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 7.3.7</a>
+      &amp; <a href="https://alabaster.readthedocs.io">Alabaster 0.7.16</a>
+
+      |
+      <a href="../_sources/processor/dsp.rst.txt"
+          rel="nofollow">Page source</a>
+    </div>
+
+
+
+
+  </body>
+</html>
diff --git a/docs/_build/html/search.html b/docs/_build/html/search.html
@@ -4,11 +4,11 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Search &#8212; FLAMO 0.0.1 documentation</title>
+    <title>Search &#8212; FLAMO 0.0.3 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=61cd365c" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=12dfc556" />
 
-    <script src="_static/documentation_options.js?v=d45e8c67"></script>
+    <script src="_static/documentation_options.js?v=47de8214"></script>
     <script src="_static/doctools.js?v=9a2dae69"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/searchtools.js"></script>
@@ -80,6 +80,10 @@ <h1 class="logo"><a href="index.html">FLAMO</a></h1>
 
 
 <h3>Navigation</h3>
+<p class="caption" role="heading"><span class="caption-text">Differentiable Digitial Signal Processor:</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="processor/dsp.html"><code class="docutils literal notranslate"><span class="pre">Transform</span></code></a></li>
+</ul>
 
 <div class="relations">
 <h3>Related Topics</h3>

diff --git a/docs/_build/html/searchindex.js b/docs/_build/html/searchindex.js
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		.. autoclass:: flamo.processor.dsp.Transform
		:members: