Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help


title: “Heartmula — HeartMuLa: Suno-like song generation from lyrics + tags” sidebar_label: “Heartmula” description: “HeartMuLa: Suno-like song generation from lyrics + tags”

{/* 本页面由 website/scripts/generate-skill-docs.py 根据技能对应的 SKILL.md 文件自动生成。请直接编辑源文件 SKILL.md,而非此页面。 */}

Heartmula

HeartMuLa:基于歌词与标签生成类似 Suno 风格的歌曲。

技能元数据

来源内置(默认已安装)
路径skills/media/heartmula
版本1.0.0
支持平台linux、macos、windows
标签音乐音频生成AIheartmulaheartcodec歌词歌曲
相关技能audiocraft

参考:完整 SKILL.md 文件

:::info 以下是当触发该技能时 Hermes 会加载的完整技能定义。技能处于激活状态时,智能体看到的指令即为内容。
::

HeartMuLa – 开源音乐生成工具

概述

HeartMuLa 是一系列开源音乐基础模型(采用 Apache-2.0 许可证),能够根据歌词和标签生成音乐,并支持多语言处理。它可以通过歌词与标签生成完整的歌曲,在开源领域可视为 Suno 的替代方案。该系列包括:

  • HeartMuLa – 用于根据歌词与标签生成音乐的文本模型(3B/7B 版本)
  • HeartCodec – 用于高保真音频重建的 12.5Hz 音乐编解码器
  • HeartTranscriptor – 基于 Whisper 技术的歌词转录工具
  • HeartCLAP – 音频与文本对齐模型

适用场景

  • 用户希望根据文字描述生成音乐或歌曲
  • 用户需要开源版本的 Suno 替代品
  • 用户希望进行本地/离线音乐生成
  • 用户咨询有关 HeartMuLa、heartlib 或 AI 音乐生成的相关内容

硬件要求

  • 最低配置:8GB 显存,同时使用 --lazy_load true 参数(按顺序加载/卸载模型)
  • 推荐配置:16GB+ 显存,以便在单 GPU 环境下更流畅地运行
  • 多 GPU 场景:可使用 --mula_device cuda:0 --codec_device cuda:1 参数将任务分配到不同 GPU 上处理
  • 使用带 lazy_load 功能的 3B 模型时,最大显存占用约为 6.2GB

安装步骤

1. 克隆仓库

cd ~/  # or desired directory
git clone https://github.com/HeartMuLa/heartlib.git
cd heartlib

2. 创建虚拟环境(需使用 Python 3.10)

uv venv --python 3.10 .venv
. .venv/bin/activate
uv pip install -e .

3. 解决依赖兼容性问题

重要提示:截至2026年2月,已固定的依赖项与较新版本的软件包存在冲突。请应用以下修复方案:

# Upgrade datasets (old version incompatible with current pyarrow)
uv pip install --upgrade datasets

# Upgrade transformers (needed for huggingface-hub 1.x compatibility)
uv pip install --upgrade transformers

4. 修复源代码(transformers 5.x版本必需)

补丁1——修复RoPE缓存问题,位于src/heartlib/heartmula/modeling_heartmula.py文件中:

HeartMuLa类的setup_caches方法中,在reset_caches的try/except代码块之后、with device:代码块之前,添加RoPE重置逻辑:

# Re-initialize RoPE caches that were skipped during meta-device loading
from torchtune.models.llama3_1._position_embeddings import Llama3ScaledRoPE
for module in self.modules():
    if isinstance(module, Llama3ScaledRoPE) and not module.is_cache_built:
        module.rope_init()
        module.to(device)

原因from_pretrained 方法会首先在元设备上创建模型;而 Llama3ScaledRoPE.rope_init() 方法则会跳过对元张量的缓存构建,且在权重加载到实际设备后也不会再次进行构建。

位于 src/heartlib/pipelines/music_generation.py 中的 Patch 2 - HeartCodec 加载修复

需在所有 HeartCodec.from_pretrained() 调用中添加 ignore_mismatched_sizes=True 参数(共有两次调用:一次是在 __init__ 方法中的即时加载,另一次是在 codec 属性中的延迟加载)。

