[ English ｜ 中文 ]

SongFormer is a music structure analysis framework that leverages multi-resolution self-supervised representations and heterogeneous supervision, accompanied by the large-scale multilingual dataset SongFormDB and the high-quality benchmark SongFormBench to foster fair and reproducible research.

🔥 October 3, 2025
Open-sourced Training and Evaluation Code – We have released the full training and evaluation code to support and promote community development and further research.

🔥 October 2, 2025
One-Click Inference on Hugging Face Launched – Successfully deployed our one-click inference feature on the Hugging Face platform, making model testing and usage more accessible and user-friendly.

🔥 September 30, 2025
SongFormer Inference Package Released – The complete SongFormer inference code and pre-trained checkpoint models are now publicly available for download and use.

🔥 September 26, 2025
SongFormerDB and SongFormerBench Launched – We introduced our large-scale music dataset SongFormerDB and comprehensive benchmark suite SongFormerBench, both now available on Hugging Face to facilitate research and evaluation in Music structure analysis.

This model supports Hugging Face's from_pretrained method. To quickly get started with this code, you need to do two things:

1. Follow the instructions in Setting up Python Environment to configure your Python environment
2. Visit our Hugging Face model page, and run the code provided in the README

We've achieved breakthrough performance in music structure analysis, setting new benchmarks across the board:

• ✨ State-of-the-art accuracy on both Western and Chinese music datasets
• ⚡ Blazing fast inference - faster than comparable models
• 💰 Cost-effective - No API fees, runs locally on single GPU

Process entire songs in just 2-4 seconds! Here's how we stack up:

Benchmarked on NVIDIA L40 GPU (excluding model loading)

• ACC: Overall boundary detection accuracy
• HR.5F: Hit Rate with 0.5-second tolerance (fine-grained precision)
• HR3F: Hit Rate with 3-second tolerance

• Results marked with * are taken from original papers due to unavailable implementations
• Dataset abbreviations: HX (HarmonixSet), P, H, G refer to different training datasets as stated in the paper

git clone https://github.com/ASLP-lab/SongFormer.git

# Get MuQ and MusicFM source code
git submodule update --init --recursive

conda create -n songformer python=3.10 -y
conda activate songformer

For users in mainland China, you may need to set up pip mirror source:

pip config set global.index-url https://pypi.mirrors.ustc.edu.cn/simple

Install dependencies:

pip install -r requirements.txt

We tested this on Ubuntu 22.04.1 LTS and it works normally. If you cannot install, you may need to remove version constraints in requirements.txt

cd src/SongFormer
# For users in mainland China, you can modify according to the py file instructions to use hf-mirror.com for downloading
python utils/fetch_pretrained.py

After downloading, you can verify the md5sum values in src/SongFormer/ckpts/md5sum.txt match the downloaded files:

md5sum ckpts/MusicFM/msd_stats.json
md5sum ckpts/MusicFM/pretrained_msd.pt
md5sum ckpts/SongFormer.safetensors
# md5sum ckpts/SongFormer.pt

Available at: https://huggingface.co/spaces/ASLP-lab/SongFormer

First, change directory to the project root directory and activate the environment:

conda activate songformer

You can modify the server port and listening address in the last line of app.py according to your preference.

If you're using an HTTP proxy, please ensure you include:

export no_proxy="localhost, 127.0.0.1, ::1"
export NO_PROXY="localhost, 127.0.0.1, ::1"

Otherwise, Gradio may incorrectly assume the service hasn't started, causing startup to exit directly.

When first running app.py, it will connect to Hugging Face to download MuQ-related weights. We recommend creating an empty folder in an appropriate location and using export HF_HOME=XXX to point to this folder, so cache will be stored there for easy cleanup and transfer.

And for users in mainland China, you may need export HF_ENDPOINT=https://hf-mirror.com. For details, refer to https://hf-mirror.com/

python app.py

You can refer to the file src/SongFormer/infer/infer.py. The corresponding execution script is located at src/SongFormer/infer.sh. This is a ready-to-use, single-machine, multi-process annotation script.

Below are some configurable parameters from the src/SongFormer/infer.sh script. You can set CUDA_VISIBLE_DEVICES to specify which GPUs to use:

