Notebooks out (#75)

* move notebooks out of installation * update readme
MTG · Dec 11, 2022 · 3c0c76a · 3c0c76a
1 parent 84e8abd
commit 3c0c76a
Show file tree

Hide file tree

Showing 11 changed files with 7 additions and 6 deletions.
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -7,5 +7,4 @@ recursive-include compiam/models *
 recursive-include compiam/conf *
 recursive-include compiam/visualisation/waveform_player/waveform-playlist *
 recursive-include compiam/utils/augment *
-recursive-include compiam/utils/NMFtoolbox *
-recursive-include compiam/notebooks *
+recursive-include compiam/utils/NMFtoolbox *
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# compIAM
+# compIAM v0.2.0
 compIAM (**comp**utational analysis of **I**ndian **A**rt **M**usic) is a collaborative initiative involving many researchers that aims at putting together a common repository of datasets, tools, and models for the computational analysis of Carnatic and Hindustani music. 
 
 You can get started on the Computational Analysis of Indian Art Music through our ISMIR 2022 Tutorial: [Computational Methods For Supporting Corpus-Based Research On Indian Art Music](https://mtg.github.io/IAM-tutorial-ismir22/landing.html).
@@ -71,7 +71,7 @@ Direct and MIR-standardized access to the datasets for the computational analysi
     - [Mridangam Stroke Dataset](https://compmusic.upf.edu/mridangam-stroke-dataset)*
     - [Four-Way Tabla Stroke (ISMIR 21)](https://zenodo.org/record/7110248)
 
-The datasets marked with * have been compiled within the framework of the [CompMusic project]().
+The datasets marked with * have been compiled within the framework of the [CompMusic project](https://compmusic.upf.edu/).
 
 
 ## Contributing
@@ -85,6 +85,9 @@ compIAM is very much open for contributions. You can contribute by:
 Please check the [contribution guidelines](https://mtg.github.io/compIAM/source/contributing.html) and get in touch in case you have questions or suggestions.
 
 
+## Example notebooks
+We include, in this repo, [example notebooks](https://github.com/MTG/compIAM/tree/master/notebooks) for users to better understand how to use `compiam` and also showcase 
+
 ## License
 compIAM is Copyright 2022 Music Technology Group - Universitat Pompeu Fabra
 

diff --git a/...iam/notebooks/melody/Exploring_raga.ipynb → notebooks/melody/Exploring_raga.ipynb b/...iam/notebooks/melody/Exploring_raga.ipynb → notebooks/melody/Exploring_raga.ipynb
diff --git a/compiam/notebooks/melody/KDE.png → notebooks/melody/KDE.png b/compiam/notebooks/melody/KDE.png → notebooks/melody/KDE.png
diff --git a/...otebooks/melody/emphasizing_diagonals.png → notebooks/melody/emphasizing_diagonals.png b/...otebooks/melody/emphasizing_diagonals.png → notebooks/melody/emphasizing_diagonals.png
diff --git a/.../notebooks/melody/extracting_segments.png → notebooks/melody/extracting_segments.png b/.../notebooks/melody/extracting_segments.png → notebooks/melody/extracting_segments.png
diff --git a/compiam/notebooks/melody/grouping1.png → notebooks/melody/grouping1.png b/compiam/notebooks/melody/grouping1.png → notebooks/melody/grouping1.png
diff --git a/compiam/notebooks/melody/test.png → notebooks/melody/test.png b/compiam/notebooks/melody/test.png → notebooks/melody/test.png
diff --git a/...hythm/0_Tabla_Stroke_Classification.ipynb → ...hythm/0_Tabla_Stroke_Classification.ipynb b/...hythm/0_Tabla_Stroke_Classification.ipynb → ...hythm/0_Tabla_Stroke_Classification.ipynb
diff --git a/compiam/notebooks/rhythm/Transcription.ipynb → notebooks/rhythm/Transcription.ipynb b/compiam/notebooks/rhythm/Transcription.ipynb → notebooks/rhythm/Transcription.ipynb
diff --git a/setup.py b/setup.py
@@ -16,8 +16,7 @@
             "conf/*",
             "visualisation/waveform_player/waveform-playlist/*",
             "utils/augment/*",
-            "utils/NMFtoolbox/*",
-            "notebooks/*"
+            "utils/NMFtoolbox/*"
         ]
     },
     long_description=open("./README.md").read(),