deploy: c848f7d

MTG · Oct 2, 2024 · d0cc742 · d0cc742
commit d0cc742
Show file tree

Hide file tree

Showing 96 changed files with 17,778 additions and 0 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -0,0 +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: c167a9cbc21f3222f7a897d051f8e6a6
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/.doctrees/index.doctree b/.doctrees/index.doctree
diff --git a/.doctrees/source/basic_usage.doctree b/.doctrees/source/basic_usage.doctree
diff --git a/.doctrees/source/contributing.doctree b/.doctrees/source/contributing.doctree
diff --git a/.doctrees/source/datasets.doctree b/.doctrees/source/datasets.doctree
diff --git a/.doctrees/source/melody.doctree b/.doctrees/source/melody.doctree
diff --git a/.doctrees/source/rhythm.doctree b/.doctrees/source/rhythm.doctree
diff --git a/.doctrees/source/separation.doctree b/.doctrees/source/separation.doctree
diff --git a/.doctrees/source/structure.doctree b/.doctrees/source/structure.doctree
diff --git a/.doctrees/source/timbre.doctree b/.doctrees/source/timbre.doctree
diff --git a/.doctrees/source/utils.doctree b/.doctrees/source/utils.doctree
diff --git a/.doctrees/source/visualisation.doctree b/.doctrees/source/visualisation.doctree
diff --git a/.nojekyll b/.nojekyll
diff --git a/_modules/compiam.html b/_modules/compiam.html
diff --git a/_modules/compiam/dunya.html b/_modules/compiam/dunya.html
diff --git a/_modules/compiam/dunya/conn.html b/_modules/compiam/dunya/conn.html
diff --git a/_modules/compiam/melody/pattern/sancara_search.html b/_modules/compiam/melody/pattern/sancara_search.html
diff --git a/_modules/compiam/melody/pattern/sancara_search/extraction/self_sim.html b/_modules/compiam/melody/pattern/sancara_search/extraction/self_sim.html
diff --git a/_modules/compiam/melody/pitch_extraction/ftanet_carnatic.html b/_modules/compiam/melody/pitch_extraction/ftanet_carnatic.html
diff --git a/_modules/compiam/melody/pitch_extraction/melodia.html b/_modules/compiam/melody/pitch_extraction/melodia.html
diff --git a/_modules/compiam/melody/raga_recognition/deepsrgm.html b/_modules/compiam/melody/raga_recognition/deepsrgm.html
diff --git a/_modules/compiam/melody/tonic_identification/tonic_multipitch.html b/_modules/compiam/melody/tonic_identification/tonic_multipitch.html
diff --git a/_modules/compiam/rhythm/meter/akshara_pulse_tracker.html b/_modules/compiam/rhythm/meter/akshara_pulse_tracker.html
diff --git a/_modules/compiam/rhythm/transcription/mnemonic_transcription.html b/_modules/compiam/rhythm/transcription/mnemonic_transcription.html
diff --git a/_modules/compiam/separation/singing_voice_extraction/cold_diff_sep.html b/_modules/compiam/separation/singing_voice_extraction/cold_diff_sep.html
diff --git a/_modules/compiam/structure/segmentation/dhrupad_bandish_segmentation.html b/_modules/compiam/structure/segmentation/dhrupad_bandish_segmentation.html
diff --git a/_modules/compiam/timbre/stroke_classification/mridangam_stroke_classification.html b/_modules/compiam/timbre/stroke_classification/mridangam_stroke_classification.html
diff --git a/_modules/compiam/utils/augment.html b/_modules/compiam/utils/augment.html
diff --git a/_modules/compiam/utils/pitch.html b/_modules/compiam/utils/pitch.html
diff --git a/_modules/compiam/visualisation/audio.html b/_modules/compiam/visualisation/audio.html
diff --git a/_modules/compiam/visualisation/training.html b/_modules/compiam/visualisation/training.html
@@ -0,0 +1,146 @@
+<!DOCTYPE html>
+<html class="writer-html5" lang="en">
+<head>
+  <meta charset="utf-8" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>compiam.visualisation.training &mdash; compiam 0.3.0 documentation</title>
+      <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=80d5e7a1" />
+      <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=19f00094" />
+      <link rel="stylesheet" type="text/css" href="../../../_static/style.css?v=73862590" />
+
+
+  <!--[if lt IE 9]>
+    <script src="../../../_static/js/html5shiv.min.js"></script>
+  <![endif]-->
+
+        <script src="../../../_static/jquery.js?v=5d32c60e"></script>
+        <script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
+        <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js?v=c02300dd"></script>
+        <script src="../../../_static/doctools.js?v=888ff710"></script>
+        <script src="../../../_static/sphinx_highlight.js?v=4825356b"></script>
+    <script src="../../../_static/js/theme.js"></script>
+    <link rel="index" title="Index" href="../../../genindex.html" />
+    <link rel="search" title="Search" href="../../../search.html" /> 
+</head>
+
+<body class="wy-body-for-nav"> 
+  <div class="wy-grid-for-nav">
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search" >
+
+
+
+          <a href="../../../index.html" class="icon icon-home">
+            compiam
+          </a>
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
+              <p class="caption" role="heading"><span class="caption-text">Basic usage</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../source/basic_usage.html">Basic usage</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Tools and models</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../source/melody.html">Melodic analysis</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../source/rhythm.html">Rhythm analysis</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../source/structure.html">Structure analysis</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../source/timbre.html">Timbre analysis</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../source/separation.html">Separation</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Datasets</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../source/datasets.html">Load IAM datasets using mirdata</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../source/datasets.html#access-the-dunya-corpora">Access the Dunya corpora</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Miscellaneous</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../source/visualisation.html">Visualisation tools</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../source/utils.html">Util functions</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Contributing</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../source/contributing.html">Contribution guidelines for compIAM</a></li>
+</ul>
+
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="../../../index.html">compiam</a>
+      </nav>
+
+      <div class="wy-nav-content">
+        <div class="rst-content">
+          <div role="navigation" aria-label="Page navigation">
+  <ul class="wy-breadcrumbs">
+      <li><a href="../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
+          <li class="breadcrumb-item"><a href="../../index.html">Module code</a></li>
+          <li class="breadcrumb-item"><a href="../../compiam.html">compiam</a></li>
+      <li class="breadcrumb-item active">compiam.visualisation.training</li>
+      <li class="wy-breadcrumbs-aside">
+      </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+
+  <h1>Source code for compiam.visualisation.training</h1><div class="highlight"><pre>
+<span></span><span class="kn">import</span> <span class="nn">matplotlib.pyplot</span> <span class="k">as</span> <span class="nn">plt</span>
+
+
+<div class="viewcode-block" id="plot_losses"><a class="viewcode-back" href="../../../source/visualisation.html#compiam.visualisation.training.plot_losses">[docs]</a><span class="k">def</span> <span class="nf">plot_losses</span><span class="p">(</span><span class="n">train_loss</span><span class="p">,</span> <span class="n">val_loss</span><span class="p">,</span> <span class="n">output_path</span><span class="p">):</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Plotting loss curves</span>
+
+<span class="sd">    :param train_loss: training loss curve</span>
+<span class="sd">    :param val_loss: validation loss curve (same length as training curve)</span>
+<span class="sd">    :param output_path: optional path (finished with .png) where the plot is saved</span>
+<span class="sd">    &quot;&quot;&quot;</span>
+    <span class="n">plt</span><span class="o">.</span><span class="n">plot</span><span class="p">(</span><span class="n">train_loss</span><span class="p">,</span> <span class="n">label</span><span class="o">=</span><span class="s2">&quot;train&quot;</span><span class="p">)</span>
+    <span class="n">plt</span><span class="o">.</span><span class="n">plot</span><span class="p">(</span><span class="n">val_loss</span><span class="p">,</span> <span class="n">label</span><span class="o">=</span><span class="s2">&quot;val&quot;</span><span class="p">)</span>
+    <span class="n">plt</span><span class="o">.</span><span class="n">legend</span><span class="p">()</span>
+
+    <span class="k">if</span> <span class="n">output_path</span><span class="p">:</span>
+        <span class="n">plt</span><span class="o">.</span><span class="n">savefig</span><span class="p">(</span><span class="n">output_path</span><span class="p">)</span>
+        <span class="n">plt</span><span class="o">.</span><span class="n">clf</span><span class="p">()</span>
+    <span class="k">else</span><span class="p">:</span>
+        <span class="n">plt</span><span class="o">.</span><span class="n">show</span><span class="p">()</span></div>
+</pre></div>
+
+           </div>
+          </div>
+          <footer>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright 2022, Music Technology Group, Universitat Pompeu Fabra     (Genís Plaja-Roglans, Thomas Nuttall, Xavier Serra).</p>
+  </div>
+
+  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
+    provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+
+</footer>
+        </div>
+      </div>
+    </section>
+  </div>
+  <script>
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+</body>
+</html>
diff --git a/_modules/index.html b/_modules/index.html
@@ -0,0 +1,143 @@
+<!DOCTYPE html>
+<html class="writer-html5" lang="en">
+<head>
+  <meta charset="utf-8" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>Overview: module code &mdash; compiam 0.3.0 documentation</title>
+      <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
+      <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />
+      <link rel="stylesheet" type="text/css" href="../_static/style.css?v=73862590" />
+
+
+  <!--[if lt IE 9]>
+    <script src="../_static/js/html5shiv.min.js"></script>
+  <![endif]-->
+
+        <script src="../_static/jquery.js?v=5d32c60e"></script>
+        <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
+        <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=c02300dd"></script>
+        <script src="../_static/doctools.js?v=888ff710"></script>
+        <script src="../_static/sphinx_highlight.js?v=4825356b"></script>
+    <script src="../_static/js/theme.js"></script>
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" /> 
+</head>
+
+<body class="wy-body-for-nav"> 
+  <div class="wy-grid-for-nav">
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search" >
+
+
+
+          <a href="../index.html" class="icon icon-home">
+            compiam
+          </a>
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
+              <p class="caption" role="heading"><span class="caption-text">Basic usage</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../source/basic_usage.html">Basic usage</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Tools and models</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../source/melody.html">Melodic analysis</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../source/rhythm.html">Rhythm analysis</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../source/structure.html">Structure analysis</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../source/timbre.html">Timbre analysis</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../source/separation.html">Separation</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Datasets</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../source/datasets.html">Load IAM datasets using mirdata</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../source/datasets.html#access-the-dunya-corpora">Access the Dunya corpora</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Miscellaneous</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../source/visualisation.html">Visualisation tools</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../source/utils.html">Util functions</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Contributing</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../source/contributing.html">Contribution guidelines for compIAM</a></li>
+</ul>
+
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="../index.html">compiam</a>
+      </nav>
+
+      <div class="wy-nav-content">
+        <div class="rst-content">
+          <div role="navigation" aria-label="Page navigation">
+  <ul class="wy-breadcrumbs">
+      <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
+      <li class="breadcrumb-item active">Overview: module code</li>
+      <li class="wy-breadcrumbs-aside">
+      </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+
+  <h1>All modules for which code is available</h1>
+<ul><li><a href="compiam.html">compiam</a></li>
+<ul><li><a href="compiam/dunya.html">compiam.dunya</a></li>
+<ul><li><a href="compiam/dunya/conn.html">compiam.dunya.conn</a></li>
+</ul><li><a href="compiam/melody/pattern/sancara_search.html">compiam.melody.pattern.sancara_search</a></li>
+<ul><li><a href="compiam/melody/pattern/sancara_search/extraction/self_sim.html">compiam.melody.pattern.sancara_search.extraction.self_sim</a></li>
+</ul><li><a href="compiam/melody/pitch_extraction/ftanet_carnatic.html">compiam.melody.pitch_extraction.ftanet_carnatic</a></li>
+<li><a href="compiam/melody/pitch_extraction/melodia.html">compiam.melody.pitch_extraction.melodia</a></li>
+<li><a href="compiam/melody/raga_recognition/deepsrgm.html">compiam.melody.raga_recognition.deepsrgm</a></li>
+<li><a href="compiam/melody/tonic_identification/tonic_multipitch.html">compiam.melody.tonic_identification.tonic_multipitch</a></li>
+<li><a href="compiam/rhythm/meter/akshara_pulse_tracker.html">compiam.rhythm.meter.akshara_pulse_tracker</a></li>
+<li><a href="compiam/rhythm/transcription/mnemonic_transcription.html">compiam.rhythm.transcription.mnemonic_transcription</a></li>
+<li><a href="compiam/separation/singing_voice_extraction/cold_diff_sep.html">compiam.separation.singing_voice_extraction.cold_diff_sep</a></li>
+<li><a href="compiam/structure/segmentation/dhrupad_bandish_segmentation.html">compiam.structure.segmentation.dhrupad_bandish_segmentation</a></li>
+<li><a href="compiam/timbre/stroke_classification/mridangam_stroke_classification.html">compiam.timbre.stroke_classification.mridangam_stroke_classification</a></li>
+<li><a href="compiam/utils/augment.html">compiam.utils.augment</a></li>
+<li><a href="compiam/utils/pitch.html">compiam.utils.pitch</a></li>
+<li><a href="compiam/visualisation/audio.html">compiam.visualisation.audio</a></li>
+<li><a href="compiam/visualisation/training.html">compiam.visualisation.training</a></li>
+</ul></ul>
+
+           </div>
+          </div>
+          <footer>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright 2022, Music Technology Group, Universitat Pompeu Fabra     (Genís Plaja-Roglans, Thomas Nuttall, Xavier Serra).</p>
+  </div>
+
+  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
+    provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+
+</footer>
+        </div>
+      </div>
+    </section>
+  </div>
+  <script>
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+</body>
+</html>
diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt
@@ -0,0 +1,93 @@
+Welcome to compiam's documentation!
+===================================
+
+compIAM is a collaborative initiative lead by the MTG and involving many researchers that aims at putting together data 
+loaders, tools, and models for the computational analysis of two main Indian Art Music traditions: Carnatic and Hindustani.
+
+Installing compIAM
+++++++++++++++++++
+
+compIAM is registered to PyPI, therefore the latest release can be installed with:
+
+.. code-block:: bash
+
+    pip install compiam
+
+
+Nonetheless, to get the latest version of the library with the fresher updates, proceed as follows:
+
+.. code-block:: bash
+
+    git clone https://github.com/MTG/compIAM.git
+    cd compIAM
+
+    virtualenv -p python3 compiam_env
+    source compiam_env/bin/activate
+
+    pip install -e .
+    pip install -r requirements.txt
+
+
+License
++++++++
+compIAM is Copyright 2022 Music Technology Group - Universitat Pompeu Fabra
+
+compIAM is released under the terms of the GNU Affero General Public License (v3 or later). 
+See the COPYING file for more information. For the case of a particular tool or implementation 
+that has a specific different licence, this is explicitly specified in the files related to this
+tool, and these terms must be followed.
+
+For any licensing enquires, please contact us at `mtg-info@upf.edu`_.
+
+.. _mtg-info@upf.edu: mailto:mtg-info@upf.edu
+
+
+Citation
+++++++++
+If you use compIAM for your research, please consider citing our work as:
+
+.. code-block:: bibtex
+
+    @software{compiam_mtg,
+        author = {{Genís Plaja-Roglans and Thomas Nuttall and Xavier Serra}},
+        title = {compIAM},
+        url = {https://mtg.github.io/compIAM/},
+        version = {0.3.0},
+        year = {2023}
+    }
+
+
+.. toctree::
+   :caption: Basic usage
+   :hidden:
+
+   source/basic_usage
+
+.. toctree::
+   :caption: Tools and models
+   :hidden:
+
+   source/melody
+   source/rhythm
+   source/structure
+   source/timbre
+   source/separation
+
+.. toctree::
+   :caption: Datasets
+   :hidden:
+
+   source/datasets
+
+.. toctree::
+   :caption: Miscellaneous
+   :hidden:
+
+   source/visualisation
+   source/utils
+
+.. toctree::
+   :caption: Contributing
+   :hidden:
+
+   source/contributing