Skip to content

Commit

Permalink
deploy: f3d52b7
Browse files Browse the repository at this point in the history
  • Loading branch information
genisplaja committed Nov 29, 2023
1 parent f3ade65 commit 81dfad2
Show file tree
Hide file tree
Showing 48 changed files with 500 additions and 336 deletions.
2 changes: 1 addition & 1 deletion .buildinfo
Original file line number Diff line number Diff line change
@@ -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: 615e839ebc6b85db9611de0f35940690
config: 4210c75d0b94a1f6c1bcdd8cda4bb739
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file removed _images/compiam_28_1.png
Binary file not shown.
Binary file added _images/compiam_29_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified _images/exploring-raga_102_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified _images/exploring-raga_104_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified _images/exploring-raga_106_0.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified _images/exploring-raga_110_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified _images/exploring-raga_115_0.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified _images/exploring-raga_120_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified _images/exploring-raga_178_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified _images/exploring-raga_88_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified _images/exploring-raga_91_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified _images/exploring-raga_94_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed _images/meter_analysis_27_2.png
Binary file not shown.
Binary file removed _images/music-segmentation_29_0.png
Binary file not shown.
Binary file modified _images/pitch-extraction_22_0.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified _images/python_18_0.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified _images/python_25_0.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified _images/python_28_0.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified _images/python_30_0.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
17 changes: 12 additions & 5 deletions _sources/corpora_and_datasets/corpora.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,18 @@ Your Dunya access token is **unique** and **must be kept in secret**. For that r
### Browsing the corpora using the API
Our corpora class include methods to get an overview of the available data in the database. Let us get you some examples below:

* ``get_collection()``: prints you out all available recordings in the collection.
* ``get_recording(<recording-musicbrainz-id>)``: prints out the available data for the recording associated with the input mbid.
* ``get_artist(<artists-musicbrainz-id>)``: prints out the available information for the artist associated with the input mbid.
* ``list_concerts()``: list all available concerts in the selected database.
* ``list_available_types(<artists-musicbrainz-id>)``: prints you out the available types of file available for a particular recording.
* ``get_collection()``: returns a dictionary including `mbid` and title of all available recordings in the collection.
* ``get_recording(<recording-musicbrainz-id>)``: returns the available data for the recording associated with the input mbid.
* ``get_artist(<artists-musicbrainz-id>)``: returns the available information for the artist associated with the input mbid.
* ``list_concerts()``: lists all available concerts in the selected database.
* ``list_available_types(<artists-musicbrainz-id>)``: returns the available types of file available for a particular recording.

### Parsing all the metadata at once
The corpora class also includes a functionality to iterate over the initialized corpora. Run `get_metadata()` to get a dictionary containing all metadata available in the portion of the corpora in which you are interested on.

```{note}
Please note that there is no API call to get all metadata at once, so `get_metadata()` will run as many API calls as recordings are avialable in the corpora, so this operation might take a while...
```

