NhutP
/

ViWhisper-tiny

@@ -1,199 +1,78 @@
 ---
 library_name: transformers
-tags: []
 ---
-# Model Card for Model ID
-<!-- Provide a quick summary of what the model is/does. -->
-## Model Details
-### Model Description
-<!-- Provide a longer summary of what this model is. -->
-This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
-- **Developed by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
-### Model Sources [optional]
-<!-- Provide the basic links for the model. -->
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
-## Uses
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
-### Direct Use
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
-[More Information Needed]
-### Downstream Use [optional]
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
-[More Information Needed]
-### Out-of-Scope Use
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-[More Information Needed]
-## Bias, Risks, and Limitations
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-[More Information Needed]
-### Recommendations
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
-## How to Get Started with the Model
-Use the code below to get started with the model.
-[More Information Needed]
-## Training Details
-### Training Data
-<!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
-[More Information Needed]
-### Training Procedure
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
-#### Preprocessing [optional]
-[More Information Needed]
-#### Training Hyperparameters
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
-#### Speeds, Sizes, Times [optional]
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
-[More Information Needed]
-## Evaluation
-<!-- This section describes the evaluation protocols and provides the results. -->
-### Testing Data, Factors & Metrics
-#### Testing Data
-<!-- This should link to a Dataset Card if possible. -->
-[More Information Needed]
-#### Factors
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
-[More Information Needed]
-#### Metrics
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
-[More Information Needed]
-### Results
-[More Information Needed]
-#### Summary
-## Model Examination [optional]
-<!-- Relevant interpretability work for the model goes here -->
-[More Information Needed]
-## Environmental Impact
-<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
-Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
-- **Hardware Type:** [More Information Needed]
-- **Hours used:** [More Information Needed]
-- **Cloud Provider:** [More Information Needed]
-- **Compute Region:** [More Information Needed]
-- **Carbon Emitted:** [More Information Needed]
-## Technical Specifications [optional]
-### Model Architecture and Objective
-[More Information Needed]
-### Compute Infrastructure
-[More Information Needed]
-#### Hardware
-[More Information Needed]
-#### Software
-[More Information Needed]
-## Citation [optional]
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
-**BibTeX:**
-[More Information Needed]
-**APA:**
-[More Information Needed]
-## Glossary [optional]
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
-[More Information Needed]
-## More Information [optional]
-[More Information Needed]
-## Model Card Authors [optional]
-[More Information Needed]
-## Model Card Contact
-[More Information Needed]

 ---
 library_name: transformers
+license: mit
+datasets:
+- NhutP/VSV-1100
+- mozilla-foundation/common_voice_14_0
+- AILAB-VNUHCM/vivos
+language:
+- vi
+metrics:
+- wer
+base_model:
+- openai/whisper-tiny
 ---
+## Introduction
+- We release a new model for Vietnamese speech regconition task.
+- We fine-tuned [openai/whisper-tiny(https://huggingface.co/openai/whisper-tiny) on our new dataset [VSV-1100](https://huggingface.co/datasets/NhutP/VSV-1100).
+## Training data
+| [VSV-1100](https://huggingface.co/datasets/NhutP/VSV-1100) | T2S* | [CMV14-vi](https://huggingface.co/datasets/mozilla-foundation/common_voice_14_0) |[VIVOS](https://huggingface.co/datasets/AILAB-VNUHCM/vivos)| [VLSP2021](https://vlsp.org.vn/index.php/resources) | Total|
+|:----------:|:----------:|:----------:|:----------:|:----------:|:----------:|
+|   1100 hours  |   11  hours |   3.04 hours  |    13.94  hours| 180 hours | 1308 hours |
+\* We use a text-to-speech model to generate sentences containing words that do not appear in our dataset.
+## WER result
+| [CMV14-vi](https://huggingface.co/datasets/mozilla-foundation/common_voice_14_0) | [VIVOS](https://huggingface.co/datasets/AILAB-VNUHCM/vivos) | [VLSP2020-T1](https://vlsp.org.vn/index.php/resources) | [VLSP2020-T2](https://vlsp.org.vn/index.php/resources) | [VLSP2021-T1](https://vlsp.org.vn/index.php/resources) | [VLSP2021-T2](https://vlsp.org.vn/index.php/resources) |[Bud500](https://huggingface.co/datasets/linhtran92/viet_bud500) |
+|:----------:|:----------:|:----------:|:----------:|:----------:|:----------:|:----------:|
+|16.3|9.43|17.44|50.35| 20.15 | 13.86 | 7.86 |
+## Usage
+### Inference
+```python
+from transformers import WhisperProcessor, WhisperForConditionalGeneration
+import librosa
+# load model and processor
+processor = WhisperProcessor.from_pretrained("NhutP/ViWhisper-tiny")
+model = WhisperForConditionalGeneration.from_pretrained("NhutP/ViWhisper-tiny")
+model.config.forced_decoder_ids = None
+# load a sample
+array, sampling_rate = librosa.load('path_to_audio', sr = 16000) # Load some audio sample
+input_features = processor(array, sampling_rate=sampling_rate, return_tensors="pt").input_features
+# generate token ids
+predicted_ids = model.generate(input_features)
+# decode token ids to text
+transcription = processor.batch_decode(predicted_ids, skip_special_tokens=True)
+```
+### Use with pipeline
+```python
+from transformers import pipeline
+pipe = pipeline(
+    "automatic-speech-recognition",
+    model="NhutP/ViWhisper-tiny",
+    max_new_tokens=128,
+    chunk_length_s=30,
+    return_timestamps=False,
+    device= '...' # 'cpu' or 'cuda'
+)
+output = pipe(path_to_audio_samplingrate_16000)['text']
+```
+## Citation
+```
+@misc{VSV-1100,
+    author = {Pham Quang Nhut and Duong Pham Hoang Anh and Nguyen Vinh Tiep},
+    title = {VSV-1100: Vietnamese social voice dataset},
+    url = {https://github.com/NhutP/VSV-1100},
+    year = {2024}
+}
+```
+Also, please give us a star on github: https://github.com/NhutP/ViWhisper if you find our project useful
+Contact me at: 22521061@gm.uit.edu.vn (Pham Quang Nhut)