Create README.md

README.md

@@ -0,0 +1,97 @@
+---
+datasets:
+- homebrewltd/instruction-speech-whispervq-v2
+language:
+- en
+- vi
+license: apache-2.0
+tags:
+- sound language model
+- audio-text-to-text
+- torchtune
+- whisperspeech
+---
+
+![image/png](https://cdn-uploads.huggingface.co/production/uploads/630a5ef0e81e1dea2cedcec0/GCl7IYZaL1NebkdEEyhab.png)
+
+
+## Ichigo Whisper
+
+Ichigo Whisper is a compact (22M parameters), open-source quantizer for the `Whisper-medium model`, designed to enhance performance on *low-resource languages* with minimal impact on its original English capabilities. Unlike models that output continuous embeddings, Ichigo Whisper compresses speech into discrete tokens, making it more compatible with large language models (LLMs) for immediate speech understanding.
+
+This quantized version of Whisper-medium has been trained on over XXX hours of English data and XXX hours of Vietnamese data.
+
+Ichigo Whisper is a key component of the Ichigo v0.5 family.
+
+For more details, please refer to our official [blog post].
+
+### Model Summary
+
+**Developed by:** Homebrew Research.
+
+**Model Architecture:** WhisperVQ
+
+**Model type:** Quantizer of Whisper
+
+**Language(s):** English and Vietnamese
+
+**License:** Apache 2.0
+
+### Resources
+
+**Demo:** [Ichigo Whisper demo]
+
+**Blog:** [Blog post]
+
+## Intended Use
+
+**Intended Use Cases** This model is primarily intended for research applications. This version aims to further improve the Whisper on sound low-resource languages.
+
+**Out-of-scope** The use of Ichigo Whisper in any manner that violates applicable laws or regulations is strictly prohibited.
+
+## How to Get Started
+
+You can use given example code to load the model.
+
+```{python}
+
+```
+
+## Evaluation
+
+1. Vietnamese
+
+| Model Name | Codebook Size | Dataset test | Language Test | Test samples | WER |
+|------------|---------------|--------------|---------------|--------------|-----|
+| **IchigoWhisper** | 2561 | viVoice | Vi | 1000 | **11.36** |
+| Whisper Medium | - | viVoice | Vi | 1000 | 18.64 |
+
+2. English
+
+| Model Name | Codebook Size | Dataset test | Test samples | WER |
+|------------|---------------|--------------|--------------|-----|
+| **IchigoWhisper** | 2561 | LibriTTS-R | 1000 | **12.96** |
+| Whisper Medium | - | LibriTTS-R | 1000 | 12.99 |
+
+## Citation Information
+
+**BibTeX:**
+
+```
+@article{IchigoWhisper 2024,
+  title={IchigoWhisper},
+  author={Homebrew Research},
+  year=2024,
+  month=December},
+  url={https://huggingface.co/homebrewltd/Ichigo-whisper}
+```
+
+## Acknowledgement
+
+- **[WhisperSpeech](https://github.com/collabora/WhisperSpeech)**
+
+- **[Whisper](https://huggingface.co/meta-llama/Meta-Llama-3.1-8B-Instruct)**
+
+- **[Vivoice](https://huggingface.co/datasets/capleaf/viVoice)**
+
+- **[LibriTTS]**