Skip to content

Latest commit

 

History

History
84 lines (57 loc) · 3.52 KB

README.md

File metadata and controls

84 lines (57 loc) · 3.52 KB
Raw

VoxInstruct: Expressive Human Instruction-to-Speech Generation with Unified Multilingual Codec Language Modelling

This is the official PyTorch implementation of "VoxInstruct: Expressive Human Instruction-to-Speech Generation with Unified Multilingual Codec Language Modelling", accepted by ACM MM2024 as Oral.

Demopage is available at: VoxInstruct Demo

In this repository, we provide the VoxInstruct model, inference scripts, and the checkpoint that has been trained on the internal large-scale <instruction, speech> dataset.

Installation

You can install the necessary dependencies using the requirements.txt file with Python 3.9.18:

conda create -n voxinstruct python=3.9.18
pip install torch==2.3.0 torchvision==0.18.0 torchaudio==2.3.0 --index-url https://download.pytorch.org/whl/cu121
pip install -r requirements.txt

Due to storage limitations, we have saved the model checkpoints on Google Drive at https://drive.google.com/drive/folders/1LoVAnMiwAq4X-OI0U2UQJsIEs7G6o0L0?usp=sharing.

You can download the models and save them in the pretrained folder.

Inference

To run inference, firstly input your instructions at the examples/example_instructions.txt.

Each line in the file represents a sample to be generated, with the format as: <sample_name>|<lang_id>|<instruction_text>|<(optional)speech_prompt_path>.

<lang_id> indicates the pronunciation tendency of the synthesized speech (0 represents English, 1 represents Chinese). When using a speech prompt, the transcript of the speech prompt should be included in the content part of the instruction.

0001|1|语调中带着嫌弃不满的情绪，彰显出说话着极度抱怨的情感，“不用别人点她自己就炸了，你说你也是的，干吗要介绍一个这么花花公子的人给小萍啊？”|
......
0012|1|“下面唱的这是西河大鼓，西河大鼓发源于河北省河间地带。欢迎大家使用 VoxInstruct 模型进行指令到语音生成。”|./examples/actor_ref.wav

Secondly, use the following command in infer.sh:

CUDA_VISIBLE_DEVICES=0 python3 inference.py \
    --ar_config ./configs/train_ar.yaml \
    --nar_config ./configs/train_nar.yaml \
    --ar_ckpt ./pretrained/voxinstruct-sft-checkpoint/ar_1800k.pyt \
    --nar_ckpt ./pretrained/voxinstruct-sft-checkpoint/nar_1800k.pyt \
    --synth_file  ./examples/example_instructions.txt \
    --out_dir ./results  \
    --device cuda \
    --vocoder vocos \
    --cfg_st_on_text 1.5 \
    --cfg_at_on_text 3.0 \
    --cfg_at_on_st 1.5 \
    --nar_iter_steps 8

You can try other cfg value for better performance.

Future Work

  • provide a more detailed README file (sorry for the time constraints)
  • release training scripts (or you can refer to train_ar.py and meta_files now)
  • train the model with more data, e.g., speech, music, sound, ...

License

The code and weights in this repository is released under the MIT license as found in the LICENSE file.

Citation

Please cite our paper if you find this work useful:

@inproceedings{zhou2024voxinstruct,
  title={VoxInstruct: Expressive Human Instruction-to-Speech Generation with Unified Multilingual Codec Language Modelling},
  author={Zhou, Yixuan and Qin, Xiaoyu and Jin, Zeyu and Zhou, Shuoyi and Lei, Shun and Zhou, Songtao and Wu, Zhiyong and Jia, Jia},
  booktitle={Proceedings of the 32nd ACM International Conference on Multimedia},
  pages={554--563},
  year={2024}
}