Update README.md

README.md

@@ -1,201 +1,236 @@
 ---
-license: other
-language:
-- hi
-library_name: adapter-transformers
-tags:
-- code
----
-# Model Card for Model ID
-
-The model is a single shot Instruct tuned model in Hindi and dialects
-
-This modelcard aims to be a base template for new models. It has been generated using [this raw template](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/modelcard_template.md?plain=1).
-
-## Model Details
-
-### Model Description
+# Model Card for Indus
+
+<!-- Provide a quick summary of what the model is/does. [Optional] -->
+The model is a single shot fine tuned Instruct LLM in Hindi and dialects
+
+
+
+
+#  Table of Contents
+
+- [Model Card for Indus](#model-card-for--model_id-)
+- [Table of Contents](#table-of-contents)
+- [Table of Contents](#table-of-contents-1)
+- [Model Details](#model-details)
+  - [Model Description](#model-description)
+- [Uses](#uses)
+  - [Direct Use](#direct-use)
+  - [Downstream Use [Optional]](#downstream-use-optional)
+  - [Out-of-Scope Use](#out-of-scope-use)
+- [Bias, Risks, and Limitations](#bias-risks-and-limitations)
+  - [Recommendations](#recommendations)
+- [Training Details](#training-details)
+  - [Training Data](#training-data)
+  - [Training Procedure](#training-procedure)
+    - [Preprocessing](#preprocessing)
+    - [Speeds, Sizes, Times](#speeds-sizes-times)
+- [Evaluation](#evaluation)
+  - [Testing Data, Factors & Metrics](#testing-data-factors--metrics)
+    - [Testing Data](#testing-data)
+    - [Factors](#factors)
+    - [Metrics](#metrics)
+  - [Results](#results)
+- [Model Examination](#model-examination)
+- [Environmental Impact](#environmental-impact)
+- [Technical Specifications [optional]](#technical-specifications-optional)
+  - [Model Architecture and Objective](#model-architecture-and-objective)
+  - [Compute Infrastructure](#compute-infrastructure)
+    - [Hardware](#hardware)
+    - [Software](#software)
+- [Citation](#citation)
+- [Glossary [optional]](#glossary-optional)
+- [More Information [optional]](#more-information-optional)
+- [Model Card Authors [optional]](#model-card-authors-optional)
+- [Model Card Contact](#model-card-contact)
+- [How to Get Started with the Model](#how-to-get-started-with-the-model)
+
+
+# Model Details
+
+## Model Description
+
+<!-- Provide a longer summary of what this model is/does. -->
+The model is a single shot fine tuned Instruct LLM in Hindi and dialects
+
+- **Developed by:** More information needed
+- **Shared by [Optional]:** More information needed
+- **Model type:** Language model
+- **Language(s) (NLP):** hin, bho, mai, doi
+- **License:** other
+- **Parent Model:** More information needed
+- **Resources for more information:** More information needed
+
+
+
+# Uses
 
-<!-- Provide a longer summary of what this model is. -->
-
-
-- **Developed by:** Makers Lab 
-- **Funded by [optional]:** NA
-- **Shared by [optional]:** Nikhil Malhotra
-- **Model type:** Foundational Instruct tuned model
-- **Language(s) (NLP):** Hindi, Bhojpuri, Maithili, Angika
-- **License:** Open
-- **Finetuned from model [optional]:** None
-
-### Model Sources [optional]
+<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
 
-<!-- Provide the basic links for the model. -->
+## Direct Use
 
-- **Repository:** NA
+<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
+<!-- If the user enters content, print that. If not, but they enter a task in the list, use that. If neither, say "more info 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. -->
-Used for Q and A
 
-### Direct Use
+## Downstream Use [Optional]
 
-<!-- This section is for the model use without fine-tuning or plugging 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 -->
+<!-- If the user enters content, print that. If not, but they enter a task in the list, use that. If neither, say "more info needed." -->
+ 
 
-[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 -->
+## Out-of-Scope Use
 
-[More Information Needed]
+<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
+<!-- If the user enters content, print that. If not, but they enter a task in the list, use that. If neither, say "more info 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
+# Bias, Risks, and Limitations
 
 <!-- This section is meant to convey both technical and sociotechnical limitations. -->
 
-[More Information Needed]
+Significant research has explored bias and fairness issues with language models (see, e.g., [Sheng et al. (2021)](https://aclanthology.org/2021.acl-long.330.pdf) and [Bender et al. (2021)](https://dl.acm.org/doi/pdf/10.1145/3442188.3445922)). Predictions generated by the model may include disturbing and harmful stereotypes across protected classes; identity characteristics; and sensitive, social, and occupational groups.
 
-### 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.
+## Recommendations
 
-## How to Get Started with the Model
+<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
 
-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. -->
+# Training Details
 
-[More Information Needed]
+## Training Data
 
-### Training Procedure
+<!-- This should link to a Data 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 relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
+More information on training data needed
 
-#### Preprocessing [optional]
 
-[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. -->
 
-#### Training Hyperparameters
+### Preprocessing
 
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
+More information needed
 
-#### Speeds, Sizes, Times [optional]
+### Speeds, Sizes, Times
 
 <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
 
-[More Information Needed]
-
-## Evaluation
+More information needed
+ 
+# Evaluation
 
 <!-- This section describes the evaluation protocols and provides the results. -->
 
-### Testing Data, Factors & Metrics
+## Testing Data, Factors & Metrics
 
-#### Testing Data
+### Testing Data
 
-<!-- This should link to a Dataset Card if possible. -->
+<!-- This should link to a Data Card if possible. -->
 
-[More Information Needed]
+More information needed
 
-#### Factors
+
+### Factors
 
 <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
 
-[More Information Needed]
+More information needed
 
-#### Metrics
+### Metrics
 
 <!-- These are the evaluation metrics being used, ideally with a description of why. -->
 
-[More Information Needed]
-
-### Results
-
-[More Information Needed]
-
-#### Summary
+More information needed
 
+## Results 
 
+More information needed
 
-## Model Examination [optional]
+# Model Examination
 
-<!-- Relevant interpretability work for the model goes here -->
+More information needed
 
-[More Information Needed]
-
-## Environmental Impact
+# 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]
+- **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]
+# Technical Specifications [optional]
 
-### Model Architecture and Objective
+## Model Architecture and Objective
 
-[More Information Needed]
+More information needed
 
-### Compute Infrastructure
+## Compute Infrastructure
 
-[More Information Needed]
+More information needed
 
-#### Hardware
+### Hardware
 
-[More Information Needed]
+More information needed
 
-#### Software
+### Software
 
-[More Information Needed]
+More information needed
 
-## Citation [optional]
+# Citation
 
 <!-- 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]
+More information needed
 
 **APA:**
 
-[More Information Needed]
+More information needed
 
-## Glossary [optional]
+# 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 needed
+
+# More Information [optional]
+
+More information needed
+
+# Model Card Authors [optional]
 
-## More Information [optional]
+<!-- This section provides another layer of transparency and accountability. Whose views is this model card representing? How many voices were included in its construction? Etc. -->
 
-[More Information Needed]
+Nikhil Malhotra, Nilesh Brahme, Vinay Sharma, Satish Mishra
 
-## Model Card Authors [optional]
+# Model Card Contact
+
+More information needed
+
+# How to Get Started with the Model
+
+Use the code below to get started with the model.
 
-[More Information Needed]
+<details>
+<summary> Click to expand </summary>
 
-## Model Card Contact
+More information needed
 
-[More Information Needed]
+</details>