# soundata
<img src="docs/img/soundata.png" height="100px">
Python library for downloading, loading & working with sound datasets. Find the API documentation [here](https://soundata.readthedocs.io/). <br/>
For Music Information Retrieval (MIR) datasets please check [mirdata](https://github.com/mir-dataset-loaders/mirdata).
[](https://pepy.tech/project/soundata)
[](https://codecov.io/gh/soundata/soundata)
[](https://soundata.readthedocs.io/en/latest/?badge=latest)
[](https://badge.fury.io/py/soundata)
[](http://makeapullrequest.com)
This library provides tools for working with common sound datasets, including tools for:
* Downloading datasets to a common location and format
* Validating that the files for a dataset are all present
* Loading annotation files to a common format
* Parsing clip-level metadata for detailed evaluations
Here's soundata's [list of currently supported datasets](https://soundata.readthedocs.io/en/latest/source/quick_reference.html).
### Installation
To install, simply run:
```python
pip install soundata
```
### Quick example
```python
import soundata
dataset = soundata.initialize('urbansound8k')
dataset.download() # download the dataset
dataset.validate() # validate that all the expected files are there
example_clip = dataset.choice_clip() # choose a random example clip
print(example_clip) # see the available data
```
See the [documentation](https://soundata.readthedocs.io/) for more examples and the API reference.
### Citing
```
TBA
```
When working with datasets, please cite the version of `soundata` that you are using **AND** include the reference of the dataset, which can be found in the respective dataset loader using the `cite()` method.
### Contributing a new dataset loader
We welcome and encourage contributions to this library, especially new datasets. Please see [contributing](https://soundata.readthedocs.io/en/latest/source/contributing.html) for guidelines.
Raw data
{
"_id": null,
"home_page": "https://github.com/soundata/soundata",
"name": "soundata",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "sound dataset loader audio",
"author": "",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/a7/3b/26fd0f2fd66f0b11b6b924c12ec8cad5ff7b2e9e35c31806c1e6d601e400/soundata-0.1.3.tar.gz",
"platform": null,
"description": "# soundata\n\n<img src=\"docs/img/soundata.png\" height=\"100px\">\n\nPython library for downloading, loading & working with sound datasets. Find the API documentation [here](https://soundata.readthedocs.io/). <br/>\nFor Music Information Retrieval (MIR) datasets please check [mirdata](https://github.com/mir-dataset-loaders/mirdata). \n\n\n\n\n[](https://pepy.tech/project/soundata)\n\n\n[](https://codecov.io/gh/soundata/soundata)\n[](https://soundata.readthedocs.io/en/latest/?badge=latest)\n\n[](https://badge.fury.io/py/soundata)\n[](http://makeapullrequest.com)\n\n\nThis library provides tools for working with common sound datasets, including tools for:\n* Downloading datasets to a common location and format\n* Validating that the files for a dataset are all present \n* Loading annotation files to a common format\n* Parsing clip-level metadata for detailed evaluations\n\nHere's soundata's [list of currently supported datasets](https://soundata.readthedocs.io/en/latest/source/quick_reference.html).\n\n### Installation\n\nTo install, simply run:\n\n```python\npip install soundata\n```\n\n### Quick example\n```python\nimport soundata\n\ndataset = soundata.initialize('urbansound8k')\ndataset.download() # download the dataset\ndataset.validate() # validate that all the expected files are there\n\nexample_clip = dataset.choice_clip() # choose a random example clip\nprint(example_clip) # see the available data\n\n```\nSee the [documentation](https://soundata.readthedocs.io/) for more examples and the API reference.\n\n\n### Citing\n\n\n```\nTBA\n```\n\n\nWhen working with datasets, please cite the version of `soundata` that you are using **AND** include the reference of the dataset, which can be found in the respective dataset loader using the `cite()` method. \n\n### Contributing a new dataset loader\n\nWe welcome and encourage contributions to this library, especially new datasets. Please see [contributing](https://soundata.readthedocs.io/en/latest/source/contributing.html) for guidelines.\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "Python library for loading and working with sound datasets.",
"version": "0.1.3",
"project_urls": {
"Download": "http://github.com/soundata/soundata/releases",
"Homepage": "https://github.com/soundata/soundata"
},
"split_keywords": [
"sound",
"dataset",
"loader",
"audio"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "96a8f88ee934e6aee36bcd8c04ca8d3de869c1388e948319b30116e3ec5fdb28",
"md5": "4149863cd0f07d04b01cbed70694791a",
"sha256": "0d368022d6aa33bee4a135e05d94980a90ecbe22b886185c7ea3f2bc1af3340b"
},
"downloads": -1,
"filename": "soundata-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4149863cd0f07d04b01cbed70694791a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 20262658,
"upload_time": "2024-02-07T00:05:02",
"upload_time_iso_8601": "2024-02-07T00:05:02.318261Z",
"url": "https://files.pythonhosted.org/packages/96/a8/f88ee934e6aee36bcd8c04ca8d3de869c1388e948319b30116e3ec5fdb28/soundata-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a73b26fd0f2fd66f0b11b6b924c12ec8cad5ff7b2e9e35c31806c1e6d601e400",
"md5": "877a57c5f08ce3fba0f2710342771b35",
"sha256": "7f0dcdd03040fe305c056ed4498376402ba96c5332e9ea0eab2ad8f2cab87041"
},
"downloads": -1,
"filename": "soundata-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "877a57c5f08ce3fba0f2710342771b35",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 19834680,
"upload_time": "2024-02-07T00:05:08",
"upload_time_iso_8601": "2024-02-07T00:05:08.069497Z",
"url": "https://files.pythonhosted.org/packages/a7/3b/26fd0f2fd66f0b11b6b924c12ec8cad5ff7b2e9e35c31806c1e6d601e400/soundata-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-07 00:05:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "soundata",
"github_project": "soundata",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "soundata"
}
JSON
