intro.md

Please create the zip file in the following structure:

```
train.zip
    - audio
        - audio_id_1.wav
        - audio_id_2.wav
        - ...
  
    - text
    - text_ctc
```

`text_ctc` should contain the transcription in the following format:

```
audio_id_1 transcription
audio_id_2 transcription
...
```

`text` should contain the text output in the following format:

```
audio_id_1 transcription or translated text
audio_id_2 transcription or translated text
...
```

## What is OWSM project?

OWSM is an **O**pen **W**hisper-style **S**peech **M**odel from [CMU WAVLab](https://www.wavlab.org/).
It reproduces Whisper-style training using publicly available data and an open-source toolkit [ESPnet](https://github.com/espnet/espnet).

This demo fine-tune a tiny version of OWSM-v3.1-ebf,
which is an improved version of OWSM v3.
This model was trained with 180k hours of public speech data.
You can find more details in the following pages:

- OWSM Paper: [https://arxiv.org/abs/2309.13876](https://arxiv.org/abs/2309.13876)
- Project page: [Open Whisper-style Speech Models](https://www.wavlab.org/activities/2024/owsm/)
- OWSM-v3.1 Demo: [pyf98/OWSM_v3_demo](https://huggingface.co/spaces/pyf98/OWSM_v3_demo)


## Citing OWSM, Branchformers and ESPnet

```
@misc{peng2024owsm,
      title={OWSM v3.1: Better and Faster Open Whisper-Style Speech Models based on E-Branchformer}, 
      author={Yifan Peng and Jinchuan Tian and William Chen and Siddhant Arora and Brian Yan and Yui Sudo and Muhammad Shakeel and Kwanghee Choi and Jiatong Shi and Xuankai Chang and Jee-weon Jung and Shinji Watanabe},
      year={2024},
      eprint={2401.16658},
      archivePrefix={arXiv},
      primaryClass={cs.CL}
}
@INPROCEEDINGS{owsm-asru23,
  author={Peng, Yifan and Tian, Jinchuan and Yan, Brian and Berrebbi, Dan and Chang, Xuankai and Li, Xinjian and Shi, Jiatong and Arora, Siddhant and Chen, William and Sharma, Roshan and Zhang, Wangyou and Sudo, Yui and Shakeel, Muhammad and Jung, Jee-Weon and Maiti, Soumi and Watanabe, Shinji},
  booktitle={2023 IEEE Automatic Speech Recognition and Understanding Workshop (ASRU)}, 
  title={Reproducing Whisper-Style Training Using An Open-Source Toolkit And Publicly Available Data}, 
  year={2023},
  doi={10.1109/ASRU57964.2023.10389676}
}
@inproceedings{peng23b_interspeech,
  author={Yifan Peng and Kwangyoun Kim and Felix Wu and Brian Yan and Siddhant Arora and William Chen and Jiyang Tang and Suwon Shon and Prashant Sridhar and Shinji Watanabe},
  title={{A Comparative Study on E-Branchformer vs Conformer in Speech Recognition, Translation, and Understanding Tasks}},
  year=2023,
  booktitle={Proc. INTERSPEECH 2023},
  pages={2208--2212},
  doi={10.21437/Interspeech.2023-1194}
}
@inproceedings{kim2023branchformer,
  title={E-branchformer: Branchformer with enhanced merging for speech recognition},
  author={Kim, Kwangyoun and Wu, Felix and Peng, Yifan and Pan, Jing and Sridhar, Prashant and Han, Kyu J and Watanabe, Shinji},
  booktitle={2022 IEEE Spoken Language Technology Workshop (SLT)},
  pages={84--91},
  year={2023},
  organization={IEEE}
}
@InProceedings{pmlr-v162-peng22a,
  title = 	 {Branchformer: Parallel {MLP}-Attention Architectures to Capture Local and Global Context for Speech Recognition and Understanding},
  author =       {Peng, Yifan and Dalmia, Siddharth and Lane, Ian and Watanabe, Shinji},
  booktitle = 	 {Proceedings of the 39th International Conference on Machine Learning},
  pages = 	 {17627--17643},
  year = 	 {2022},
  editor = 	 {Chaudhuri, Kamalika and Jegelka, Stefanie and Song, Le and Szepesvari, Csaba and Niu, Gang and Sabato, Sivan},
  volume = 	 {162},
  series = 	 {Proceedings of Machine Learning Research},
  month = 	 {17--23 Jul},
  publisher =    {PMLR},
  pdf = 	 {https://proceedings.mlr.press/v162/peng22a/peng22a.pdf},
  url = 	 {https://proceedings.mlr.press/v162/peng22a.html},
  abstract = 	 {Conformer has proven to be effective in many speech processing tasks. It combines the benefits of extracting local dependencies using convolutions and global dependencies using self-attention. Inspired by this, we propose a more flexible, interpretable and customizable encoder alternative, Branchformer, with parallel branches for modeling various ranged dependencies in end-to-end speech processing. In each encoder layer, one branch employs self-attention or its variant to capture long-range dependencies, while the other branch utilizes an MLP module with convolutional gating (cgMLP) to extract local relationships. We conduct experiments on several speech recognition and spoken language understanding benchmarks. Results show that our model outperforms both Transformer and cgMLP. It also matches with or outperforms state-of-the-art results achieved by Conformer. Furthermore, we show various strategies to reduce computation thanks to the two-branch architecture, including the ability to have variable inference complexity in a single trained model. The weights learned for merging branches indicate how local and global dependencies are utilized in different layers, which benefits model designing.}
}
@inproceedings{watanabe2018espnet,
  author={Shinji Watanabe and Takaaki Hori and Shigeki Karita and Tomoki Hayashi and Jiro Nishitoba and Yuya Unno and Nelson Yalta and Jahn Heymann and Matthew Wiesner and Nanxin Chen and Adithya Renduchintala and Tsubasa Ochiai},
  title={{ESPnet}: End-to-End Speech Processing Toolkit},
  year={2018},
  booktitle={Proceedings of Interspeech},
  pages={2207--2211},
  doi={10.21437/Interspeech.2018-1456},
  url={http://dx.doi.org/10.21437/Interspeech.2018-1456}
}
```