Refresh mirror README + LICENSE
Browse files
LICENSE
ADDED
|
@@ -0,0 +1,18 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
Apache License
|
| 2 |
+
Version 2.0, January 2004
|
| 3 |
+
http://www.apache.org/licenses/
|
| 4 |
+
|
| 5 |
+
Copyright 2026 HeartMuLa Team (upstream weights, github.com/HeartMuLa/heartlib).
|
| 6 |
+
Mirror prepared by Æmotion Studio (https://huggingface.co/AEmotionStudio).
|
| 7 |
+
|
| 8 |
+
Licensed under the Apache License, Version 2.0 (the "License");
|
| 9 |
+
you may not use this file except in compliance with the License.
|
| 10 |
+
You may obtain a copy of the License at
|
| 11 |
+
|
| 12 |
+
http://www.apache.org/licenses/LICENSE-2.0
|
| 13 |
+
|
| 14 |
+
Unless required by applicable law or agreed to in writing, software
|
| 15 |
+
distributed under the License is distributed on an "AS IS" BASIS,
|
| 16 |
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
| 17 |
+
See the License for the specific language governing permissions and
|
| 18 |
+
limitations under the License.
|
README.md
ADDED
|
@@ -0,0 +1,142 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
license: apache-2.0
|
| 3 |
+
language:
|
| 4 |
+
- en
|
| 5 |
+
- zh
|
| 6 |
+
- ja
|
| 7 |
+
- ko
|
| 8 |
+
- es
|
| 9 |
+
pipeline_tag: text-to-audio
|
| 10 |
+
library_name: heartlib
|
| 11 |
+
tags:
|
| 12 |
+
- music
|
| 13 |
+
- lyrics-to-music
|
| 14 |
+
- heartmula
|
| 15 |
+
- heartcodec
|
| 16 |
+
- mirror
|
| 17 |
+
base_model:
|
| 18 |
+
- HeartMuLa/HeartMuLa-oss-3B-happy-new-year
|
| 19 |
+
- HeartMuLa/HeartMuLa-RL-oss-3B-20260123
|
| 20 |
+
- HeartMuLa/HeartMuLa-oss-3B
|
| 21 |
+
- HeartMuLa/HeartCodec-oss-20260123
|
| 22 |
+
- HeartMuLa/HeartCodec-oss
|
| 23 |
+
- HeartMuLa/HeartMuLaGen
|
| 24 |
+
---
|
| 25 |
+
|
| 26 |
+
# HeartMuLa · Æmotion Studio Mirror
|
| 27 |
+
|
| 28 |
+
Consolidated mirror of the **HeartMuLa** lyrics-to-music model family
|
| 29 |
+
([upstream GitHub](https://github.com/HeartMuLa/heartlib),
|
| 30 |
+
[paper](https://arxiv.org/abs/2601.10547),
|
| 31 |
+
[demo](https://heartmula.github.io/)). Used by
|
| 32 |
+
[MAESTRO](https://github.com/AEmotionStudio) (Æmotion Studio's open-source DAW)
|
| 33 |
+
for one-click downloads of any (mula, codec) pair from a single repo.
|
| 34 |
+
|
| 35 |
+
Last refresh: **2026-05-10**.
|
| 36 |
+
|
| 37 |
+
## Why a mirror?
|
| 38 |
+
|
| 39 |
+
Upstream distributes the model in three separate repos (a tokenizer/config
|
| 40 |
+
repo plus per-variant weight repos). MAESTRO's runner expects all of them
|
| 41 |
+
assembled on disk in heartlib's canonical `pretrained_path` layout, and
|
| 42 |
+
each user otherwise has to clone three repos and stitch them together by
|
| 43 |
+
hand. This mirror does the stitching once: each `checkpoints/<variant>/`
|
| 44 |
+
subfolder is **self-contained** — drop it in as `pretrained_path` and
|
| 45 |
+
`HeartMuLaGenPipeline.from_pretrained(...)` Just Works.
|
| 46 |
+
|
| 47 |
+
## Layout
|
| 48 |
+
|
| 49 |
+
```
|
| 50 |
+
AEmotionStudio/heartmula-models/
|
| 51 |
+
├── README.md ← this file
|
| 52 |
+
├── LICENSE ← Apache-2.0
|
| 53 |
+
└── checkpoints/
|
| 54 |
+
├── heartmula-3b-happy-new-year/ ← recommended mula
|
| 55 |
+
│ ├── HeartMuLa-oss-3B/
|
| 56 |
+
│ │ ├── config.json
|
| 57 |
+
│ │ ├── model-00001-of-00004.safetensors
|
| 58 |
+
│ │ ├── ...
|
| 59 |
+
│ │ └── model.safetensors.index.json
|
| 60 |
+
│ ├── tokenizer.json
|
| 61 |
+
│ ├── gen_config.json
|
| 62 |
+
│ ├── README.md ← upstream mula card
|
| 63 |
+
│ └── LICENSE
|
| 64 |
+
├── heartmula-3b-rl/ ← RL-refined mula
|
| 65 |
+
├── heartmula-3b-base/ ← original mula
|
| 66 |
+
├── heartcodec-20260123/ ← recommended codec
|
| 67 |
+
│ ├── HeartCodec-oss/
|
| 68 |
+
│ │ ├── config.json
|
| 69 |
+
│ │ ├── model-00001-of-00002.safetensors
|
| 70 |
+
│ │ ├── model-00002-of-00002.safetensors
|
| 71 |
+
│ │ └── model.safetensors.index.json
|
| 72 |
+
│ ├── README.md
|
| 73 |
+
│ └── LICENSE
|
| 74 |
+
└── heartcodec-base/ ← original codec
|
| 75 |
+
```
|
| 76 |
+
|
| 77 |
+
## Variants
|
| 78 |
+
|
| 79 |
+
| Subfolder | Source | Size | Description |
|
| 80 |
+
|---|---|---|---|
|
| 81 |
+
| `heartmula-3b-happy-new-year/` | [HeartMuLa/HeartMuLa-oss-3B-happy-new-year](https://huggingface.co/HeartMuLa/HeartMuLa-oss-3B-happy-new-year) | ~15.8 GB | Recommended mula. Best lyrics controllability + overall quality. |
|
| 82 |
+
| `heartmula-3b-rl/` | [HeartMuLa/HeartMuLa-RL-oss-3B-20260123](https://huggingface.co/HeartMuLa/HeartMuLa-RL-oss-3B-20260123) | ~15.8 GB | RL-refined mula. Stronger style/tag adherence. |
|
| 83 |
+
| `heartmula-3b-base/` | [HeartMuLa/HeartMuLa-oss-3B](https://huggingface.co/HeartMuLa/HeartMuLa-oss-3B) | ~15.8 GB | Original mula release. Kept for reproducibility against the paper. |
|
| 84 |
+
| `heartcodec-20260123/` | [HeartMuLa/HeartCodec-oss-20260123](https://huggingface.co/HeartMuLa/HeartCodec-oss-20260123) | ~6.7 GB | Recommended codec. Pair with any mula variant. |
|
| 85 |
+
| `heartcodec-base/` | [HeartMuLa/HeartCodec-oss](https://huggingface.co/HeartMuLa/HeartCodec-oss) | ~6.7 GB | Original codec. Use only when reproducing older results. |
|
| 86 |
+
|
| 87 |
+
Shared `tokenizer.json` (9 MB) + `gen_config.json` (~100 B) come from
|
| 88 |
+
[HeartMuLa/HeartMuLaGen](https://huggingface.co/HeartMuLa/HeartMuLaGen)
|
| 89 |
+
and are duplicated into every mula variant subfolder so each is
|
| 90 |
+
self-contained — codec subfolders don't need them.
|
| 91 |
+
|
| 92 |
+
## Usage
|
| 93 |
+
|
| 94 |
+
**Direct (heartlib)** — clone any one mula + one codec into a single
|
| 95 |
+
directory and pass that as `pretrained_path`:
|
| 96 |
+
|
| 97 |
+
```bash
|
| 98 |
+
hf download \
|
| 99 |
+
--repo-id AEmotionStudio/heartmula-models \
|
| 100 |
+
--include "checkpoints/heartmula-3b-happy-new-year/**" \
|
| 101 |
+
--local-dir ./ckpt-mula
|
| 102 |
+
|
| 103 |
+
hf download \
|
| 104 |
+
--repo-id AEmotionStudio/heartmula-models \
|
| 105 |
+
--include "checkpoints/heartcodec-20260123/**" \
|
| 106 |
+
--local-dir ./ckpt-codec
|
| 107 |
+
|
| 108 |
+
# Then merge the two into one pretrained_path before calling
|
| 109 |
+
# HeartMuLaGenPipeline.from_pretrained — see heartlib README.
|
| 110 |
+
```
|
| 111 |
+
|
| 112 |
+
**MAESTRO** — open the AI Workstation, switch to **Create**, click the
|
| 113 |
+
HeartMuLa card, then download the (mula, codec) pair the panel
|
| 114 |
+
recommends. The runner synthesizes the merged `pretrained_path`
|
| 115 |
+
automatically and routes it to heartlib.
|
| 116 |
+
|
| 117 |
+
## License
|
| 118 |
+
|
| 119 |
+
- **Code (heartlib):** Apache-2.0 — [github.com/HeartMuLa/heartlib](https://github.com/HeartMuLa/heartlib).
|
| 120 |
+
- **Weights:** Apache-2.0 — verified against each upstream's model card metadata.
|
| 121 |
+
- **This mirror:** redistributed under Apache-2.0 with attribution.
|
| 122 |
+
|
| 123 |
+
See `LICENSE` at the repo root + each variant's `LICENSE` for the full text.
|
| 124 |
+
|
| 125 |
+
## Citation
|
| 126 |
+
|
| 127 |
+
```bibtex
|
| 128 |
+
@misc{yang2026heartmulafamilyopensourced,
|
| 129 |
+
title={HeartMuLa: A Family of Open Sourced Music Foundation Models},
|
| 130 |
+
author={Dongchao Yang and others},
|
| 131 |
+
year={2026},
|
| 132 |
+
eprint={2601.10547},
|
| 133 |
+
archivePrefix={arXiv},
|
| 134 |
+
primaryClass={cs.SD}
|
| 135 |
+
}
|
| 136 |
+
```
|
| 137 |
+
|
| 138 |
+
## Maintainer
|
| 139 |
+
|
| 140 |
+
Mirror prepared by [Æmotion Studio](https://huggingface.co/AEmotionStudio)
|
| 141 |
+
for the [MAESTRO](https://github.com/AEmotionStudio) DAW. Refresh the
|
| 142 |
+
mirror with `python backend/scripts/mirror_heartmula_to_aemotion.py`.
|