MusPy

MusPy 是一个用于符号化音乐生成的开源 Python 库。它提供了开发音乐生成系统所需的基本工具，包括数据集管理、数据输入输出、数据预处理和模型评估等功能。

特性

• 针对常用数据集的数据集管理系统，并提供与 PyTorch 和 TensorFlow 的接口。
• 支持常见符号化音乐格式（如 MIDI、MusicXML 和 ABC）的数据输入输出，并与其他符号化音乐库（如 music21、mido、pretty_midi 和 Pypianoroll）兼容。
• 实现了多种用于音乐生成的常见音乐表示方法，包括基于音高的表示、基于事件的表示、钢琴卷帘表示和基于音符的表示。
• 提供音乐生成系统的模型评估工具，包括音频渲染、乐谱和钢琴卷帘可视化以及客观指标等。

为什么选择 MusPy

音乐生成流程通常包含多个步骤：数据收集、数据预处理、模型构建、模型训练和模型评估。虽然某些组件需要针对每个模型进行定制，但其他部分可以在不同系统之间共享。特别是对于符号化音乐生成而言，文献中已经提出了许多数据集、表示方法和评价指标。因此，一个易于使用的工具包，能够实现这些标准流程，可以节省大量时间和精力，并提高实验的可重复性。

安装

要安装 MusPy，请运行 pip install muspy。如果需要从源代码构建 MusPy，请下载 源代码，然后运行 python setup.py install。

文档

文档可在 这里 获取，同时也以代码中的 docstring 形式提供。

引用

如果您在已发表的工作中使用了 MusPy，请引用以下论文：

Hao-Wen Dong, Ke Chen, Julian McAuley, and Taylor Berg-Kirkpatrick, “MusPy: A Toolkit for Symbolic Music Generation,” in Proceedings of the 21st International Society for Music Information Retrieval Conference (ISMIR)，2020年。

[主页] [视频] [论文] [幻灯片] [海报] [arXiv] [代码] [文档]

免责声明

本库是一个用于下载和准备公开数据集的实用工具库。我们不托管或分发这些数据集，也不对其质量或公平性作出任何保证，更不声称您拥有使用这些数据集的许可。是否可以根据数据集的许可协议使用该数据集，完全由您自行判断并承担责任。

如果您是某个数据集的所有者，并希望更新其中的任何内容（例如描述、引用信息等），或者不希望您的数据集被纳入本库中，请通过 GitHub 问题与我们联系。感谢您为社区所做的贡献！

MusPy 快速上手指南

MusPy 是一个用于符号音乐生成的开源 Python 库，提供数据集管理、数据读写、预处理及模型评估等核心工具，支持 PyTorch 和 TensorFlow 接口。

环境准备

• 操作系统：Linux, macOS, Windows
• Python 版本：建议 Python 3.7 及以上
• 前置依赖：
  • numpy
  • scipy
  • matplotlib
  • pretty_midi 或 mido（用于 MIDI 处理）
  • torch 或 tensorflow（根据深度学习框架需求选装）

💡 国内用户建议使用清华或阿里镜像源加速依赖安装：

pip install -i https://pypi.tuna.tsinghua.edu.cn/simple <package_name>

安装步骤

方式一：通过 pip 安装（推荐）

pip install muspy

国内加速安装：

pip install -i https://pypi.tuna.tsinghua.edu.cn/simple muspy

方式二：从源码安装

git clone https://github.com/salu133445/muspy.git
cd muspy
python setup.py install

基本使用

以下示例展示如何加载一个 MIDI 文件并转换为 MusPy 内部表示格式：

import muspy

# 加载 MIDI 文件
music = muspy.read_midi("example.mid")

# 转换为钢琴卷帘表示
piano_roll = music.to_piano_roll()

# 可视化钢琴卷帘
muspy.plot_piano_roll(piano_roll)

如需使用内置数据集（如 LMD、MAESTRO 等），可调用：

dataset = muspy.LMDataset(root="/path/to/lmd", download=True)
for item in dataset:
    print(item.title)

更多详细用法请参考官方文档：https://salu133445.github.io/muspy