Update README.md

README.md

@@ -5,29 +5,35 @@ tags: []
 
 # Model Card for Model ID
 
-<!-- Provide a quick summary of what the model is/does. -->
+- A speech in, text out model powered by a Phi and Whisper backend
 
+## Acknowledgements
 
+- Developed by Rahul Tarak and Akshaj Jain
+- Special thanks to Karthik, Dong (speechGPT), Yoach (huggingface) for their help
+- Special thanks to Phi, Whisper, Gazelle, Ultravox developers
+
+<!--
 
 ## Model Details
 
 ### Model Description
 
-<!-- Provide a longer summary of what this model is. -->
+<!-- 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]
+- **Developed by:** Rahul Tarak, Akshaj Jain
 - **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]
+- **Finetuned from model [optional]:** 
 
 ### Model Sources [optional]
 
-<!-- Provide the basic links for the model. -->
+<!-- Provide the basic links for the model. 
 
 - **Repository:** [More Information Needed]
 - **Paper [optional]:** [More Information Needed]
@@ -35,36 +41,35 @@ This is the model card of a 🤗 transformers model that has been pushed on the
 
 ## 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. -->
+<!-- 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. -->
+<!-- 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 -->
+<!-- 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. -->
+<!-- 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. -->
+<!-- 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. -->
-
+<!-- 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
@@ -77,13 +82,13 @@ Use the code below to get started with the model.
 
 ### 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. -->
+<!-- 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. -->
+<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. 
 
 #### Preprocessing [optional]
 
@@ -92,35 +97,35 @@ Use the code below to get started with the model.
 
 #### 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 -->
+- **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. -->
+<!-- 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. -->
+<!-- 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. -->
+<!-- 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. -->
+<!-- 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. -->
+<!-- These are the evaluation metrics being used, ideally with a description of why. 
 
 [More Information Needed]
 
@@ -134,13 +139,13 @@ Use the code below to get started with the model.
 
 ## Model Examination [optional]
 
-<!-- Relevant interpretability work for the model goes here -->
+<!-- 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 -->
+<!-- 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).
 
@@ -170,7 +175,7 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
 
 ## 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. -->
+<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. 
 
 **BibTeX:**
 
@@ -182,7 +187,7 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
 
 ## Glossary [optional]
 
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
+<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. 
 
 [More Information Needed]
 
@@ -196,4 +201,4 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
 
 ## Model Card Contact
 
-[More Information Needed]
+[More Information Needed] -->