Update README to align with latest GitHub release
Browse files
README.md
CHANGED
|
@@ -53,8 +53,8 @@ analysis.
|
|
| 53 |
|
| 54 |
## News
|
| 55 |
|
| 56 |
-
* 2026.
|
| 57 |
-
* 2026.
|
| 58 |
|
| 59 |
## Contents
|
| 60 |
|
|
@@ -67,9 +67,8 @@ analysis.
|
|
| 67 |
- [Evaluation](#evaluation)
|
| 68 |
- [Quickstart](#quickstart)
|
| 69 |
- [Environment Setup](#environment-setup)
|
| 70 |
-
- [Basic Usage](#basic-usage)
|
| 71 |
-
- [Gradio App](#gradio-app)
|
| 72 |
- [SGLang Serving](#sglang-serving)
|
|
|
|
| 73 |
- [More Information](#more-information)
|
| 74 |
- [LICENSE](#license)
|
| 75 |
- [Citation](#citation)
|
|
@@ -96,6 +95,10 @@ model.
|
|
| 96 |
grounded in a full track, including chain-of-thought reasoning in the
|
| 97 |
*Thinking* variant.
|
| 98 |
|
|
|
|
|
|
|
|
|
|
|
|
|
| 99 |
## Model Architecture
|
| 100 |
|
| 101 |
MOSS-Music inherits the MOSS-Audio modular design, comprising three
|
|
@@ -337,55 +340,21 @@ command with:
|
|
| 337 |
pip install --extra-index-url https://download.pytorch.org/whl/cu128 -e ".[torch-runtime,flash-attn]"
|
| 338 |
```
|
| 339 |
|
| 340 |
-
###
|
| 341 |
-
|
| 342 |
-
Download the model first:
|
| 343 |
-
|
| 344 |
-
```bash
|
| 345 |
-
hf download OpenMOSS-Team/MOSS-Music-8B-Instruct --local-dir ./weights/MOSS-Music-8B-Instruct
|
| 346 |
-
hf download OpenMOSS-Team/MOSS-Music-8B-Thinking --local-dir ./weights/MOSS-Music-8B-Thinking
|
| 347 |
-
```
|
| 348 |
-
|
| 349 |
-
Then edit `MODEL_PATH` / `AUDIO_PATH` in `infer.py` as needed, and run:
|
| 350 |
-
|
| 351 |
-
```bash
|
| 352 |
-
python infer.py
|
| 353 |
-
```
|
| 354 |
|
| 355 |
> [!IMPORTANT]
|
| 356 |
-
> To achieve the best generation quality and fully leverage the model
|
| 357 |
> **strongly recommend using SGLang Serving for inference**.
|
| 358 |
|
|
|
|
| 359 |
|
| 360 |
-
|
| 361 |
-
`Please give a detailed musical description of this clip.`. You can directly
|
| 362 |
-
edit that line if you want to try lyrics transcription, chord / key / tempo
|
| 363 |
-
analysis, structural segmentation, or open-ended musical QA. Typical prompts:
|
| 364 |
-
|
| 365 |
-
- `Describe this piece of music in terms of style and tempo, tonal quality and harmony, instrumentation and arrangement, structural organization, and overall emotional mood.`
|
| 366 |
-
- `Please give a detailed musical description of this clip.`
|
| 367 |
-
- `Transcribe the lyrics of this song (with timestamps).`
|
| 368 |
-
- `Transcribe the chord progression of this piece of music with timestamps, and output it in JSON format.`
|
| 369 |
-
- `What is the key, tempo and mood of this track?`
|
| 370 |
-
- `Segment the song into verse / chorus / bridge sections.`
|
| 371 |
-
|
| 372 |
-
### Gradio App
|
| 373 |
-
|
| 374 |
-
Start the Gradio demo with:
|
| 375 |
|
| 376 |
```bash
|
| 377 |
-
|
|
|
|
| 378 |
```
|
| 379 |
|
| 380 |
-
The server address and port can be overridden via the
|
| 381 |
-
`MOSS_MUSIC_SERVER_NAME` and `MOSS_MUSIC_SERVER_PORT` environment variables,
|
| 382 |
-
and the default model ID via `MOSS_MUSIC_MODEL_ID`.
|
| 383 |
-
|
| 384 |
-
### SGLang Serving
|
| 385 |
-
|
| 386 |
-
If you want to serve MOSS-Music with SGLang, see the full guide in
|
| 387 |
-
`moss_music_usage_guide.md`.
|
| 388 |
-
|
| 389 |
The shortest setup is:
|
| 390 |
|
| 391 |
```bash
|
|
@@ -405,6 +374,18 @@ You can replace `./weights/MOSS-Music-8B-Instruct` with
|
|
| 405 |
If you use the default `torch==2.9.1+cu128` runtime, installing
|
| 406 |
`nvidia-cudnn-cu12==9.16.0.29` is recommended before starting `sglang serve`.
|
| 407 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 408 |
## More Information
|
| 409 |
|
| 410 |
- **MOSI.AI**: [https://mosi.cn](https://mosi.cn)
|
|
|
|
| 53 |
|
| 54 |
## News
|
| 55 |
|
| 56 |
+
* 2026.05.01: πππ We have released [MOSS-Music](https://huggingface.co/OpenMOSS-Team/MOSS-Music-8B-Instruct).
|
| 57 |
+
* 2026.05.01: πππ We have released [MOSS-Music-Data-Pipeline](https://github.com/wx9songs/MOSS-Music-Data-Pipeline) for large-scale music data annotation and processing.
|
| 58 |
|
| 59 |
## Contents
|
| 60 |
|
|
|
|
| 67 |
- [Evaluation](#evaluation)
|
| 68 |
- [Quickstart](#quickstart)
|
| 69 |
- [Environment Setup](#environment-setup)
|
|
|
|
|
|
|
| 70 |
- [SGLang Serving](#sglang-serving)
|
| 71 |
+
- [Gradio App](#gradio-app)
|
| 72 |
- [More Information](#more-information)
|
| 73 |
- [LICENSE](#license)
|
| 74 |
- [Citation](#citation)
|
|
|
|
| 95 |
grounded in a full track, including chain-of-thought reasoning in the
|
| 96 |
*Thinking* variant.
|
| 97 |
|
| 98 |
+
<p align="center">
|
| 99 |
+
<img src="./assets/moss-music_img.png" width="98%" alt="MOSS-Music overview" />
|
| 100 |
+
</p>
|
| 101 |
+
|
| 102 |
## Model Architecture
|
| 103 |
|
| 104 |
MOSS-Music inherits the MOSS-Audio modular design, comprising three
|
|
|
|
| 340 |
pip install --extra-index-url https://download.pytorch.org/whl/cu128 -e ".[torch-runtime,flash-attn]"
|
| 341 |
```
|
| 342 |
|
| 343 |
+
### SGLang Serving
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 344 |
|
| 345 |
> [!IMPORTANT]
|
| 346 |
+
> To achieve the best generation quality and fully leverage the model's capabilities, we
|
| 347 |
> **strongly recommend using SGLang Serving for inference**.
|
| 348 |
|
| 349 |
+
See the full SGLang guide in `moss_music_usage_guide.md`.
|
| 350 |
|
| 351 |
+
Download the model first:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 352 |
|
| 353 |
```bash
|
| 354 |
+
hf download OpenMOSS-Team/MOSS-Music-8B-Instruct --local-dir ./weights/MOSS-Music-8B-Instruct
|
| 355 |
+
hf download OpenMOSS-Team/MOSS-Music-8B-Thinking --local-dir ./weights/MOSS-Music-8B-Thinking
|
| 356 |
```
|
| 357 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 358 |
The shortest setup is:
|
| 359 |
|
| 360 |
```bash
|
|
|
|
| 374 |
If you use the default `torch==2.9.1+cu128` runtime, installing
|
| 375 |
`nvidia-cudnn-cu12==9.16.0.29` is recommended before starting `sglang serve`.
|
| 376 |
|
| 377 |
+
### Gradio App
|
| 378 |
+
|
| 379 |
+
Start the Gradio demo with:
|
| 380 |
+
|
| 381 |
+
```bash
|
| 382 |
+
python app.py
|
| 383 |
+
```
|
| 384 |
+
|
| 385 |
+
The server address and port can be overridden via the
|
| 386 |
+
`MOSS_MUSIC_SERVER_NAME` and `MOSS_MUSIC_SERVER_PORT` environment variables,
|
| 387 |
+
and the default model ID via `MOSS_MUSIC_MODEL_ID`.
|
| 388 |
+
|
| 389 |
## More Information
|
| 390 |
|
| 391 |
- **MOSI.AI**: [https://mosi.cn](https://mosi.cn)
|