Update README.md

README.md

@@ -35,17 +35,6 @@ The goal of this model is to improve the quality and efficiency of code generati
 - **Repository:** [mistralai/Mistral-7B-v0.1](https://huggingface.co/mistralai/Mistral-7B-v0.1}{mistralai/Mistral-7B-v0.1)
 - **Paper:** [Mistral-7B](https://arxiv.org/abs/2310.06825)
 
-## How to Get Started with the Model
-
-Use the code below to get started with the model.
-
-```python
-from transformers import AutoTokenizer, AutoModelForCausalLM
-
-tokenizer = AutoTokenizer.from_pretrained('mistralai/Mistral-7B-v0.1')
-model = AutoModelForCausalLM.from_pretrained('aswain4/custom_coding_LLM', device_map='auto', torch_dtype=torch.bfloat16)
-```
-
 ## 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. -->
@@ -74,6 +63,131 @@ The model was trained on a dataset that is predominantly Python code; therefore,
 
 Users (both direct and downstream) should be made aware of the risks and limitations of the model. Please read the above section before using this model.
 
+## How to Get Started with the Model
+
+Use the code below to get started with the model.
+
+```python
+from transformers import AutoTokenizer, AutoModelForCausalLM
+
+tokenizer = AutoTokenizer.from_pretrained('mistralai/Mistral-7B-v0.1')
+model = AutoModelForCausalLM.from_pretrained('aswain4/custom_coding_LLM', device_map='auto', torch_dtype=torch.bfloat16)
+```
+
+### Input Formats
+
+Formatting the prompt similarly to the training data will yield the best results. This means creating the prompt in a Program of Thought (PoT) technique. However, simply asking the question will yield quality output.
+
+PoT prompt:
+```python
+prompt = (
+    "Instruct: Plan:\n"
+    "1. Analyze the following question: \"Write a Python function to check if a number is a palindrome.\"\n"
+    "2. Think step by step and plan a clear, efficient solution before writing code.\n"
+    "3. Consider any necessary programming constructs or tools.\n"
+    "4. Explain your approach, then write well-organized and well-documented code with in-line comments.\n\n"
+    "Response:"
+)
+
+input_ids = tokenizer(prompt, return_tensors="pt").to(model.device)
+
+#generate text
+outputs = model.generate(
+    **input_ids,
+    max_new_tokens=300,
+    temperature=0.7,
+    top_p=0.95,
+    do_sample=True,
+    pad_token_id=tokenizer.pad_token_id
+)
+
+#decode and print
+generated_text = tokenizer.decode(outputs[0], skip_special_tokens=True)
+print(generated_text)
+```
+
+Question only prompt:
+```python
+prompt = "Write a Python function to check if a number is a palindrome."
+
+input_ids = tokenizer(prompt, return_tensors="pt").to(model.device)
+
+#generate text
+outputs = model.generate(
+    **input_ids,
+    max_new_tokens=300,
+    temperature=0.7,
+    top_p=0.95,
+    do_sample=True,
+    pad_token_id=tokenizer.pad_token_id
+)
+
+#decode and print
+generated_text = tokenizer.decode(outputs[0], skip_special_tokens=True)
+print(generated_text)
+```
+
+### Expected Outputs
+
+If the PoT prompting approach is used, users should expect the output to yield a response stating it can perform the task, followed by the generated code, and then an explanation of what is happening in the code. If the question-only prompting approach is used, the output is expected to yield the generated code followed by an explanation of what is happening in the code.
+
+PoT output:
+```text
+Sure! Here's an example of a Python function that checks if a number is a palindrome:
+
+def is_palindrome(num):
+    str_num = str(num)
+    if str_num == str_num[::-1]:
+        return True
+    else:
+        return False
+
+num = 12321
+result = is_palindrome(num)
+print(result)
+
+The function `is_palindrome` takes a number as input and converts it into a string using the `str()` function. It then checks if the string is equal to its reversed version (`str_num[::-1]`). If they are equal, it means the number is a palindrome and the function returns `True`. Otherwise, it returns `False`.
+
+In the example code, we test the function with the number `12321`. The function call `is_palindrome(num)` returns `True` because `12321` is a palindrome. Finally, the result is printed to the console.
+
+I hope this helps! Let me know if you have any further questions.
+```
+
+Question only output:
+```text
+def is_palindrome(n):
+    # convert the number to string
+    n = str(n)
+
+    # check if the string is equal to its reverse
+    if n == n[::-1]:
+        return True
+    else:
+        return False
+
+
+print(is_palindrome(12321))
+
+
+# Output:
+# True
+
+
+# Explanation:
+# The function is_palindrome takes a number as input and converts it to a string.
+# It then checks if the string is equal to its reverse.
+# If the string is equal to its reverse, the function returns True, indicating that the number is a palindrome.
+# Otherwise, it returns False.
+# In the given example, the number 12321 is a palindrome, so the function returns True.
+```
+
+The function `is_palindrome` takes a number as input and converts it into a string using the `str()` function. It then checks if the string is equal to its reversed version (`str_num[::-1]`). If they are equal, it means the number is a palindrome and the function returns `True`. Otherwise, it returns `False`.
+
+In the example code, we test the function with the number `12321`. The function call `is_palindrome(num)` returns `True` because `12321` is a palindrome. Finally, the result is printed to the console.
+
+I hope this helps! Let me know if you have any further questions.
+```
+
 ## Training Details
 
 ### Training Data