Update README.md

README.md

@@ -18,7 +18,6 @@ datasets:
 # Model Summary
 <img src="Damysus.png" width="500" alt="Damysus - the fastest giant"/>
 
-
 <!-- Provide a quick summary of what the model is/does. -->
 This model is a instruction-tuned version of Phi-2, a Transformer model with 2.7 billion parameters from Microsoft. 
 The model has undergone further training to better follow specific user instructions, enhancing its ability to perform tasks as directed and improve its interaction with users. 
@@ -39,36 +38,26 @@ This is the model card of a 🤗 transformers model that has been pushed on the
 - **Finetuned from model:** microsoft/phi-2
 
 
-
 ## 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
 
 <!-- This section is for the model use without fine-tuning or plugging 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. -->
-
-[More Information Needed]
-
-## Bias, Risks, and Limitations
+You can use this model to build local/cloud RAG applications.
+It can serve as the:
+- Answer synthesizer,
+- Summarizer
+- Or query rewriter model.
 
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
+### Limitations 
 
-[More Information Needed]
-
-### 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.
+This model inherits some of the base model's limitations, such as:
+- Generate Inaccurate Code and Facts: The model may produce incorrect code snippets and statements. Users should treat these outputs as suggestions or starting points, not as definitive or accurate solutions.
+- Limited Scope for code: Majority of Phi-2 training data is based in Python and use common packages such as "typing, math, random, collections, datetime, itertools". If the model generates Python scripts that utilize other packages or scripts in other languages, we strongly recommend users manually verify all API uses.
+- Language Limitations: The model is primarily designed to understand standard English. Informal English, slang, or any other languages might pose challenges to its comprehension, leading to potential misinterpretations or errors in response.
 
 ## How to Get Started with the Model
 
@@ -83,21 +72,6 @@ output = chatbot(conversation)
 
 print(output)
 ```
-Output:
-```shell
-Conversation id: 5dad71bd-a24a-425a-80aa-95f56924f8c7
-
-user: I'm looking for a movie - what's your favourite one?
-
-assistant:
-  My favorite movie is "The Shawshank Redemption."
-
-  It's a powerful and inspiring story about hope, friendship, and redemption.
-  The performances by Tim Robbins and Morgan Freeman are exceptional,
-  and the film's themes and messages are timeless.
-
-  I highly recommend it to anyone who enjoys a well-crafted and emotionally engaging story.
-```
 
 Or you can instatiate the model and tokenizer directly
 ```python
@@ -108,7 +82,7 @@ model = AutoModelForCausalLM.from_pretrained("prince-canuma/Damysus-2.7B-Chat")
 
 inputs = tokenizer.apply_chat_template(
     [
-        {"content":"","role":"system"},
+        {"content":"You are an helpful AI assistant","role":"system"},
         {"content":"""I'm looking for a movie - what's your favourite one?""","role":"user"},
     ], add_generation_prompt=True, return_tensors="pt",
 ).to("cuda")
@@ -118,6 +92,7 @@ outputs = model.generate(inputs, do_sample=False, max_new_tokens=256)
 input_length = inputs.shape[1]
 print(tokenizer.batch_decode(outputs[:, input_length:], skip_special_tokens=True)[0])
 ```
+
 Output:
 ```shell
 My favorite movie is "The Shawshank Redemption."
@@ -129,8 +104,6 @@ and the film's themes and messages are timeless.
 I highly recommend it to anyone who enjoys a well-crafted and emotionally engaging story.
 ```
 
-
-
 ## Training Details
 
 ### Training Data
@@ -184,12 +157,6 @@ I used [SlimOrca](https://huggingface.co/datasets/Open-Orca/SlimOrca) dataset, a
 
 [TODO]
 
-## Limitations of Phi-2
-This model inherits some of the base model's limitations, such as:
-- Generate Inaccurate Code and Facts: The model may produce incorrect code snippets and statements. Users should treat these outputs as suggestions or starting points, not as definitive or accurate solutions.
-- Limited Scope for code: Majority of Phi-2 training data is based in Python and use common packages such as "typing, math, random, collections, datetime, itertools". If the model generates Python scripts that utilize other packages or scripts in other languages, we strongly recommend users manually verify all API uses.
-- Language Limitations: The model is primarily designed to understand standard English. Informal English, slang, or any other languages might pose challenges to its comprehension, leading to potential misinterpretations or errors in response.
-
 ## Technical Specifications
 
 ### Compute Infrastructure