原因:检查点文件中的 VQ 代码本已初始化缓冲区的形状为 [1],而模型内部的对应缓冲区形状则为 []。尽管数据相同,但前者为标量值,后者为零维张量,因此可以安全地忽略这种尺寸差异。

5. 下载模型检查点

cd heartlib  # project root
hf download --local-dir './ckpt' 'HeartMuLa/HeartMuLaGen'
hf download --local-dir './ckpt/HeartMuLa-oss-3B' 'HeartMuLa/HeartMuLa-oss-3B-happy-new-year'
hf download --local-dir './ckpt/HeartCodec-oss' 'HeartMuLa/HeartCodec-oss-20260123'

这三项内容可以同时下载,总大小约为数GB。

GPU / CUDA

HeartMuLa默认使用CUDA(通过--mula_device cuda --codec_device cuda参数指定)。只要用户拥有支持PyTorch CUDA功能的NVIDIA GPU,即无需额外配置。

  • 已安装的torch==2.4.1版本默认支持CUDA 12.1
  • torchtune工具显示的版本可能为0.4.0+cpu——这只是软件包的元数据信息,实际仍通过PyTorch使用CUDA
  • 要确认是否使用了GPU,可查看输出结果中的“CUDA内存”相关行(例如“卸载前CUDA内存占用:6.20 GB”)
  • 没有GPU? 可以通过--mula_device cpu --codec_device cpu参数在CPU模式下运行,但生成速度会极其缓慢(处理一首歌曲可能需要30到60分钟以上,而GPU模式下仅需约4分钟)。CPU模式还需要足够的RAM(建议预留12GB以上空闲内存)。如果用户没有NVIDIA GPU,建议使用云GPU服务(如Google Colab的免费T4版本、Lambda Labs等),或访问在线演示地址https://heartmula.github.io/进行测试。

使用方法

基本生成流程

cd heartlib
. .venv/bin/activate
python ./examples/run_music_generation.py \
  --model_path=./ckpt \
  --version="3B" \
  --lyrics="./assets/lyrics.txt" \
  --tags="./assets/tags.txt" \
  --save_path="./assets/output.mp3" \
  --lazy_load true

输入格式

标签(以逗号分隔,不可包含空格):

piano,happy,wedding,synthesizer,romantic

rock,energetic,guitar,drums,male-vocal

歌词(请使用括号内的结构标签):

[Intro]

[Verse]
Your lyrics here...

[Chorus]
Chorus lyrics...

[Bridge]
Bridge lyrics...

[Outro]

关键参数

参数默认值描述
--max_audio_length_ms240000最大长度,单位为毫秒(240秒 = 4分钟)
--topk50Top-k采样策略
--temperature1.0采样温度
--cfg_scale1.5无分类器引导系数
--lazy_loadfalse按需加载/卸载模型(可节省VRAM)
--mula_dtypebfloat16HeartMuLa的数据类型(推荐使用bf16)
--codec_dtypefloat32HeartCodec的 data类型(为保证音质,推荐使用fp32)

性能表现

  • 实时因子(RTF)约为1.0——一首4分钟的歌曲大约需要4分钟时间生成
  • 输出格式:MP3,48kHz立体声,128kbps比特率

常见问题与注意事项

  1. 切勿为HeartCodec使用bf16格式——这会降低音频质量。请使用默认的fp32格式。
  2. 标签信息可能会被忽略——这是一个已知问题(编号#90)。歌词内容往往占主导地位,可尝试调整标签的排列顺序。
  3. macOS系统不支持Triton框架——GPU加速功能仅适用于Linux系统及CUDA环境。
  4. 有报告指出RTX 5080显卡可能存在兼容性问题。
  5. 由于依赖项版本冲突,需按照上文所述进行手动升级和打补丁操作。

相关链接

  • 代码仓库:https://github.com/HeartMuLa/heartlib
  • 模型地址:https://huggingface.co/HeartMuLa
  • 论文链接:https://arxiv.org/abs/2601.10547
  • 许可协议:Apache-2.0