{ "info": { "author": null, "author_email": "\"\u00c9tienne Labb\u00e9 (Labbeti)\" ", "bugtrack_url": null, "classifiers": [ "Intended Audience :: Science/Research", "License :: OSI Approved :: MIT License", "Operating System :: POSIX :: Linux", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.10", "Programming Language :: Python :: 3.11", "Programming Language :: Python :: 3.12", "Programming Language :: Python :: 3.7", "Programming Language :: Python :: 3.8", "Programming Language :: Python :: 3.9", "Topic :: Scientific/Engineering", "Topic :: Scientific/Engineering :: Artificial Intelligence" ], "description": "\n\n
\n\n# Audio Captioning datasets for PyTorch\n\n\"Python\"\n\"PyTorch\"\n\"Code\n\"Build\"\n\n Documentation Status\n\n\nAudio Captioning unofficial datasets source code for **AudioCaps** [[1]](#audiocaps), **Clotho** [[2]](#clotho), **MACS** [[3]](#macs), and **WavCaps** [[4]](#wavcaps), designed for PyTorch.\n\n
\n\n## Installation\n```bash\npip install aac-datasets\n```\n\nIf you want to check if the package has been installed and the version, you can use this command:\n```bash\naac-datasets-info\n```\n\n## Examples\n\n### Create Clotho dataset\n\n```python\nfrom aac_datasets import Clotho\n\ndataset = Clotho(root=\".\", download=True)\nitem = dataset[0]\naudio, captions = item[\"audio\"], item[\"captions\"]\n# audio: Tensor of shape (n_channels=1, audio_max_size)\n# captions: list of str\n```\n\n### Build PyTorch dataloader with Clotho\n\n```python\nfrom torch.utils.data.dataloader import DataLoader\nfrom aac_datasets import Clotho\nfrom aac_datasets.utils import BasicCollate\n\ndataset = Clotho(root=\".\", download=True)\ndataloader = DataLoader(dataset, batch_size=4, collate_fn=BasicCollate())\n\nfor batch in dataloader:\n # batch[\"audio\"]: list of 4 tensors of shape (n_channels, audio_size)\n # batch[\"captions\"]: list of 4 lists of str\n ...\n```\n\n## Download datasets\nTo download a dataset, you can use `download` argument in dataset construction :\n```python\ndataset = Clotho(root=\".\", subset=\"dev\", download=True)\n```\nHowever, if you want to download datasets from a script, you can also use the following command :\n```bash\naac-datasets-download --root \".\" clotho --subsets \"dev\"\n```\n\n## Datasets information\n`aac-datasets` package contains 4 different datasets :\n\n\n\n| Dataset | Sampling
rate (kHz) | Estimated
size (GB) | Source | Subsets |\n|:---:|:---:|:---:|:---:|:---:|\n| AudioCaps | 32 | 43 | AudioSet | `train`
`val`
`test`
`train_v2` |\n| Clotho | 44.1 | 53 | Freesound | `dev`
`val`
`eval`
`dcase_aac_test`
`dcase_aac_analysis`
`dcase_t2a_audio`
`dcase_t2a_captions` |\n| MACS | 48 | 13 | TAU Urban Acoustic Scenes 2019 | `full` |\n| WavCaps | 32 | 941 | AudioSet
BBC Sound Effects
Freesound
SoundBible | `audioset`
`audioset_no_audiocaps`
`bbc`
`freesound`
`freesound_no_clotho`
`freesound_no_clotho_v2`
`soundbible` |\n\nFor Clotho, the **dev** subset should be used for training, val for validation and eval for testing.\n\nHere is additional statistics on the train subset for AudioCaps, Clotho, MACS and WavCaps:\n\n| | AudioCaps/train | Clotho/dev | MACS/full | WavCaps/full |\n|:---:|:---:|:---:|:---:|:---:|\n| Nb audios | 49,838 | 3,840 | 3,930 | 403,050 |\n| Total audio duration (h) | 136.61 | 24.0 | 10.9 | 7563.3 |\n| Audio duration range (s) | 0.5-10 | 15-30 | 10 | 1-67,109 |\n| Nb captions per audio | 1 | 5 | 2-5 | 1 |\n| Nb captions | 49,838 | 19,195 | 17,275 | 403,050 |\n| Total nb words2 | 402,482 | 217,362 | 160,006 | 3,161,823 |\n| Sentence size2 | 2-52 | 8-20 | 5-40 | 2-38 |\n| Vocabulary2 | 4724 | 4369 | 2721 | 24,600 |\n| Annotated by | Human | Human | Human | Machine |\n| Corrected by | Human | Human | None | None |\n\n1 This duration is estimated on the total duration of 46230/49838 files of 126.7h.\n\n2 The sentences are cleaned (lowercase+remove punctuation) and tokenized using the spacy tokenizer to count the words.\n\n## Requirements\n\nThis package has been developped for Ubuntu 20.04, and it is expected to work on most Linux-based distributions.\n### Python packages\n\nPython requirements are automatically installed when using pip on this repository.\n```\ntorch >= 1.10.1\ntorchaudio >= 0.10.1\npy7zr >= 0.17.2\npyyaml >= 6.0\ntqdm >= 4.64.0\nhuggingface-hub >= 0.15.1\nnumpy >= 1.21.2\n```\n\n### External requirements (AudioCaps only)\n\nThe external requirements needed to download **AudioCaps** are **ffmpeg** and **yt-dlp**.\n**ffmpeg** can be install on Ubuntu using `sudo apt install ffmpeg` and **yt-dlp** from the [official repo](https://github.com/yt-dlp/yt-dlp).\n\n\nYou can also override their paths for AudioCaps:\n```python\nfrom aac_datasets import AudioCaps\ndataset = AudioCaps(\n download=True,\n ffmpeg_path=\"/my/path/to/ffmpeg\",\n ytdl_path=\"/my/path/to/ytdlp\",\n)\n```\n\n## Additional information\n### Compatibility with audiocaps-download\nIf you want to use [audiocaps-download 1.0](https://github.com/MorenoLaQuatra/audiocaps-download) package to download AudioCaps, you will have to respect the AudioCaps folder tree:\n```python\nfrom audiocaps_download import Downloader\nroot = \"your/path/to/root\"\ndownloader = Downloader(root_path=f\"{root}/AUDIOCAPS/audio_32000Hz/\", n_jobs=16)\ndownloader.download(format=\"wav\")\n```\n\nThen disable audio download and set the correct audio format before init AudioCaps :\n```python\nfrom aac_datasets import AudioCaps\ndataset = AudioCaps(\n root=root,\n subset=\"train\",\n download=True,\n audio_format=\"wav\",\n download_audio=False, # this will only download labels and metadata files\n)\n```\n\n## References\n#### AudioCaps\n[1] C. D. Kim, B. Kim, H. Lee, and G. Kim, \u201cAudiocaps: Generating captions for audios in the wild,\u201d in NAACL-HLT, 2019. Available: https://aclanthology.org/N19-1011/\n\n#### Clotho\n[2] K. Drossos, S. Lipping, and T. Virtanen, \u201cClotho: An Audio Captioning Dataset,\u201d arXiv:1910.09387 [cs, eess], Oct. 2019, Available: http://arxiv.org/abs/1910.09387\n\n#### MACS\n[3] F. Font, A. Mesaros, D. P. W. Ellis, E. Fonseca, M. Fuentes, and B. Elizalde, Proceedings of the 6th Workshop on Detection and Classication of Acoustic Scenes and Events (DCASE 2021). Barcelona, Spain: Music Technology Group - Universitat Pompeu Fabra, Nov. 2021. Available: https://doi.org/10.5281/zenodo.5770113\n\n#### WavCaps\n[4] X. Mei et al., \u201cWavCaps: A ChatGPT-Assisted Weakly-Labelled Audio Captioning Dataset for Audio-Language Multimodal Research,\u201d arXiv preprint arXiv:2303.17395, 2023, [Online]. Available: https://arxiv.org/pdf/2303.17395.pdf\n\n## Cite the aac-datasets package\nIf you use this software, please consider cite it as \"Labbe, E. (2013). aac-datasets: Audio Captioning datasets for PyTorch.\", or use the following BibTeX citation:\n\n```\n@software{\n Labbe_aac_datasets_2024,\n author = {Labb\u00e9, \u00c9tienne},\n license = {MIT},\n month = {03},\n title = {{aac-datasets}},\n url = {https://github.com/Labbeti/aac-datasets/},\n version = {0.5.2},\n year = {2024}\n}\n```\n\n## Contact\nMaintainer:\n- [\u00c9tienne Labb\u00e9](https://labbeti.github.io/) \"Labbeti\": labbeti.pub@gmail.com\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": null, "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "dynamic": null, "home_page": null, "keywords": "audio, deep-learning, pytorch, dataset, caption, datasets, captioning, audio-captioning", "license": "MIT License Copyright (c) 2022 \u00c9tienne Labb\u00e9 (Labbeti) Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ", "maintainer": null, "maintainer_email": "\"\u00c9tienne Labb\u00e9 (Labbeti)\" ", "name": "aac-datasets", "package_url": "https://pypi.org/project/aac-datasets/", "platform": null, "project_url": "https://pypi.org/project/aac-datasets/", "project_urls": { "Changelog": "https://github.com/Labbeti/aac-datasets/blob/main/CHANGELOG.md", "Documentation": "https://aac-datasets.readthedocs.io/", "Homepage": "https://pypi.org/project/aac-datasets/", "Repository": "https://github.com/Labbeti/aac-datasets.git", "Tracker": "https://github.com/Labbeti/aac-datasets/issues" }, "provides_extra": null, "release_url": "https://pypi.org/project/aac-datasets/0.5.2/", "requires_dist": null, "requires_python": ">=3.7", "summary": "Audio Captioning datasets for PyTorch.", "version": "0.5.2", "yanked": false, "yanked_reason": null }, "last_serial": 22454447, "releases": { "0.1.1": [ { "comment_text": "", "digests": { "blake2b_256": "ad129cadd4f23a0472dc2636a07b5390f2bdc1ddac7fa7dcc62e6c738ca6d7db", "md5": "7b3a8129f7059e29cd3bf392f9697942", "sha256": "caafd8b68a3701a5353530fc37aa3dfbd883234953f3d7d89a6038003707d79a" }, "downloads": -1, "filename": "aac_datasets-0.1.1.tar.gz", "has_sig": false, "md5_digest": "7b3a8129f7059e29cd3bf392f9697942", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.8", "size": 23875, "upload_time": "2022-06-10T16:50:04", "upload_time_iso_8601": "2022-06-10T16:50:04.287355Z", "url": "https://files.pythonhosted.org/packages/ad/12/9cadd4f23a0472dc2636a07b5390f2bdc1ddac7fa7dcc62e6c738ca6d7db/aac_datasets-0.1.1.tar.gz", "yanked": false, "yanked_reason": null } ], "0.2.0": [ { "comment_text": "", "digests": { "blake2b_256": "b96553d20dc668eaf1a55143836d236a4fce60eb18eb43029820d281e0e055b7", "md5": "e2005a9c4a3cc420a6b9fea315932a17", "sha256": "5c255825fce6b23c9dabab8d3fb50dab01cf7a081ef626847a5078022145176c" }, "downloads": -1, "filename": "aac_datasets-0.2.0.tar.gz", "has_sig": false, "md5_digest": "e2005a9c4a3cc420a6b9fea315932a17", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.8", "size": 25309, "upload_time": "2022-08-30T11:38:32", "upload_time_iso_8601": "2022-08-30T11:38:32.902297Z", "url": "https://files.pythonhosted.org/packages/b9/65/53d20dc668eaf1a55143836d236a4fce60eb18eb43029820d281e0e055b7/aac_datasets-0.2.0.tar.gz", "yanked": false, "yanked_reason": null } ], "0.3.0": [ { "comment_text": "", "digests": { "blake2b_256": "69024325652e5e0372d1f1c72859c02e58dfd16329432dc9ba023a043618e3e3", "md5": "253ea750a4eb48be39cfe1cef922af83", "sha256": "83271356cda3d913af15088b8b870fabfc80b32f4a7812c5968503441cfb3cb9" }, "downloads": -1, "filename": "aac_datasets-0.3.0.tar.gz", "has_sig": false, "md5_digest": "253ea750a4eb48be39cfe1cef922af83", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.8", "size": 28491, "upload_time": "2022-09-28T10:00:13", "upload_time_iso_8601": "2022-09-28T10:00:13.756156Z", "url": "https://files.pythonhosted.org/packages/69/02/4325652e5e0372d1f1c72859c02e58dfd16329432dc9ba023a043618e3e3/aac_datasets-0.3.0.tar.gz", "yanked": false, "yanked_reason": null } ], "0.3.1": [ { "comment_text": "", "digests": { "blake2b_256": "73c999d93880913e77721bf30e4c40f643f21871530841d12945910c281dbbfb", "md5": "ae0158b9458da46094a1593a2afa5034", "sha256": "bb998a470c367a2f825af5645faa1f4e55af63454534b8ccabdaaae4e51a422d" }, "downloads": -1, "filename": "aac_datasets-0.3.1.tar.gz", "has_sig": false, "md5_digest": "ae0158b9458da46094a1593a2afa5034", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.8", "size": 29448, "upload_time": "2022-10-31T09:59:18", "upload_time_iso_8601": "2022-10-31T09:59:18.644640Z", "url": "https://files.pythonhosted.org/packages/73/c9/99d93880913e77721bf30e4c40f643f21871530841d12945910c281dbbfb/aac_datasets-0.3.1.tar.gz", "yanked": false, "yanked_reason": null } ], "0.3.2": [ { "comment_text": "", "digests": { "blake2b_256": "87b978a3bb8c12c7d0cff7c5b906a3896da9064e87e8a011283110944d3c9f29", "md5": "e0087920b25ff6e50d6bd655ddb12ecc", "sha256": "233c676d8d18f82fba5c532f22ec4ba6c84474babdf1f929df7164804d41e50a" }, "downloads": -1, "filename": "aac_datasets-0.3.2.tar.gz", "has_sig": false, "md5_digest": "e0087920b25ff6e50d6bd655ddb12ecc", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.7", "size": 29921, "upload_time": "2023-01-30T13:50:53", "upload_time_iso_8601": "2023-01-30T13:50:53.252523Z", "url": "https://files.pythonhosted.org/packages/87/b9/78a3bb8c12c7d0cff7c5b906a3896da9064e87e8a011283110944d3c9f29/aac_datasets-0.3.2.tar.gz", "yanked": false, "yanked_reason": null } ], "0.3.3": [ { "comment_text": "", "digests": { "blake2b_256": "86482f45589e41a38376e79069fe659367dd8504c2cda50b3e1873b272691291", "md5": "b71735276b43b6a354bc3f4260dad9a6", "sha256": "26d6e28cd17b9e54200187880573fb83fc1972c3a11653d08f6c005b77ada829" }, "downloads": -1, "filename": "aac-datasets-0.3.3.tar.gz", "has_sig": false, "md5_digest": "b71735276b43b6a354bc3f4260dad9a6", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.7", "size": 44238, "upload_time": "2023-05-11T08:59:27", "upload_time_iso_8601": "2023-05-11T08:59:27.692426Z", "url": "https://files.pythonhosted.org/packages/86/48/2f45589e41a38376e79069fe659367dd8504c2cda50b3e1873b272691291/aac-datasets-0.3.3.tar.gz", "yanked": false, "yanked_reason": null } ], "0.4.0": [ { "comment_text": "", "digests": { "blake2b_256": "05356622f6f286555270b357e0f5e00481931f64574b8adb948a408d4782c0cd", "md5": "3474878f935225a68e3ef353f33b4f2a", "sha256": "9e568e039534359503711ee818e5a18a499db386c3112d024a4773ec066d8acc" }, "downloads": -1, "filename": "aac-datasets-0.4.0.tar.gz", "has_sig": false, "md5_digest": "3474878f935225a68e3ef353f33b4f2a", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.7", "size": 2145757, "upload_time": "2023-09-25T17:20:43", "upload_time_iso_8601": "2023-09-25T17:20:43.557785Z", "url": "https://files.pythonhosted.org/packages/05/35/6622f6f286555270b357e0f5e00481931f64574b8adb948a408d4782c0cd/aac-datasets-0.4.0.tar.gz", "yanked": false, "yanked_reason": null } ], "0.4.1": [ { "comment_text": "", "digests": { "blake2b_256": "d1988b90808b9510a54a52901d2451b11afea1df9382792c8ea1859539614085", "md5": "e0aec2dae956f03d9b402ee2dca30052", "sha256": "7059c6232718fcc243f0a639c56351796a6c99e1224b8f68b21f04a39f95a4f2" }, "downloads": -1, "filename": "aac-datasets-0.4.1.tar.gz", "has_sig": false, "md5_digest": "e0aec2dae956f03d9b402ee2dca30052", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.7", "size": 2135844, "upload_time": "2023-10-25T17:03:12", "upload_time_iso_8601": "2023-10-25T17:03:12.565546Z", "url": "https://files.pythonhosted.org/packages/d1/98/8b90808b9510a54a52901d2451b11afea1df9382792c8ea1859539614085/aac-datasets-0.4.1.tar.gz", "yanked": false, "yanked_reason": null } ], "0.5.0": [ { "comment_text": "", "digests": { "blake2b_256": "62e954ecd5d20f2cb09541a5bb2cc8f4910a25892a41cfabadd05287d54329c8", "md5": "036a690c06a8a222eb60cbab48fbe1b8", "sha256": "3d04fe1eb6e5ea7b4c9c27b0c88e2b844ffb76a812bd79e30968fc5921f8a1ac" }, "downloads": -1, "filename": "aac-datasets-0.5.0.tar.gz", "has_sig": false, "md5_digest": "036a690c06a8a222eb60cbab48fbe1b8", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.7", "size": 2132154, "upload_time": "2024-01-05T15:21:23", "upload_time_iso_8601": "2024-01-05T15:21:23.665121Z", "url": "https://files.pythonhosted.org/packages/62/e9/54ecd5d20f2cb09541a5bb2cc8f4910a25892a41cfabadd05287d54329c8/aac-datasets-0.5.0.tar.gz", "yanked": false, "yanked_reason": null } ], "0.5.1": [ { "comment_text": "", "digests": { "blake2b_256": "6fa132999a02a82e8ed744b0d6d54066b6fa93d0fa81fe7a3d65d66e5c94b52e", "md5": "afb77932980c19765e2409e78ecaacf4", "sha256": "d3beba967e73f727061ef6d9ecf7bdc34680f5d685268b9e7f8ef16f839f4d45" }, "downloads": -1, "filename": "aac-datasets-0.5.1.tar.gz", "has_sig": false, "md5_digest": "afb77932980c19765e2409e78ecaacf4", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.7", "size": 2123850, "upload_time": "2024-03-05T09:30:31", "upload_time_iso_8601": "2024-03-05T09:30:31.450597Z", "url": "https://files.pythonhosted.org/packages/6f/a1/32999a02a82e8ed744b0d6d54066b6fa93d0fa81fe7a3d65d66e5c94b52e/aac-datasets-0.5.1.tar.gz", "yanked": false, "yanked_reason": null } ], "0.5.2": [ { "comment_text": "", "digests": { "blake2b_256": "588eb2c20cbf297b58240aa7d21ef1101697f4910daa75d3844a6ddb95205ce4", "md5": "5ca9892909fe2bc71a3405eee6f15b54", "sha256": "5df291ca4f8930d07a46428f1f3187957107a2a715194c091e1691e6b870c0ce" }, "downloads": -1, "filename": "aac-datasets-0.5.2.tar.gz", "has_sig": false, "md5_digest": "5ca9892909fe2bc71a3405eee6f15b54", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.7", "size": 2167819, "upload_time": "2024-03-23T14:13:47", "upload_time_iso_8601": "2024-03-23T14:13:47.879990Z", "url": "https://files.pythonhosted.org/packages/58/8e/b2c20cbf297b58240aa7d21ef1101697f4910daa75d3844a6ddb95205ce4/aac-datasets-0.5.2.tar.gz", "yanked": false, "yanked_reason": null } ] }, "urls": [ { "comment_text": "", "digests": { "blake2b_256": "588eb2c20cbf297b58240aa7d21ef1101697f4910daa75d3844a6ddb95205ce4", "md5": "5ca9892909fe2bc71a3405eee6f15b54", "sha256": "5df291ca4f8930d07a46428f1f3187957107a2a715194c091e1691e6b870c0ce" }, "downloads": -1, "filename": "aac-datasets-0.5.2.tar.gz", "has_sig": false, "md5_digest": "5ca9892909fe2bc71a3405eee6f15b54", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.7", "size": 2167819, "upload_time": "2024-03-23T14:13:47", "upload_time_iso_8601": "2024-03-23T14:13:47.879990Z", "url": "https://files.pythonhosted.org/packages/58/8e/b2c20cbf297b58240aa7d21ef1101697f4910daa75d3844a6ddb95205ce4/aac-datasets-0.5.2.tar.gz", "yanked": false, "yanked_reason": null } ], "vulnerabilities": [] }