update notebook and minor fixes

TempoBeatDownbeat · Nov 8, 2021 · 1b7b2d5 · 1b7b2d5
1 parent e0c62b5
commit 1b7b2d5
Show file tree

Hide file tree

Showing 23 changed files with 869 additions and 900 deletions.
diff --git a/README.md b/README.md
@@ -4,6 +4,12 @@
 
 Resources and Jupyter Book for the ISMIR 2021 tutorial on Tempo, Beat and Downbeat estimation.
 
+To jump directly to the hands on part:
+[![Open In Collab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1tuOqNyO9gdMmYJsj33fP_QOfpRsm2tmt?usp=sharing)
+
+To go directly to the book:
+https://tempobeatdownbeat.github.io/tutorial
+
 
 ### Install
 

diff --git a/book/.DS_Store b/book/.DS_Store
diff --git a/book/_build/.doctrees/ch1_intro/tutorial_structure.doctree b/book/_build/.doctrees/ch1_intro/tutorial_structure.doctree
diff --git a/book/_build/.doctrees/ch2_basics/evaluate.doctree b/book/_build/.doctrees/ch2_basics/evaluate.doctree
diff --git a/book/_build/.doctrees/ch4_going_deeper/building_tcn_models.doctree b/book/_build/.doctrees/ch4_going_deeper/building_tcn_models.doctree
diff --git a/book/_build/.doctrees/environment.pickle b/book/_build/.doctrees/environment.pickle
diff --git a/book/_build/.doctrees/intro.doctree b/book/_build/.doctrees/intro.doctree
diff --git a/book/_build/html/_sources/ch1_intro/tutorial_structure.md b/book/_build/html/_sources/ch1_intro/tutorial_structure.md
@@ -43,9 +43,6 @@ If you choose to run locally, here are the recommended steps:
 1) Clone the [github repo](https://github.com/TempoBeatDownbeat/tutorial) into a 
    new directory.
 2) Make a new conda environment.
