Metadata-Version: 2.1
Name: nendo-plugin-vampnet
Version: 0.1.3
Summary: Nendo Plugin for VampNet: Music Generation via Masked Acoustic Token Modeling.
Home-page: https://okio.ai
License: MIT
Keywords: Nendo,AI,Machine Learning,Audio,Generative,Music,Audio Production,Audio Generation,Plugin
Author: Aaron Abebe
Author-email: aaron@okio.ai
Requires-Python: >=3.8,<3.11
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Multimedia :: Sound/Audio
Requires-Dist: nendo (>=0.2.0,<0.3.0)
Requires-Dist: pydantic (>=2.0.0,<2.5.0)
Requires-Dist: pydantic-settings (>=2.1.0,<3.0.0)
Project-URL: Repository, https://github.com/okio-ai/nendo_plugin_vampnet
Description-Content-Type: text/markdown

# Nendo Plugin Vampnet

<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>

---

Nendo Plugin for VampNet: Music Generation via Masked Acoustic Token Modeling 
(by [Hugo Flores Garcia](https://github.com/hugofloresgarcia/vampnet)).

## Features 

- Generate unconditional variations
- Use custom finetuned vampnet models
- Generate in- and outpaintings from a `NendoTrack`
 
## Requirements

Due to madmom versions < 0.17 errors with python 3.10, we require the latest version of the package from git, where this is fixed. See also this related issue.

Run:

`pip install git+https://github.com/CPJKU/madmom.git@0551aa8`

This plugin also requires the manual installation of `vampnet` via its git repository:

`pip install git+https://github.com/hugofloresgarcia/vampnet.git@0c0c6bc`

For further information, please refer to the original [vampnet repository](https://github.com/hugofloresgarcia/vampnet).

## Installation

1. [Install Nendo](https://github.com/okio-ai/nendo#installation)
2. `pip install nendo-plugin-vampnet`

## Usage

Take a look at a basic usage example below.
For more detailed information, please refer to the [documentation](https://okio.ai/docs/plugins).

For more advanced examples, check out the examples folder.
or try it in colab:

<a target="_blank" href="https://colab.research.google.com/drive/1IRH3gXLgqtMjfOknMkEmSqPmrEdiKAxM?usp=sharing">
    <img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/>
</a>

```python
from nendo import Nendo, NendoConfig

nd = Nendo(config=NendoConfig(plugins=["nendo_plugin_vampnet"]))
track = nd.library.add_track(file_path='/path/to/track.mp3')

vamp = nd.plugins.vampnet(track=track, prefix_secs=2, suffix_secs=0)
vamp.play()
```

## Contributing

Visit our docs to learn all about how to contribute to Nendo: [Contributing](https://okio.ai/docs/contributing/)

## License

Nendo: MIT License

Vampnet: MIT License

Pretrained Models: The weights for the models are licensed CC BY-NC-SA 4.0. Likewise, any VampNet models fine-tuned on the pretrained models are also licensed CC BY-NC-SA 4.0.
