Update README.md

README.md

@@ -1,145 +1,145 @@
----
-language: "en"
-thumbnail:
-tags:
-- speech-llm
-- audio-llm
-- speechbrain
-- pytorch
-license: "apache-2.0"
-datasets:
-- openasqa
-- iemocap
-- libritts
-- audioset
-- audioset-strong
-- audiocaps
-- vgg-sound
-- voxceleb2
-- cmu-mosei
-- clotho
-- fsd50k
-- fma
-inference: false
----
-
-<iframe src="https://ghbtns.com/github-btn.html?user=speechbrain&repo=speechbrain&type=star&count=true&size=large&v=2" frameborder="0" scrolling="0" width="170" height="30" title="GitHub"></iframe>
-<br/><br/>
-
-# LTU-AS is an Audio/Speech LLM trained on OpenASQA dataset.
-
-This repository provides all the necessary tools to infer a specch llm using SpeechBrain. For more details please check the ltu-as [paper](https://arxiv.org/pdf/2309.14405).
-
-
-For a better experience, we encourage you to learn more about [SpeechBrain](https://speechbrain.github.io). The model performance is evaluated on 5 different tasks:
-
-| model | Emotion Recognition Iemocap (Acc) | ASR Librispeech test-clean (WER) | Audio Classification ESC-50 (Acc) | Age Prediction Voxceleb2-test (MAE) | Gender Classification Voxceleb2-test (F1) |
-|:-----------------------------:|:----------------------------------:|:----------------------------------:|:----------------------------------:|:----------------------------------:|:----------------------------------:|
-| original model in the paper | 65.2% | 4.9% | 80.8% | 7.3 | 90.8% |
-| our model | 69.5% | 1.45% (with Whisper large v3) | 76.6% | 6.67 | 98.8% |
-
-
-## Pipeline description
-
-1. A whisper encoder together with a TLTR (time- and layer-wise transformer) is used as an audio encoder to encode acoustic embeddings. 
-2. For speech, an external ASR system is used to get the spoken texts such as whisper-large-v3 used here.
-3. The spoken text is added into a user prompt then transformed to a text embedding. It is then concatenated with the acoustic embedding from the first step and fed to a fine-tuned Llama3.
-
-## Install SpeechBrain
-
-First of all, please install the **development** version of SpeechBrain with the following command:
-
-```
-git clone https://github.com/speechbrain/speechbrain.git
-cd speechbrain
-pip install -r requirements.txt
-pip install --editable .
-```
-
-Please notice that we encourage you to read our tutorials and learn more about
-[SpeechBrain](https://speechbrain.github.io).
-
-### Inference of LTU-AS 
-
-```python
-from speechbrain.inference.multimodal import LTU_AS
-from transformers import AutoModelForSpeechSeq2Seq, AutoProcessor, pipeline
-
-ltu_as = LTU_AS.from_hparams(
-    source="speechbrain/speech-llm-LTU-AS-openasqa"
-)
-
-# whisper-large-v3 as ASR model, can be changed to any customised ASR model
-device = "cuda:0" if torch.cuda.is_available() else "cpu"
-torch_dtype = torch.float16 if torch.cuda.is_available() else torch.float32
-model_id = "openai/whisper-large-v3"
-model = AutoModelForSpeechSeq2Seq.from_pretrained(
-    model_id, torch_dtype=torch_dtype, low_cpu_mem_usage=True, use_safetensors=True
-)
-model.to(device)
-
-processor = AutoProcessor.from_pretrained(model_id)
-pipe = pipeline(
-    "automatic-speech-recognition",
-    model=model,
-    tokenizer=processor.tokenizer,
-    feature_extractor=processor.feature_extractor,
-    max_new_tokens=128,
-    chunk_length_s=30,
-    batch_size=16,
-    return_timestamps=False,
-    torch_dtype=torch_dtype,
-    device=device,
-)
-
-# start an inference loop:
-while True:
-    audio_path = input("please enter the raw audio path : ")
-    instruction = input("please enter the instruction : ")
-    transcript = " " + pipe(audio_path)["text"]
-    predicted_words = ltu_as.generate_with_raw_audio(audio_path, instruction, transcript)[0]
-    print("\n")
-    print(predicted_words)
-    print("\n")
-```
-
-### Inference on GPU
-To perform inference on the GPU, add  `run_opts={"device":"cuda"}`  when calling the `from_hparams` method.
-
-### Training
-The training information can be found [here]()
-
-You can find our training results (models, logs, etc) [here]().
-
-### Limitations
-The SpeechBrain team does not provide any warranty on the performance achieved by this model when used on other datasets.
-
-# **Citing LTU-AS**
-```bibtex
-@inproceedings{gong_ltuas,
-  title={Joint Audio and Speech Understanding},
-  author={Gong, Yuan and Liu, Alexander H and Luo, Hongyin, and Karlinsky, Leonid and Glass, James},
-  year={2023},
-  booktitle={2023 IEEE Automatic Speech Recognition and Understanding Workshop (ASRU)},
-}
-```
-
-# **Citing SpeechBrain**
-Please, cite SpeechBrain if you use it for your research or business.
-
-```bibtex
-@misc{speechbrain,
-  title={{SpeechBrain}: A General-Purpose Speech Toolkit},
-  author={Mirco Ravanelli and Titouan Parcollet and Peter Plantinga and Aku Rouhe and Samuele Cornell and Loren Lugosch and Cem Subakan and Nauman Dawalatabad and Abdelwahab Heba and Jianyuan Zhong and Ju-Chieh Chou and Sung-Lin Yeh and Szu-Wei Fu and Chien-Feng Liao and Elena Rastorgueva and François Grondin and William Aris and Hwidong Na and Yan Gao and Renato De Mori and Yoshua Bengio},
-  year={2021},
-  eprint={2106.04624},
-  archivePrefix={arXiv},
-  primaryClass={eess.AS},
-  note={arXiv:2106.04624}
-}
-```
-
-# **About SpeechBrain**
-- Website: https://speechbrain.github.io/
-- Code: https://github.com/speechbrain/speechbrain/
+---
+language: "en"
+thumbnail:
+tags:
+- speech-llm
+- audio-llm
+- speechbrain
+- pytorch
+license: "apache-2.0"
+datasets:
+- openasqa
+- iemocap
+- libritts
+- audioset
+- audioset-strong
+- audiocaps
+- vgg-sound
+- voxceleb2
+- cmu-mosei
+- clotho
+- fsd50k
+- fma
+inference: false
+---
+
+<iframe src="https://ghbtns.com/github-btn.html?user=speechbrain&repo=speechbrain&type=star&count=true&size=large&v=2" frameborder="0" scrolling="0" width="170" height="30" title="GitHub"></iframe>
+<br/><br/>
+
+# LTU-AS is an Audio/Speech LLM trained on OpenASQA dataset.
+
+This repository provides all the necessary tools to infer a speech llm using SpeechBrain. For more details please check the ltu-as [paper](https://arxiv.org/pdf/2309.14405).
+
+
+For a better experience, we encourage you to learn more about [SpeechBrain](https://speechbrain.github.io). The model performance is evaluated on 5 different tasks:
+
+| model | Emotion Recognition Iemocap (Acc) | ASR Librispeech test-clean (WER) | Audio Classification ESC-50 (Acc) | Age Prediction Voxceleb2-test (MAE) | Gender Classification Voxceleb2-test (F1) |
+|:-----------------------------:|:----------------------------------:|:----------------------------------:|:----------------------------------:|:----------------------------------:|:----------------------------------:|
+| original model in the paper | 65.2% | 4.9% | 80.8% | 7.3 | 90.8% |
+| our model | 69.5% | 1.45% (with Whisper large v3) | 76.6% | 6.67 | 98.8% |
+
+
+## Pipeline description
+
+1. A whisper encoder together with a TLTR (time- and layer-wise transformer) is used as an audio encoder to encode acoustic embeddings. 
+2. For speech, an external ASR system is used to get the spoken texts such as whisper-large-v3 used here.
+3. The spoken text is added into a user prompt then transformed to a text embedding. It is then concatenated with the acoustic embedding from the first step and fed to a fine-tuned Llama3.
+
+## Install SpeechBrain
+
+First of all, please install the **development** version of SpeechBrain with the following command:
+
+```
+git clone https://github.com/speechbrain/speechbrain.git
+cd speechbrain
+pip install -r requirements.txt
+pip install --editable .
+```
+
+Please notice that we encourage you to read our tutorials and learn more about
+[SpeechBrain](https://speechbrain.github.io).
+
+### Inference of LTU-AS 
+
+```python
+from speechbrain.inference.multimodal import LTU_AS
+from transformers import AutoModelForSpeechSeq2Seq, AutoProcessor, pipeline
+
+ltu_as = LTU_AS.from_hparams(
+    source="speechbrain/speech-llm-LTU-AS-openasqa"
+)
+
+# whisper-large-v3 as ASR model, can be changed to any customised ASR model
+device = "cuda:0" if torch.cuda.is_available() else "cpu"
+torch_dtype = torch.float16 if torch.cuda.is_available() else torch.float32
+model_id = "openai/whisper-large-v3"
+model = AutoModelForSpeechSeq2Seq.from_pretrained(
+    model_id, torch_dtype=torch_dtype, low_cpu_mem_usage=True, use_safetensors=True
+)
+model.to(device)
+
+processor = AutoProcessor.from_pretrained(model_id)
+pipe = pipeline(
+    "automatic-speech-recognition",
+    model=model,
+    tokenizer=processor.tokenizer,
+    feature_extractor=processor.feature_extractor,
+    max_new_tokens=128,
+    chunk_length_s=30,
+    batch_size=16,
+    return_timestamps=False,
+    torch_dtype=torch_dtype,
+    device=device,
+)
+
+# start an inference loop:
+while True:
+    audio_path = input("please enter the raw audio path : ")
+    instruction = input("please enter the instruction : ")
+    transcript = " " + pipe(audio_path)["text"]
+    predicted_words = ltu_as.generate_with_raw_audio(audio_path, instruction, transcript)[0]
+    print("\n")
+    print(predicted_words)
+    print("\n")
+```
+
+### Inference on GPU
+To perform inference on the GPU, add  `run_opts={"device":"cuda"}`  when calling the `from_hparams` method.
+
+### Training
+The training information can be found [here]()
+
+You can find our training results (models, logs, etc) [here]().
+
+### Limitations
+The SpeechBrain team does not provide any warranty on the performance achieved by this model when used on other datasets.
+
+# **Citing LTU-AS**
+```bibtex
+@inproceedings{gong_ltuas,
+  title={Joint Audio and Speech Understanding},
+  author={Gong, Yuan and Liu, Alexander H and Luo, Hongyin, and Karlinsky, Leonid and Glass, James},
+  year={2023},
+  booktitle={2023 IEEE Automatic Speech Recognition and Understanding Workshop (ASRU)},
+}
+```
+
+# **Citing SpeechBrain**
+Please, cite SpeechBrain if you use it for your research or business.
+
+```bibtex
+@misc{speechbrain,
+  title={{SpeechBrain}: A General-Purpose Speech Toolkit},
+  author={Mirco Ravanelli and Titouan Parcollet and Peter Plantinga and Aku Rouhe and Samuele Cornell and Loren Lugosch and Cem Subakan and Nauman Dawalatabad and Abdelwahab Heba and Jianyuan Zhong and Ju-Chieh Chou and Sung-Lin Yeh and Szu-Wei Fu and Chien-Feng Liao and Elena Rastorgueva and François Grondin and William Aris and Hwidong Na and Yan Gao and Renato De Mori and Yoshua Bengio},
+  year={2021},
+  eprint={2106.04624},
+  archivePrefix={arXiv},
+  primaryClass={eess.AS},
+  note={arXiv:2106.04624}
+}
+```
+
+# **About SpeechBrain**
+- Website: https://speechbrain.github.io/
+- Code: https://github.com/speechbrain/speechbrain/
 - HuggingFace: https://huggingface.co/speechbrain/