Improve model card: add arxiv metadata, description, and usage
#1
by nielsr HF Staff - opened
README.md
CHANGED
|
@@ -1,46 +1,70 @@
|
|
| 1 |
---
|
| 2 |
-
license: cc-by-nc-4.0
|
| 3 |
language:
|
| 4 |
- zh
|
| 5 |
- en
|
| 6 |
- ja
|
| 7 |
- ko
|
| 8 |
- es
|
|
|
|
| 9 |
pipeline_tag: text-to-audio
|
| 10 |
tags:
|
| 11 |
- music
|
| 12 |
- art
|
|
|
|
| 13 |
---
|
| 14 |
|
|
|
|
| 15 |
|
| 16 |
-
|
| 17 |
|
| 18 |
-
|
| 19 |
|
| 20 |
-
|
| 21 |
|
| 22 |
-
- **Developed by:**
|
| 23 |
-
- **License:**
|
|
|
|
|
|
|
| 24 |
|
| 25 |
### Model Sources
|
| 26 |
|
| 27 |
-
<!-- Provide the basic links for the model. -->
|
| 28 |
-
|
| 29 |
- **Github Repo:** https://github.com/HeartMuLa/heartlib
|
| 30 |
-
- **Paper:** https://arxiv.org/abs/2601.10547
|
| 31 |
- **Demo:** https://heartmula.github.io/
|
| 32 |
-
- **HeartMuLa-oss-3B:** https://huggingface.co/HeartMuLa/HeartMuLa-oss-3B
|
| 33 |
-
- **HeartCodec-oss:** https://huggingface.co/HeartMuLa/HeartCodec-oss
|
| 34 |
-
- **HeartTranscriptor-oss:** https://huggingface.co/HeartMuLa/HeartTranscriptor-oss
|
| 35 |
|
|
|
|
|
|
|
|
|
|
|
|
|
| 36 |
|
| 37 |
## Get Started
|
| 38 |
|
| 39 |
-
Check
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 40 |
|
| 41 |
## Citation
|
| 42 |
|
| 43 |
-
<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
|
| 44 |
If you find HeartMuLa useful, please cite:
|
| 45 |
|
| 46 |
```bibtex
|
|
@@ -55,6 +79,5 @@ If you find HeartMuLa useful, please cite:
|
|
| 55 |
}
|
| 56 |
```
|
| 57 |
|
| 58 |
-
|
| 59 |
## Contact
|
| 60 |
-
If you are interested in HeartMuLa, feel free to reach us at heartmula.ai@gmail.com
|
|
|
|
| 1 |
---
|
|
|
|
| 2 |
language:
|
| 3 |
- zh
|
| 4 |
- en
|
| 5 |
- ja
|
| 6 |
- ko
|
| 7 |
- es
|
| 8 |
+
license: cc-by-nc-4.0
|
| 9 |
pipeline_tag: text-to-audio
|
| 10 |
tags:
|
| 11 |
- music
|
| 12 |
- art
|
| 13 |
+
arxiv: 2601.10547
|
| 14 |
---
|
| 15 |
|
| 16 |
+
# HeartMuLa: A Family of Open Sourced Music Foundation Models
|
| 17 |
|
| 18 |
+
[HeartMuLa](https://heartmula.github.io/) is a family of open-source Music Foundation Models designed to advance large-scale music understanding and generation across diverse tasks and modalities.
|
| 19 |
|
| 20 |
+
This repository contains the weights for **HeartMuLa-oss-3B**, an LLM-based song generation model capable of synthesizing high-fidelity music under rich, user-controllable conditions (e.g., textual style descriptions, lyrics, and reference audio).
|
| 21 |
|
| 22 |
+
## Model Details
|
| 23 |
|
| 24 |
+
- **Developed by:** Ario Scale Global
|
| 25 |
+
- **License:** CC-BY-NC 4.0
|
| 26 |
+
- **Model Type:** LLM-based Music Generation
|
| 27 |
+
- **Supported Languages:** English, Chinese, Japanese, Korean, Spanish, and more.
|
| 28 |
|
| 29 |
### Model Sources
|
| 30 |
|
|
|
|
|
|
|
| 31 |
- **Github Repo:** https://github.com/HeartMuLa/heartlib
|
| 32 |
+
- **Paper:** [arXiv:2601.10547](https://arxiv.org/abs/2601.10547)
|
| 33 |
- **Demo:** https://heartmula.github.io/
|
|
|
|
|
|
|
|
|
|
| 34 |
|
| 35 |
+
### HeartMuLa Family Checkpoints
|
| 36 |
+
- **HeartMuLa-oss-3B:** [Base song generation model](https://huggingface.co/HeartMuLa/HeartMuLa-oss-3B)
|
| 37 |
+
- **HeartCodec-oss:** [High-fidelity music codec tokenizer](https://huggingface.co/HeartMuLa/HeartCodec-oss)
|
| 38 |
+
- **HeartTranscriptor-oss:** [Robust lyric recognition model](https://huggingface.co/HeartMuLa/HeartTranscriptor-oss)
|
| 39 |
|
| 40 |
## Get Started
|
| 41 |
|
| 42 |
+
Check the official GitHub repository [HeartMuLa/heartlib](https://github.com/HeartMuLa/heartlib) for detailed setup and local deployment.
|
| 43 |
+
|
| 44 |
+
### Installation
|
| 45 |
+
|
| 46 |
+
```bash
|
| 47 |
+
git clone https://github.com/HeartMuLa/heartlib.git
|
| 48 |
+
cd heartlib
|
| 49 |
+
pip install -e .
|
| 50 |
+
```
|
| 51 |
+
|
| 52 |
+
### Sample Usage
|
| 53 |
+
|
| 54 |
+
To generate music conditioned on lyrics and style tags, run the following command after downloading the checkpoints:
|
| 55 |
+
|
| 56 |
+
```bash
|
| 57 |
+
python ./examples/run_music_generation.py --model_path=./ckpt --version="3B"
|
| 58 |
+
```
|
| 59 |
+
|
| 60 |
+
Parameters:
|
| 61 |
+
- `--model_path`: Path to the pretrained model checkpoint.
|
| 62 |
+
- `--lyrics`: Path to a text file containing lyrics (supports structure tags like `[Intro]`, `[Verse]`, `[Chorus]`).
|
| 63 |
+
- `--tags`: Comma-separated style tags (e.g., `piano,happy,romantic`).
|
| 64 |
+
- `--version`: The version of HeartMuLa (choose `3B`).
|
| 65 |
|
| 66 |
## Citation
|
| 67 |
|
|
|
|
| 68 |
If you find HeartMuLa useful, please cite:
|
| 69 |
|
| 70 |
```bibtex
|
|
|
|
| 79 |
}
|
| 80 |
```
|
| 81 |
|
|
|
|
| 82 |
## Contact
|
| 83 |
+
If you are interested in HeartMuLa, feel free to reach us at heartmula.ai@gmail.com
|