Update README.md

README.md

@@ -2,5 +2,82 @@
 datasets:
 - iamtarun/python_code_instructions_18k_alpaca
 widget:
-  - text: "Below is an instruction that describes a task. Write a response that appropriately completes the request.\n\n### Instruction:\nCreate a function to calculate the sum of a sequence of integers.\n\n### Input:\n[1, 2, 3, 4, 5]\n\n### Output:\n"
----
+- text: >
+    Below is an instruction that describes a task. Write a response that
+    appropriately completes the request.
+
+
+    ### Instruction:
+
+    Create a function to calculate the sum of a sequence of integers.
+
+
+    ### Input:
+
+    [1, 2, 3, 4, 5]
+
+
+    ### Output:
+pipeline_tag: text-generation
+tags:
+- code
+---
+
+## Model Details
+this is the finetuned version of GPT2 on a coding dataset
+
+### Model Description
+
+- **Model type:** text-generation
+- **Finetuned from model [GPT2](https://huggingface.co/gpt2)**
+
+### Model Sources [optional]
+
+
+- **Repository:** https://huggingface.co/gpt2 
+
+## Uses
+```python
+# Use a pipeline as a high-level helper
+from transformers import pipeline
+
+pipe = pipeline("text-generation", model="not-lain/PyGPT")
+prompt = """
+Below is an instruction that describes a task. Write a response that
+appropriately completes the request.
+
+
+### Instruction:
+
+Create a function to calculate the sum of a sequence of integers.
+
+
+### Input:
+
+[1, 2, 3, 4, 5]
+
+
+### Output:
+"""
+
+pipe(prompt)
+```
+## Bias, Risks, and Limitations
+
+model may produce biased ,erroneous and output.
+
+### Recommendations
+
+it is not advised to use this model as it is just a product of testing a finetuning script
+
+## 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]
+
+## Evaluation
+
+please refer to the tensorboard tab for full details