# Nendo Plugin Caption LP-MusicCaps
<br>
<p align="left">
<img src="https://okio.ai/docs/assets/nendo_core_logo.png" width="350" alt="nendo core">
</p>
<br>
<p align="left">
<a href="https://okio.ai" target="_blank">
<img src="https://img.shields.io/website/https/okio.ai" alt="Website">
</a>
<a href="https://twitter.com/okio_ai" target="_blank">
<img src="https://img.shields.io/twitter/url/https/twitter.com/okio_ai.svg?style=social&label=Follow%20%40okio_ai" alt="Twitter">
</a>
<a href="https://discord.gg/gaZMZKzScj" target="_blank">
<img src="https://dcbadge.vercel.app/api/server/XpkUsjwXTp?compact=true&style=flat" alt="Discord">
</a>
</p>
---
An audio captioning plugin based on LP-MusicCaps.
## Features
- Generate captions for all types of audio
- Caption your audio library and make it searchable by using the other nendo search plugins
## Requirements
This plugin requires the manual installation of the `LP-MusicCaps` repository from git, run:
```bash
git clone https://github.com/seungheondoh/lp-music-caps.git
cd lp-music-caps
pip install -e .
```
For more information, please refer to the [LP-MusicCaps repository](https://github.com/seungheondoh/lp-music-caps.git).
## Installation
1. [Install Nendo](https://github.com/okio-ai/nendo#installation)
2. `pip install nendo-plugin-caption-lpmusiccaps`
## Usage
Take a look at a basic usage example below.
For more detailed information, please refer to the [documentation](https://okio.ai/docs/plugins).
```pycon
>>> from nendo import Nendo
>>> nd = Nendo(plugins=["nendo_plugin_caption_lpmusiccaps"])
>>> track = nd.library.add_track(file_path="path/to/file.mp3")
>>> nd.plugins.caption_lpmusiccaps(track=track)
>>> track.get_plugin_value("caption")
```
## Contributing
Visit our docs to learn all about how to contribute to Nendo: [Contributing](https://okio.ai/docs/contributing/)
## License
Nendo: MIT License
LP-MusicCaps: CC-BY-NC 4.0 license.
Pretrained models: The weights are released under the CC-BY-NC 4.0 license
Raw data
{
"_id": null,
"home_page": "https://okio.ai",
"name": "nendo-plugin-caption-lpmusiccaps",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<3.11",
"maintainer_email": "",
"keywords": "AI,generative,music,okio,nendo,music production,music generation,music information retrieval,audio captioning,MIR,music analysis,song analysis",
"author": "Aaron Abebe",
"author_email": "aaron@okio.ai",
"download_url": "https://files.pythonhosted.org/packages/40/2a/5d2d6d0a126946966eeb56ba42c699bf2df36181d21bb54e899a7a4881dc/nendo_plugin_caption_lpmusiccaps-0.1.2.tar.gz",
"platform": null,
"description": "# Nendo Plugin Caption LP-MusicCaps\n\n<br>\n<p align=\"left\">\n <img src=\"https://okio.ai/docs/assets/nendo_core_logo.png\" width=\"350\" alt=\"nendo core\">\n</p>\n<br>\n\n<p align=\"left\">\n<a href=\"https://okio.ai\" target=\"_blank\">\n <img src=\"https://img.shields.io/website/https/okio.ai\" alt=\"Website\">\n</a>\n<a href=\"https://twitter.com/okio_ai\" target=\"_blank\">\n <img src=\"https://img.shields.io/twitter/url/https/twitter.com/okio_ai.svg?style=social&label=Follow%20%40okio_ai\" alt=\"Twitter\">\n</a>\n<a href=\"https://discord.gg/gaZMZKzScj\" target=\"_blank\">\n <img src=\"https://dcbadge.vercel.app/api/server/XpkUsjwXTp?compact=true&style=flat\" alt=\"Discord\">\n</a>\n</p>\n\n---\n\nAn audio captioning plugin based on LP-MusicCaps.\n\n## Features \n\n- Generate captions for all types of audio\n- Caption your audio library and make it searchable by using the other nendo search plugins\n\n## Requirements\n\nThis plugin requires the manual installation of the `LP-MusicCaps` repository from git, run:\n\n```bash\ngit clone https://github.com/seungheondoh/lp-music-caps.git\ncd lp-music-caps\npip install -e .\n```\n\nFor more information, please refer to the [LP-MusicCaps repository](https://github.com/seungheondoh/lp-music-caps.git).\n\n## Installation\n\n1. [Install Nendo](https://github.com/okio-ai/nendo#installation)\n2. `pip install nendo-plugin-caption-lpmusiccaps`\n\n## Usage\n\nTake a look at a basic usage example below.\nFor more detailed information, please refer to the [documentation](https://okio.ai/docs/plugins).\n\n```pycon\n>>> from nendo import Nendo\n>>> nd = Nendo(plugins=[\"nendo_plugin_caption_lpmusiccaps\"])\n>>> track = nd.library.add_track(file_path=\"path/to/file.mp3\")\n\n>>> nd.plugins.caption_lpmusiccaps(track=track)\n>>> track.get_plugin_value(\"caption\")\n```\n\n\n## Contributing\nVisit our docs to learn all about how to contribute to Nendo: [Contributing](https://okio.ai/docs/contributing/)\n\n\n## License\nNendo: MIT License\n\nLP-MusicCaps: CC-BY-NC 4.0 license.\n\nPretrained models: The weights are released under the CC-BY-NC 4.0 license\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "An audio captioning plugin based on LP-MusicCaps.",
"version": "0.1.2",
"project_urls": {
"Homepage": "https://okio.ai",
"Repository": "https://github.com/okio-ai/nendo_plugin_caption_lpmusiccaps"
},
"split_keywords": [
"ai",
"generative",
"music",
"okio",
"nendo",
"music production",
"music generation",
"music information retrieval",
"audio captioning",
"mir",
"music analysis",
"song analysis"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f33ab6ca66fa35f430e1691b3b7f8ebc4ff32e5c4842f10ebc8786e84e6a5cf1",
"md5": "1b41c83e7960ee03d2110abefad0e195",
"sha256": "1bd85689f37624688032eb53fb03f272df87e5dd96164ce2d6bf521453ad6d3e"
},
"downloads": -1,
"filename": "nendo_plugin_caption_lpmusiccaps-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1b41c83e7960ee03d2110abefad0e195",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<3.11",
"size": 5361,
"upload_time": "2024-03-05T08:31:34",
"upload_time_iso_8601": "2024-03-05T08:31:34.426480Z",
"url": "https://files.pythonhosted.org/packages/f3/3a/b6ca66fa35f430e1691b3b7f8ebc4ff32e5c4842f10ebc8786e84e6a5cf1/nendo_plugin_caption_lpmusiccaps-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "402a5d2d6d0a126946966eeb56ba42c699bf2df36181d21bb54e899a7a4881dc",
"md5": "080683888e0d221ce92c378d1ea7fce6",
"sha256": "fc48e949d7f35732f88a9606b09fc50233c13dd437abe0cc1a692a9587ee111f"
},
"downloads": -1,
"filename": "nendo_plugin_caption_lpmusiccaps-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "080683888e0d221ce92c378d1ea7fce6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<3.11",
"size": 5246,
"upload_time": "2024-03-05T08:31:35",
"upload_time_iso_8601": "2024-03-05T08:31:35.585776Z",
"url": "https://files.pythonhosted.org/packages/40/2a/5d2d6d0a126946966eeb56ba42c699bf2df36181d21bb54e899a7a4881dc/nendo_plugin_caption_lpmusiccaps-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-05 08:31:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "okio-ai",
"github_project": "nendo_plugin_caption_lpmusiccaps",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "nendo-plugin-caption-lpmusiccaps"
}
JSON
