Update README.md

README.md

@@ -7,7 +7,7 @@ tags: []
 
 <!-- Provide a quick summary of what the model is/does. -->
 
-
+This is a version of StarCoder model that was fine-tuned on the grammatically corrected texts.  
 
 ## Model Details
 
@@ -15,152 +15,162 @@ tags: []
 
 <!-- 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 type:** GPT-2
+- **Number of Parameters:** 15.5B
+- **Supported Programming Language:** Python
+- **Finetuned from model:** StarCoder
 
 ### Model Sources [optional]
 
 <!-- Provide the basic links for the model. -->
 
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
+- **Repository:** [GitHub Repo](https://github.com/IU-AES-AI4Code/CodeQuestionAnswering)
+- **Paper:** "Leveraging Large Language Models in Code Question Answering: Baselines and Issues" Georgy Andryushchenko, Vladimir V. Ivanov, Vladimir Makharev, Elizaveta Tukhtina, Aidar Valeev
+<!-- - **Demo [optional]:** [More Information Needed] -->
 
-## Uses
+<!-- ## 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
+<!-- ### Direct Use -->
 
 <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
 
-[More Information Needed]
+<!-- [More Information Needed] -->
 
-### Downstream Use [optional]
+<!-- ### 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]
+<!-- [More Information Needed] -->
 
-### Out-of-Scope Use
+<!-- ### Out-of-Scope Use -->
 
 <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
 
-[More Information Needed]
+<!-- [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]
+<!-- [More Information Needed] -->
 
-### Recommendations
+<!-- ### 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.
+<!-- 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.
+```python
+import torch
+from transformers import AutoModelForCausalLM, AutoTokenizer
 
-[More Information Needed]
+tokenizer = AutoTokenizer.from_pretrained('datapaf/StarCoderCodeQnA')
+model = AutoModelForCausalLM.from_pretrained(checkpoint, device_map="cuda")
+
+code = ... # Your Python code snippet here
+question = ... # Your question regarding the snippet here
+
+prompt_template = "Question: {question}\n\nCode: {code}\n\nAnswer:"
+prompt = prompt_template.format(question=ex['question'], code=ex['code'])
 
-## Training Details
+inputs = tokenizer.encode(prompt, return_tensors="pt").to('cuda')
+outputs = model.generate(inputs, max_new_tokens=512, pad_token_id=tokenizer.eos_token_id)
+text = tokenizer.decode(outputs[0])
+print(text)
+```
 
-### Training Data
+<!-- ## 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]
+<!-- [More Information Needed] -->
 
-### Training Procedure
+<!-- ### 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]
+<!-- #### Preprocessing [optional] -->
 
-[More Information Needed]
+<!-- [More Information Needed] -->
 
 
-#### Training Hyperparameters
+<!-- #### 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]
+<!-- #### Speeds, Sizes, Times [optional] -->
 
 <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
 
-[More Information Needed]
+<!-- [More Information Needed] -->
 
-## Evaluation
+<!-- ## 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. -->
 
-[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]
+<!-- [More Information Needed] -->
 
-### Results
+<!-- ### Results -->
 
-[More Information Needed]
+<!-- [More Information Needed] -->
 
-#### Summary
+<!-- #### Summary -->
 
 
 
-## Model Examination [optional]
+<!-- ## Model Examination [optional] -->
 
 <!-- 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).
+<!-- 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]
 
@@ -168,11 +178,11 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
 
 [More Information Needed]
 
-## Citation [optional]
+## 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:**
+<!-- **BibTeX:**
 
 [More Information Needed]
 
@@ -180,11 +190,11 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
 
 [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]
 
@@ -196,4 +206,4 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
 
 ## Model Card Contact
 
-[More Information Needed]
+[More Information Needed] -->