### Getting the data
The Dunya Python API also provides methods to get the data. You may use these set of functionalities to parse and/or download into your machine a particular annotation, metadata file, or audio track.
Expand Down
8 changes: 6 additions & 2 deletions _sources/corpora_and_datasets/datasets.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,11 @@
},
"outputs": [],
"source": [
"# Import compiam\n",
"## Installing (if not) and importing compiam to the project\n",
"import importlib.util\n",
"if importlib.util.find_spec('compiam') is None:\n",
" ## Bear in mind this will only run in a jupyter notebook / Collab session\n",
" %pip install compiam\n",
"import compiam\n",
"\n",
"# Supress warnings to keep the tutorial clean\n",
Expand Down Expand Up @@ -219,7 +223,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.9.4"
"version": "3.11.6"
},
"orig_nbformat": 4,
"vscode": {
Expand Down
23 changes: 20 additions & 3 deletions _sources/introduction/compiam.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -68,13 +68,30 @@
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"metadata": {
"tags": [
"remove-output"
]
},
"outputs": [],
"source": [
"## Importing compiam to the project\n",
"## Installing (if not) and importing compiam to the project\n",
"import importlib.util\n",
"if importlib.util.find_spec('compiam') is None:\n",
" ## Bear in mind this will only run in a jupyter notebook / Collab session\n",
" %pip install compiam\n",
"import compiam"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"```{admonition} Reminder\n",
"Most likely, after importing a particular notebook of this tutorial to a Google Collab session, compiam will not be installed. On the cell above we first check if `compiam` is installed and if not, we run the installation command to get the latest version released.\n",
"```"
]
},
{
"cell_type": "markdown",
"metadata": {},
Expand Down Expand Up @@ -438,7 +455,7 @@
},
"language_info": {
"name": "python",
"version": "3.9.4 (default, Apr 5 2021, 01:49:30) \n[Clang 12.0.0 (clang-1200.0.32.29)]"
"version": "3.11.6"
},
"orig_nbformat": 4,
"vscode": {
Expand Down
2 changes: 1 addition & 1 deletion _sources/introduction/python.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -430,7 +430,7 @@
},
"language_info": {
"name": "python",
"version": "3.9.4"
"version": "3.11.6"
},
"orig_nbformat": 4,
"vscode": {
Expand Down
8 changes: 4 additions & 4 deletions _sources/introduction/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@ Google Collab hosts GPU/TPU access, which you can use to run the ML/DL based cod

Feel free to import our notebooks to a Google Collab session, where the code can be run, modified, and downloaded.

```{important}
<!--```{important} IMPORTANT NOTE PLEASE PAY ATTENTION HERE!
Most likely, after importing a particular notebook of this tutorial to a Google Collab session, the main tool for this tutorial, `compiam`, will not be installed. Make sure to install it by running ``!pip install compiam`` or ``%pip install compiam`` (`!` and `%` indicates, in a Jupyter notebook cell, that the command is run in the command line).
```
```-->


(building-locally)=
Expand All @@ -53,9 +53,9 @@ You may be interested in building this book in your own machine. This can be don
5) Your default browser should pop-up and the landing page of the book should appear. Now you can learn and run the snippets of code locally!

```{note}
You may download the source code of a particular page using the download button (<img src="https://raw.githubusercontent.com/FortAwesome/Font-Awesome/6.x/svgs/solid/download.svg" width="20" height="20">) also on the top right of the page. If the page includes runable code, you may get the ``.ipynb`` file to run it locally as well.
You may download the source code of a particular page using the download button (<svg xmlns="http://www.w3.org/2000/svg" height="20" width="19.5" viewBox="0 0 496 512"><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3 .3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5 .3-6.2 2.3zm44.2-1.7c-2.9 .7-4.9 2.6-4.6 4.9 .3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3 .7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3 .3 2.9 2.3 3.9 1.6 1 3.6 .7 4.3-.7 .7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3 .7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3 .7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z"/></svg>) also on the top right of the page. If the page includes runable code, you may get the ``.ipynb`` file to run it locally as well.
```

