Update README.md

README.md

@@ -1,182 +1,94 @@
 ---
 library_name: transformers
-tags: []
+tags:
+- audio
+- automatic-speech-recognition
+license: mit
+language:
+- ar
 ---
 
-# Model Card for Model ID
+# ArTST (ASR task)
 
-<!-- Provide a quick summary of what the model is/does. -->
+ArTST model finetuned for  automatic speech recognition (speech-to-text) on MGB2. 
 
 
-
-## 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]
+- **Developed by:** Speech Lab, MBZUAI
+- **Model type:** SpeechT5
+- **Language:** Arabic
+- **Finetuned from:** (ArTST pretrained)[https://github.com/mbzuai-nlp/ArTST]
 
-## 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]
-
+```python
+import soundfile as sf
+from transformers import (
+    SpeechT5Config,
+    SpeechT5FeatureExtractor,
+    SpeechT5ForSpeechToText,
+    SpeechT5Processor,
+    SpeechT5Tokenizer,
+)
 
-#### Training Hyperparameters
+from custom_tokenizer import CustomTextTokenizer
 
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
+device = "cuda" if torch.cuda.is_available() else "cpu"
 
-#### Speeds, Sizes, Times [optional]
+tokenizer = SpeechT5Tokenizer.from_pretrained("mbzuai/artst_asr")
+processor = SpeechT5Processor.from_pretrained("mbzuai/artst_asr" , tokenizer=tokenizer)
+model = SpeechT5ForSpeechToText.from_pretrained("mbzuai/artst_asr").to(device)
 
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
+audio, sr = sf.read("audio.wav")
 
-[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. -->
+inputs = processor(audio=audio, sampling_rate=sr, return_tensors="pt")
+predicted_ids = model.generate(**inputs.to(device), max_length=150)
 
-[More Information Needed]
-
-#### Metrics
-
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
-
-[More Information Needed]
+transcription = processor.batch_decode(predicted_ids, skip_special_tokens=True)
+print(transcription[0])
+```
 
-### 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
+### Model Sources [optional]
+- **Repository:** [github](https://github.com/mbzuai-nlp/ArTST)
+- **Paper :** [ArabicNLP2023](https://aclanthology.org/2023.arabicnlp-1.5/)
+<!-- - **Demo [optional]:** [More Information Needed] -->
 
-[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:**
+```
+@inproceedings{toyin-etal-2023-artst,
+    title = "{A}r{TST}: {A}rabic Text and Speech Transformer",
+    author = "Toyin, Hawau  and
+      Djanibekov, Amirbek  and
+      Kulkarni, Ajinkya  and
+      Aldarmaki, Hanan",
+    booktitle = "Proceedings of ArabicNLP 2023",
+    month = dec,
+    year = "2023",
+    address = "Singapore (Hybrid)",
+    publisher = "Association for Computational Linguistics",
+    url = "https://aclanthology.org/2023.arabicnlp-1.5",
+    doi = "10.18653/v1/2023.arabicnlp-1.5",
+    pages = "41--51",
+}
+```
+<!-- **APA:**
 
 [More Information Needed]
 
@@ -184,7 +96,7 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
 
 <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
 
-[More Information Needed]
+<!-- [More Information Needed]
 
 ## More Information [optional]
 
@@ -196,4 +108,4 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
 
 ## Model Card Contact
 
-[More Information Needed]
+[More Information Needed] -->