-i              # Input SCP folder path, each line containing the absolute path to one audio file
-o              # Output directory for annotation results
--model         # Annotation model; the default is 'SongFormer', change if using a fine-tuned model
--checkpoint    # Path to the model checkpoint file
--config_pat    # Path to the configuration file
-gn             # Total number of GPUs to use — should match the number specified in CUDA_VISIBLE_DEVICES
-tn             # Number of processes to run per GPU

You can control which GPUs are used by setting the CUDA_VISIBLE_DEVICES environment variable.

Notes

• You may need to modify line 121 in src/third_party/musicfm/model/musicfm_25hz.py to: S = torch.load(model_path, weights_only=False)["state_dict"]

The MSA TXT file format follows this structure:

start_time_1 label_1
start_time_2 label_2
....
end_time end

Each line contains two space-separated elements:

• First element: Timestamp in seconds (float type)
• Second element: Label (string type)

Conversion Notes:

• SongFormer outputs can be converted using the utility script src/SongFormer/utils/convert_res2msa_txt.py
• Other annotation tools require custom conversion to this format
• All MSA TXT files should be stored in a folder with consistent naming between ground truth (GT) and inference results

Important Note: While our model generates 8 categories, mainstream evaluation uses 7 categories. During evaluation, pre-chorus labels are mapped to verse according to our mapping rules.

The main evaluation script is located at src/SongFormer/evaluation/eval_infer_results.py. You can use the shell script src/SongFormer/eval.sh for streamlined evaluation.

Before starting, ensure you have the necessary dependencies installed and your environment properly configured.

The SSL representation extraction code is located in src/data_pipeline. Navigate to this directory first:

cd src/data_pipeline

For each song, you need to extract 4 different representations:

• MuQ - 30s: Short-term features with 30-second windows
• MuQ - 420s: Long-term features with 420-second windows
• MusicFM - 30s: Short-term features with 30-second windows
• MusicFM - 420s: Long-term features with 420-second windows

For 30-second representations, the extraction process employs a window size and hop size of 30 seconds, with features concatenated after extraction, resulting in a sequence length matching that of the 420-second version.

Run the following scripts after configuring them for your environment:

# MuQ representations
bash obtain_SSL_representation/MuQ/get_embeddings_30s_wrap420s.sh
bash obtain_SSL_representation/MuQ/get_embeddings.sh

# MusicFM representations  
bash obtain_SSL_representation/MusicFM/get_embeddings_mp_30s_wrap420s.sh
bash obtain_SSL_representation/MusicFM/get_embeddings_mp.sh

Edit src/SongFormer/configs/SongFormer.yaml to set:

• train_dataset: Training dataset configuration
• eval_dataset: Evaluation dataset configuration
• args: Model settings and experiment name

For the dataset_abstracts class, configure these parameters:

Update src/SongFormer/train/accelerate_config/single_gpu.yaml with your desired accelerate settings, and configure src/SongFormer/train.sh accordingly:

• Your Weights & Biases (wandb) API key
• Other training-specific settings

Navigate to the SongFormer directory and execute the training script:

cd src/SongFormer
bash train.sh

• The relevant training dashboard will be displayed on wandb
• Checkpoints will be located in src/SongFormer/output

If our work and codebase is useful for you, please cite as:

@misc{hao2025songformer,
  title         = {SongFormer: Scaling Music Structure Analysis with Heterogeneous Supervision},
  author        = {Chunbo Hao and Ruibin Yuan and Jixun Yao and Qixin Deng and Xinyi Bai and Wei Xue and Lei Xie},
  year          = {2025},
  eprint        = {2510.02797},
  archivePrefix = {arXiv},
  primaryClass  = {eess.AS},
  url           = {https://arxiv.org/abs/2510.02797}
}

Our code is released under CC-BY-4.0 License.

We welcome your feedback and contributions! You can reach us through:

• Report Issues: Found a bug or have a suggestion? Please open an issue directly in this GitHub repository. This is the best way to track and resolve problems.
• Join Our Community: For discussions and real-time support, join our Discord server: https://discord.gg/rwcqh7Em

We look forward to hearing from you!