Inspiremusic Base

🚀 InspireMusic

InspireMusic is a unified toolkit for music, song, and audio generation, enabling high - quality and long - form audio creation.

Please support our community by starring it

Highlights | Introduction | Installation | Quick Start | Tutorial | Models | Contact

✨ Features

InspireMusic focuses on music generation, song generation, and audio generation.

• A unified toolkit designed for music, song, and audio generation.
• Music generation tasks with high audio quality.
• Long - form music generation.

📚 Documentation

⚠️ Important Note

This repo contains the algorithm infrastructure and some simple examples. Currently only support English text prompts.

💡 Usage Tip

To preview the performance, please refer to InspireMusic Demo Page.

InspireMusic is a unified music, song, and audio generation framework through the audio tokenization integrated with autoregressive transformer and flow - matching based model. The original motive of this toolkit is to empower the common users to innovate soundscapes and enhance euphony in research through music, song, and audio crafting. The toolkit provides both training and inference codes for AI - based generative models that create high - quality music. Featuring a unified framework, InspireMusic incorporates audio tokenizers with autoregressive transformer and super - resolution flow - matching modeling, allowing for the controllable generation of music, song, and audio with both text and audio prompts. The toolkit currently supports music generation, will support song generation, audio generation in the future.

InspireMusic

Figure 1: An overview of the InspireMusic framework. We introduce InspireMusic, a unified framework for music, song, audio generation capable of producing high - quality long - form audio. InspireMusic consists of the following three key components. Audio Tokenizers convert the raw audio waveform into discrete audio tokens that can be efficiently processed and trained by the autoregressive transformer model. Audio waveform of lower sampling rate has converted to discrete tokens via a high bitrate compression audio tokenizer[1]. Autoregressive Transformer model is based on Qwen2.5[2] as the backbone model and is trained using a next - token prediction approach on both text and audio tokens, enabling it to generate coherent and contextually relevant token sequences. The audio and text tokens are the inputs of an autoregressive model with the next token prediction to generate tokens. Super - Resolution Flow - Matching Model based on flow modeling method, maps the generated tokens to latent features with high - resolution fine - grained acoustic details[3] obtained from a higher sampling rate of audio to ensure the acoustic information flow connected with high fidelity through models. A vocoder then generates the final audio waveform from these enhanced latent features. InspireMusic supports a range of tasks including text - to - music, music continuation, music reconstruction, and music super - resolution.

📦 Installation

Clone

• Clone the repo

git clone --recursive https://github.com/FunAudioLLM/InspireMusic.git
# If you failed to clone submodule due to network failures, please run the following command until success
cd InspireMusic
git submodule update --recursive
# or you can download the third_party repo Matcha - TTS manually
cd third_party && git clone https://github.com/shivammehta25/Matcha - TTS.git

Install from Source

InspireMusic requires Python>=3.8, PyTorch>=2.0.1, flash attention==2.6.2/2.6.3, CUDA>=11.2. You can install the dependencies with the following commands:

• Install Conda: please see https://docs.conda.io/en/latest/miniconda.html
• Create Conda env:

conda create -n inspiremusic python = 3.8
conda activate inspiremusic
cd InspireMusic
# pynini is required by WeTextProcessing, use conda to install it as it can be executed on all platforms.
conda install -y -c conda - forge pynini = 2.1.5
pip install -r requirements.txt -i https://mirrors.aliyun.com/pypi/simple/ --trusted - host = mirrors.aliyun.com
# install flash attention to speedup training
pip install flash - attn --no - build - isolation

• Install within the package:

cd InspireMusic
# You can run to install the packages
python setup.py install
pip install flash - attn --no - build - isolation

We also recommend having sox or ffmpeg installed, either through your system or Anaconda:

# # Install sox
# ubuntu
sudo apt - get install sox libsox - dev
# centos
sudo yum install sox sox - devel

# Install ffmpeg
# ubuntu
sudo apt - get install ffmpeg
# centos
sudo yum install ffmpeg

Use Docker

Run the following command to build a docker image from Dockerfile provided.

docker build -t inspiremusic .

Run the following command to start the docker container in interactive mode.

docker run -ti --gpus all -v .:/workspace/InspireMusic inspiremusic

Use Docker Compose

Run the following command to build a docker compose environment and docker image from the docker - compose.yml file.

docker compose up -d --build

Run the following command to attach to the docker container in interactive mode.

docker exec -ti inspire - music bash

🚀 Quick Start

Basic Usage

Here is a quick example inference script for music generation.

cd InspireMusic
mkdir -p pretrained_models

# Download models
# ModelScope
git clone https://www.modelscope.cn/iic/InspireMusic - 1.5B - Long.git pretrained_models/InspireMusic - 1.5B - Long
# HuggingFace
git clone https://huggingface.co/FunAudioLLM/InspireMusic - 1.5B - Long.git pretrained_models/InspireMusic - 1.5B - Long

cd examples/music_generation
# run a quick inference example
sh infer_1.5b_long.sh

Here is a quick start running script to run music generation task including data preparation pipeline, model training, inference.

cd InspireMusic/examples/music_generation/
sh run.sh

Advanced Usage

Text - to - music Task

One - line Shell script for text - to - music task.

cd examples/music_generation
# with flow matching, use one - line command to get a quick try
python -m inspiremusic.cli.inference

# custom the config like the following one - line command
python -m inspiremusic.cli.inference --task text - to - music -m "InspireMusic - 1.5B - Long" -g 0 -t "Experience soothing and sensual instrumental jazz with a touch of Bossa Nova, perfect for a relaxing restaurant or spa ambiance." -c intro -s 0.0 -e 30.0 -r "exp/inspiremusic" -o output -f wav 

# without flow matching, use one - line command to get a quick try
python -m inspiremusic.cli.inference --task text - to - music -g 0 -t "Experience soothing and sensual instrumental jazz with a touch of Bossa Nova, perfect for a relaxing restaurant or spa ambiance." --fast True

Alternatively, you can run the inference with just a few lines of Python code.

from inspiremusic.cli.inference import InspireMusic
from inspiremusic.cli.inference import env_variables
if __name__ == "__main__":
  env_variables()
  model = InspireMusic(model_name = "InspireMusic - Base")
  model.inference("text - to - music", "Experience soothing and sensual instrumental jazz with a touch of Bossa Nova, perfect for a relaxing restaurant or spa ambiance.")

Music Continuation Task

One - line Shell script for music continuation task.

cd examples/music_generation
# with flow matching
python -m inspiremusic.cli.inference --task continuation -g 0 -a audio_prompt.wav
# without flow matching
python -m inspiremusic.cli.inference --task continuation -g 0 -a audio_prompt.wav --fast True

Alternatively, you can run the inference with just a few lines of Python code.

from inspiremusic.cli.inference import InspireMusic
from inspiremusic.cli.inference import env_variables
if __name__ == "__main__":
  env_variables()
  model = InspireMusic(model_name = "InspireMusic - Base")
  # just use audio prompt
  model.inference("continuation", None, "audio_prompt.wav")
  # use both text prompt and audio prompt
  model.inference("continuation", "Continue to generate jazz music.", "audio_prompt.wav")

📦 Model Zoo

Download Models

You may download our pretrained InspireMusic models for music generation.

# use git to download models，please make sure git lfs is installed.
mkdir -p pretrained_models
git clone https://www.modelscope.cn/iic/InspireMusic.git pretrained_models/InspireMusic

Available Models

Currently, we open source the music generation models support 24KHz mono and 48KHz stereo audio. The table below presents the links to the ModelScope and Huggingface model hub.