-    - If you want to install using the included `environment.yml` file see the
-  ([instructions here](https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#creating-an-environment-from-an-environment-yml-file)).
-  Then activate your environment.
     - If you want to install using `pip`, activate your environment and the
   run `pip install -r requirements.txt`. Note that you should have `ffmpeg` installed
   prior to installing the requirements ([instructions here](https://ffmpeg.org/download.html)).

diff --git a/book/_build/html/_sources/ch2_basics/evaluate.ipynb b/book/_build/html/_sources/ch2_basics/evaluate.ipynb
@@ -40,7 +40,7 @@
     "is time-consuming and expensive (it requires real-time listening possibly multiple times).\n",
     "It is also difficult to repeat in an exact way and to determine \n",
     "a set of unambiguous judging criteria. Note, since most people\n",
-    "only have \"reletaive\" rather than \"perfect tempo\" it's rather hard to \n",
+    "only have \"relative\" rather than \"perfect tempo\" it's rather hard to \n",
     "design an subjective experiment for absolute tempo perception\n",
     "without the instantion of the tempo in terms of beats. \n",
     "\n",

diff --git a/book/_build/html/_sources/ch4_going_deeper/building_tcn_models.md b/book/_build/html/_sources/ch4_going_deeper/building_tcn_models.md
@@ -1,5 +1,5 @@
 Hands on!
 =========
 
-Let's get hands on in some data and models! Please click in the <a href="https://colab.research.google.com/drive/1tuOqNyO9gdMmYJsj33fP_QOfpRsm2tmt?usp=sharing" target="_blank">Colab link</a>!
+Let's get hands on in some data and models! [![Open In Collab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1tuOqNyO9gdMmYJsj33fP_QOfpRsm2tmt?usp=sharing)
 
diff --git a/book/_build/html/_sources/intro.md b/book/_build/html/_sources/intro.md
@@ -40,7 +40,10 @@ of python notebooks.
 all of the main practical code examples can be found 
 in the following Google Colab notebook:** 
 
-<a href="https://colab.research.google.com/drive/1tuOqNyO9gdMmYJsj33fP_QOfpRsm2tmt?usp=sharing" target="_blank">Colab link</a>
+
+[![Open In Collab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1tuOqNyO9gdMmYJsj33fP_QOfpRsm2tmt?usp=sharing)
+
+
 
 
 

diff --git a/book/_build/html/ch1_intro/tutorial_structure.html b/book/_build/html/ch1_intro/tutorial_structure.html
@@ -389,9 +389,6 @@ <h3>Running Locally<a class="headerlink" href="#running-locally" title="Permalin
 new directory.</p></li>
 <li><p>Make a new conda environment.</p>
 <ul class="simple">
-<li><p>If you want to install using the included <code class="docutils literal notranslate"><span class="pre">environment.yml</span></code> file see the
-(<a class="reference external" href="https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#creating-an-environment-from-an-environment-yml-file">instructions here</a>).
-Then activate your environment.</p></li>
 <li><p>If you want to install using <code class="docutils literal notranslate"><span class="pre">pip</span></code>, activate your environment and the
 run <code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">-r</span> <span class="pre">requirements.txt</span></code>. Note that you should have <code class="docutils literal notranslate"><span class="pre">ffmpeg</span></code> installed
 prior to installing the requirements (<a class="reference external" href="https://ffmpeg.org/download.html">instructions here</a>).</p></li>

diff --git a/book/_build/html/ch2_basics/evaluate.html b/book/_build/html/ch2_basics/evaluate.html
@@ -379,7 +379,7 @@ <h1>How do we evaluate?<a class="headerlink" href="#how-do-we-evaluate" title="P
 is time-consuming and expensive (it requires real-time listening possibly multiple times).
 It is also difficult to repeat in an exact way and to determine
 a set of unambiguous judging criteria. Note, since most people
-only have “reletaive” rather than “perfect tempo” it’s rather hard to
+only have “relative” rather than “perfect tempo” it’s rather hard to
 design an subjective experiment for absolute tempo perception
 without the instantion of the tempo in terms of beats.</p>
 <p>Within the beat tracking literature, more effort has been devoted to the use

diff --git a/book/_build/html/ch4_going_deeper/building_tcn_models.html b/book/_build/html/ch4_going_deeper/building_tcn_models.html
@@ -306,7 +306,7 @@ <h1 class="site-logo" id="site-title">Tempo, Beat and Downbeat Estimation</h1>
 
   <div class="section" id="hands-on">
 <h1>Hands on!<a class="headerlink" href="#hands-on" title="Permalink to this headline">¶</a></h1>
-<p>Let’s get hands on in some data and models! Please click in the <a href="https://colab.research.google.com/drive/1tuOqNyO9gdMmYJsj33fP_QOfpRsm2tmt?usp=sharing" target="_blank">Colab link</a>!</p>
+<p>Let’s get hands on in some data and models! <a class="reference external" href="https://colab.research.google.com/drive/1tuOqNyO9gdMmYJsj33fP_QOfpRsm2tmt?usp=sharing"><img alt="Open In Collab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></p>
 </div>
 
     <script type="text/x-thebe-config">

diff --git a/book/_build/html/intro.html b/book/_build/html/intro.html
@@ -360,7 +360,7 @@ <h2>Welcome message<a class="headerlink" href="#welcome-message" title="Permalin
 <p><strong>For those who want to get straight to it…
 all of the main practical code examples can be found
 in the following Google Colab notebook:</strong></p>
-<p><a href="https://colab.research.google.com/drive/1tuOqNyO9gdMmYJsj33fP_QOfpRsm2tmt?usp=sharing" target="_blank">Colab link</a></p>
+<p><a class="reference external" href="https://colab.research.google.com/drive/1tuOqNyO9gdMmYJsj33fP_QOfpRsm2tmt?usp=sharing"><img alt="Open In Collab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></p>
 </div>
 <div class="section" id="desired-outcomes">
 <h2>Desired outcomes<a class="headerlink" href="#desired-outcomes" title="Permalink to this headline">¶</a></h2>

diff --git a/book/_build/html/searchindex.js b/book/_build/html/searchindex.js
diff --git a/book/_build/jupyter_execute/ch2_basics/evaluate.ipynb b/book/_build/jupyter_execute/ch2_basics/evaluate.ipynb
@@ -40,7 +40,7 @@
     "is time-consuming and expensive (it requires real-time listening possibly multiple times).\n",
     "It is also difficult to repeat in an exact way and to determine \n",
     "a set of unambiguous judging criteria. Note, since most people\n",
-    "only have \"reletaive\" rather than \"perfect tempo\" it's rather hard to \n",
+    "only have \"relative\" rather than \"perfect tempo\" it's rather hard to \n",
     "design an subjective experiment for absolute tempo perception\n",
     "without the instantion of the tempo in terms of beats. \n",
     "\n",

diff --git a/book/_build/jupyter_execute/ch2_basics/evaluate.py b/book/_build/jupyter_execute/ch2_basics/evaluate.py
@@ -30,7 +30,7 @@
 # is time-consuming and expensive (it requires real-time listening possibly multiple times).
 # It is also difficult to repeat in an exact way and to determine 
 # a set of unambiguous judging criteria. Note, since most people
-# only have "reletaive" rather than "perfect tempo" it's rather hard to 
+# only have "relative" rather than "perfect tempo" it's rather hard to 
 # design an subjective experiment for absolute tempo perception
 # without the instantion of the tempo in terms of beats. 
 # 

diff --git a/book/ch1_intro/tutorial_structure.md b/book/ch1_intro/tutorial_structure.md
@@ -43,9 +43,6 @@ If you choose to run locally, here are the recommended steps:
 1) Clone the [github repo](https://github.com/TempoBeatDownbeat/tutorial) into a 
    new directory.
 2) Make a new conda environment.
-    - If you want to install using the included `environment.yml` file see the
-  ([instructions here](https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#creating-an-environment-from-an-environment-yml-file)).
-  Then activate your environment.
     - If you want to install using `pip`, activate your environment and the
   run `pip install -r requirements.txt`. Note that you should have `ffmpeg` installed
   prior to installing the requirements ([instructions here](https://ffmpeg.org/download.html)).

diff --git a/book/ch2_basics/evaluate.ipynb b/book/ch2_basics/evaluate.ipynb
@@ -40,7 +40,7 @@
     "is time-consuming and expensive (it requires real-time listening possibly multiple times).\n",
     "It is also difficult to repeat in an exact way and to determine \n",
     "a set of unambiguous judging criteria. Note, since most people\n",
-    "only have \"reletaive\" rather than \"perfect tempo\" it's rather hard to \n",
+    "only have \"relative\" rather than \"perfect tempo\" it's rather hard to \n",
     "design an subjective experiment for absolute tempo perception\n",
     "without the instantion of the tempo in terms of beats. \n",
     "\n",

diff --git a/book/ch4_going_deeper/building_tcn_models.md b/book/ch4_going_deeper/building_tcn_models.md
@@ -1,5 +1,5 @@
 Hands on!
 =========
 
-Let's get hands on in some data and models! Please click in the <a href="https://colab.research.google.com/drive/1tuOqNyO9gdMmYJsj33fP_QOfpRsm2tmt?usp=sharing" target="_blank">Colab link</a>!
+Let's get hands on in some data and models! [![Open In Collab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1tuOqNyO9gdMmYJsj33fP_QOfpRsm2tmt?usp=sharing)
 
diff --git a/book/intro.md b/book/intro.md
@@ -40,7 +40,10 @@ of python notebooks.
 all of the main practical code examples can be found 
 in the following Google Colab notebook:** 
 
-<a href="https://colab.research.google.com/drive/1tuOqNyO9gdMmYJsj33fP_QOfpRsm2tmt?usp=sharing" target="_blank">Colab link</a>
+
+[![Open In Collab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1tuOqNyO9gdMmYJsj33fP_QOfpRsm2tmt?usp=sharing)
+
+