| Name | soundata JSON |
| Version |
1.0.1
JSON |
| download |
| home_page | None |
| Summary | Python library for loading and working with sound datasets. |
| upload_time | 2024-06-11 13:48:04 |
| maintainer | Genís Plaja-Roglans, Guillem Cortès-Sebastià, Tanmay Khandelwal |
| docs_url | None |
| author | Genís Plaja-Roglans, Guillem Cortès-Sebastià, Tanmay Khandelwal, Marius Miron, Xavier Serra, Juan Pablo Bello, Justin Salamon |
| requires_python | >=3.7 |
| license | Copyright (c) 2016 All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of soundata nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| keywords |
sound
dataset loader
audio
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# soundata
<img src="docs/img/soundata.png" height="100px">
Python library for downloading, loading & working with sound datasets. Check the [API documentation](https://soundata.readthedocs.io/) and the [contributing instructions](https://soundata.readthedocs.io/en/latest/source/contributing.html). <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.
### Contributing a new dataset loader
We welcome and encourage contributions to this library, especially new dataset loaders. Please see [contributing](https://soundata.readthedocs.io/en/latest/source/contributing.html) for guidelines. Feel free to [open an issue](https://github.com/soundata/soundata/issues) if you have any doubt or your run into problems when working on the library.
### 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.
Raw data
{
"_id": null,
"home_page": null,
"name": "soundata",
"maintainer": "Gen\u00eds Plaja-Roglans, Guillem Cort\u00e8s-Sebasti\u00e0, Tanmay Khandelwal",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "Magdalena Fuentes <mfuentes@nyu.edu>",
"keywords": "sound, dataset loader, audio",
"author": "Gen\u00eds Plaja-Roglans, Guillem Cort\u00e8s-Sebasti\u00e0, Tanmay Khandelwal, Marius Miron, Xavier Serra, Juan Pablo Bello, Justin Salamon",
"author_email": "Magdalena Fuentes <mfuentes@nyu.edu>",
"download_url": "https://files.pythonhosted.org/packages/23/64/2c6662d7f41c1aef966c7f67c92872876e302ac1b6d71869fa959193db04/soundata-1.0.1.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. Check the [API documentation](https://soundata.readthedocs.io/) and the [contributing instructions](https://soundata.readthedocs.io/en/latest/source/contributing.html). <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### Contributing a new dataset loader\n\nWe welcome and encourage contributions to this library, especially new dataset loaders. Please see [contributing](https://soundata.readthedocs.io/en/latest/source/contributing.html) for guidelines. Feel free to [open an issue](https://github.com/soundata/soundata/issues) if you have any doubt or your run into problems when working on the library.\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",
"bugtrack_url": null,
"license": "Copyright (c) 2016 All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of soundata nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ",
"summary": "Python library for loading and working with sound datasets.",
"version": "1.0.1",
"project_urls": {
"Documentation": "https://soundata.readthedocs.io/en/latest/",
"Homepage": "https://github.com/soundata/soundata",
"Issues": "https://github.com/soundata/soundata/issues",
"Releases": "http://github.com/soundata/soundata/releases"
},
"split_keywords": [
"sound",
" dataset loader",
" audio"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dab0d8823eed97b11b44a6031db3e53db55ccc734fb049e27b48ad88fa11d854",
"md5": "af6459c48e29ac9ae1295be701ba115e",
"sha256": "8756d614d0ec2b2be2bb5be290898ed8e856aac0bb271c5eaeed16792d78a8dd"
},
"downloads": -1,
"filename": "soundata-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "af6459c48e29ac9ae1295be701ba115e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 162033,
"upload_time": "2024-06-11T13:48:02",
"upload_time_iso_8601": "2024-06-11T13:48:02.417706Z",
"url": "https://files.pythonhosted.org/packages/da/b0/d8823eed97b11b44a6031db3e53db55ccc734fb049e27b48ad88fa11d854/soundata-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "23642c6662d7f41c1aef966c7f67c92872876e302ac1b6d71869fa959193db04",
"md5": "33580da53b2a62780464b0c1c782c93f",
"sha256": "8dbbf2367463b0fb7ff4fe8b512271ae73c5b4f5f96db57b9c1ac085c74a8d16"
},
"downloads": -1,
"filename": "soundata-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "33580da53b2a62780464b0c1c782c93f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 142049,
"upload_time": "2024-06-11T13:48:04",
"upload_time_iso_8601": "2024-06-11T13:48:04.052936Z",
"url": "https://files.pythonhosted.org/packages/23/64/2c6662d7f41c1aef966c7f67c92872876e302ac1b6d71869fa959193db04/soundata-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-11 13:48:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "soundata",
"github_project": "soundata",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "soundata"
}