(getting-in-touch)=
## Getting in touch
Do not hesitate to [get in touch](mailto:[email protected]) for any enquiries, questions, and suggestions! If you encounter an error, problem, or even a typo, please [do open an issue](https://github.com/MTG/IAM-tutorial-ismir22/issues) in the tutorial repository, which may be rapidly done by clicking in the GitHub button on the top right (<img src="https://raw.githubusercontent.com/FortAwesome/Font-Awesome/6.x/svgs/brands/github.svg" width="20" height="20">).
Do not hesitate to [get in touch](mailto:[email protected]) for any enquiries, questions, and suggestions! If you encounter an error, problem, or even a typo, please [do open an issue](https://github.com/MTG/IAM-tutorial-ismir22/issues) in the tutorial repository, which may be rapidly done by clicking in the GitHub button on the top right (<svg xmlns="http://www.w3.org/2000/svg" height="20" width="19.5" viewBox="0 0 496 512"><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3 .3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5 .3-6.2 2.3zm44.2-1.7c-2.9 .7-4.9 2.6-4.6 4.9 .3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3 .7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3 .3 2.9 2.3 3.9 1.6 1 3.6 .7 4.3-.7 .7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3 .7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3 .7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z"/></svg>).
6 changes: 1 addition & 5 deletions _sources/landing.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,6 @@ This online book is the main resource for the **Tutorial on Computational Method

Presented at the 23rd edition of the International Society of Music Information Retrieval Conference (ISMIR) 2022, in Bengaluru, India.

```{admonition} Join us!!!
We have set up a [Slack channel](https://join.slack.com/t/compiam/shared_invite/zt-1kx4nx3nq-8xRltSxWhqD_QGaADUHFXw) to coordinate and enhance `compiam`, but also to have relevant dicussions about the entire topic of this tutorial. Let us know if the invite link does not work and we will invite you personally. Thanks!
```

## What is this tutorial about?
This tutorial is designed to serve as a starting point for researchers of all levels looking to get started with the computational analysis of Carnatic and Hindustani Music. While reading through this book you should expect to obtain:
* **Basic understanding of Carnatic and Hindustani Music**: important concepts and practices.
Expand All @@ -34,7 +30,7 @@ If you would like to reference this book please use:
Ajay Srinivasamurthy and
Xavier Serra},
Address = {Bengaluru, India},
Publisher = {https://mtg.github.io/IAM-tutorial-ismir22},
Publisher = {Music Technology Group},
Title = {Computational Methods for Supporting Corpus-Based Research on Indian Art Music},
Year = 2022,
Url = {https://mtg.github.io/IAM-tutorial-ismir22}
Expand Down
2 changes: 1 addition & 1 deletion _sources/melodic_analysis/exploring-raga.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -4499,7 +4499,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.9.1"
"version": "3.11.6"
}
},
"nbformat": 4,
Expand Down
8 changes: 6 additions & 2 deletions _sources/melodic_analysis/melodic-pattern-discovery.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,11 @@
"metadata": {},
"outputs": [],
"source": [
"## Importing compiam to the project\n",
"## Installing (if not) and importing compiam to the project\n",
"import importlib.util\n",
"if importlib.util.find_spec('compiam') is None:\n",
" ## Bear in mind this will only run in a jupyter notebook / Collab session\n",
" %pip install compiam\n",
"import compiam\n",
"\n",
"# Import extras and supress warnings to keep the tutorial clean\n",
Expand Down Expand Up @@ -68,7 +72,7 @@
},
"language_info": {
"name": "python",
"version": "3.9.4 (default, Apr 5 2021, 01:49:30) \n[Clang 12.0.0 (clang-1200.0.32.29)]"
"version": "3.11.6"
},
"orig_nbformat": 4,
"vscode": {
Expand Down
12 changes: 7 additions & 5 deletions _sources/melodic_analysis/pitch-extraction.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,11 @@
},
"outputs": [],
"source": [
"## Importing compiam to the project\n",
"## Installing (if not) and importing compiam to the project\n",
"import importlib.util\n",
"if importlib.util.find_spec('compiam') is None:\n",
" ## Bear in mind this will only run in a jupyter notebook / Collab session\n",
" %pip install compiam\n",
"import compiam\n",
"\n",
"# Import extras and supress warnings to keep the tutorial clean\n",
Expand Down Expand Up @@ -235,9 +239,7 @@
"cell_type": "code",
"execution_count": null,
"metadata": {
"tags": [
"remove-output"
]
"tags": []
},
"outputs": [],
"source": [
Expand Down Expand Up @@ -316,7 +318,7 @@
},
"language_info": {
"name": "python",
"version": "3.9.4"
"version": "3.11.6"
},
"orig_nbformat": 4,
"vscode": {
Expand Down
8 changes: 6 additions & 2 deletions _sources/melodic_analysis/raga-recognition.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,11 @@
},
"outputs": [],
"source": [
"## Importing compiam to the project\n",
"## Installing (if not) and importing compiam to the project\n",
"import importlib.util\n",
"if importlib.util.find_spec('compiam') is None:\n",
" ## Bear in mind this will only run in a jupyter notebook / Collab session\n",
" %pip install compiam\n",
"import compiam\n",
"\n",
"# Import extras and supress warnings to keep the tutorial clean\n",
Expand Down Expand Up @@ -203,7 +207,7 @@
},
"language_info": {
"name": "python",
"version": "3.9.4"
"version": "3.11.6"
},
"orig_nbformat": 4,
"vscode": {
Expand Down
8 changes: 6 additions & 2 deletions _sources/melodic_analysis/tonic-identification.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,11 @@
},
"outputs": [],
"source": [
"## Importing compiam to the project\n",
"## Installing (if not) and importing compiam to the project\n",
"import importlib.util\n",
"if importlib.util.find_spec('compiam') is None:\n",
" ## Bear in mind this will only run in a jupyter notebook / Collab session\n",
" %pip install compiam\n",
"import compiam\n",
"\n",
"# Import extras and supress warnings to keep the tutorial clean\n",
Expand Down Expand Up @@ -395,7 +399,7 @@
},
"language_info": {
"name": "python",
"version": "3.9.4"
"version": "3.11.6"
},
"orig_nbformat": 4,
"vscode": {
Expand Down
4 changes: 2 additions & 2 deletions _static/copybutton.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ const messages = {
},
'fr' : {
'copy': 'Copier',
'copy_to_clipboard': 'Copié dans le presse-papier',
'copy_to_clipboard': 'Copier dans le presse-papier',
'copy_success': 'Copié !',
'copy_failure': 'Échec de la copie',
},
Expand Down Expand Up @@ -224,7 +224,7 @@ var copyTargetText = (trigger) => {
var target = document.querySelector(trigger.attributes['data-clipboard-target'].value);

// get filtered text
let exclude = '.linenos, .gp';
let exclude = '.linenos';

let text = filterText(target, exclude);
return formatCopyText(text, '', false, true, true, true, '', '')
Expand Down
1 change: 1 addition & 0 deletions _static/pygments.css
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ span.linenos.special { color: #000000; background-color: #ffffc0; padding-left:
.highlight .cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */
.highlight .gd { color: #A00000 } /* Generic.Deleted */
.highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */
.highlight .gr { color: #FF0000 } /* Generic.Error */
.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
.highlight .gi { color: #00A000 } /* Generic.Inserted */
Expand Down
28 changes: 23 additions & 5 deletions corpora_and_datasets/corpora.html
Original file line number Diff line number Diff line change
Expand Up @@ -464,6 +464,11 @@
Browsing the corpora using the API
</a>
</li>
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link" href="#parsing-all-the-metadata-at-once">
Parsing all the metadata at once
</a>
</li>
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link" href="#getting-the-data">
Getting the data
Expand Down Expand Up @@ -510,6 +515,11 @@ <h2> Contents </h2>
Browsing the corpora using the API
</a>
</li>
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link" href="#parsing-all-the-metadata-at-once">
Parsing all the metadata at once
</a>
</li>
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link" href="#getting-the-data">
Getting the data
Expand Down Expand Up @@ -590,13 +600,21 @@ <h2>Dunya website<a class="headerlink" href="#dunya-website" title="Permalink to
<h3>Browsing the corpora using the API<a class="headerlink" href="#browsing-the-corpora-using-the-api" title="Permalink to this headline">#</a></h3>
<p>Our corpora class include methods to get an overview of the available data in the database. Let us get you some examples below:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">get_collection()</span></code>: prints you out all available recordings in the collection.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">get_recording(&lt;recording-musicbrainz-id&gt;)</span></code>: prints out the available data for the recording associated with the input mbid.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">get_artist(&lt;artists-musicbrainz-id&gt;)</span></code>: prints out the available information for the artist associated with the input mbid.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">list_concerts()</span></code>: list all available concerts in the selected database.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">list_available_types(&lt;artists-musicbrainz-id&gt;)</span></code>: prints you out the available types of file available for a particular recording.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">get_collection()</span></code>: returns a dictionary including <code class="docutils literal notranslate"><span class="pre">mbid</span></code> and title of all available recordings in the collection.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">get_recording(&lt;recording-musicbrainz-id&gt;)</span></code>: returns the available data for the recording associated with the input mbid.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">get_artist(&lt;artists-musicbrainz-id&gt;)</span></code>: returns the available information for the artist associated with the input mbid.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">list_concerts()</span></code>: lists all available concerts in the selected database.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">list_available_types(&lt;artists-musicbrainz-id&gt;)</span></code>: returns the available types of file available for a particular recording.</p></li>
</ul>
</section>
<section id="parsing-all-the-metadata-at-once">
<h3>Parsing all the metadata at once<a class="headerlink" href="#parsing-all-the-metadata-at-once" title="Permalink to this headline">#</a></h3>
<p>The corpora class also includes a functionality to iterate over the initialized corpora. Run <code class="docutils literal notranslate"><span class="pre">get_metadata()</span></code> to get a dictionary containing all metadata available in the portion of the corpora in which you are interested on.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Please note that there is no API call to get all metadata at once, so <code class="docutils literal notranslate"><span class="pre">get_metadata()</span></code> will run as many API calls as recordings are avialable in the corpora, so this operation might take a while…</p>
</div>
</section>
<section id="getting-the-data">
<h3>Getting the data<a class="headerlink" href="#getting-the-data" title="Permalink to this headline">#</a></h3>
<p>The Dunya Python API also provides methods to get the data. You may use these set of functionalities to parse and/or download into your machine a particular annotation, metadata file, or audio track.</p>
Expand Down
Loading

0 comments on commit 81dfad2

Please sign in to comment.