Update README.md

README.md

@@ -3,23 +3,23 @@ license: apache-2.0
 inference: false
 ---
 
-# SLIM-Q-GEN-PHI-3  
+# SLIM-QA-GEN-PHI-3  
 
 <!-- Provide a quick summary of what the model is/does. -->
 
-**slim-q-gen-phi-3** implements a specialized function-calling question generation from a context passage, with output in the form of a python dictionary, e.g.,  
+**slim-qa-gen-phi-3** implements a specialized function-calling question and answer generation from a context passage, with output in the form of a python dictionary, e.g.,  
 
-&nbsp;&nbsp;&nbsp;&nbsp;`{'question': ['What were earnings per share in the most recent quarter?'] }  
+&nbsp;&nbsp;&nbsp;&nbsp;`{'question': ['What were earnings per share in the most recent quarter?'], 'answer': ['$2.39'] }  
 
 This model is finetuned on top of phi-3-mini-4k-instruct base.  
 
-For fast inference use, we would recommend the 'quantized tool' version, e.g.,  [**'slim-q-gen-phi-3-tool'**](https://huggingface.co/llmware/slim-q-gen-phi-3-tool).  
+For fast inference use, we would recommend the 'quantized tool' version, e.g.,  [**'slim-qa-gen-phi-3-tool'**](https://huggingface.co/llmware/slim-qa-gen-phi-3-tool).  
 
 
 ## Prompt format:
 
 `function = "generate"`  
-`params = "{'question', 'boolean', or 'multiple choice'}"`  
+`params = "{'question, answer', 'boolean', or 'multiple choice'}"`  
 `prompt = "<human> " + {text} + "\n" + `  
 &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;&nbsp; &nbsp; &nbsp; &nbsp;`"<{function}> " + {params} + "</{function}>" + "\n<bot>:"`  
 
@@ -27,8 +27,8 @@ For fast inference use, we would recommend the 'quantized tool' version, e.g.,
 <details>
 <summary>Transformers Script </summary>
 
-    model = AutoModelForCausalLM.from_pretrained("llmware/slim-q-gen-phi-3")
-    tokenizer = AutoTokenizer.from_pretrained("llmware/slim-q-gen-phi-3")
+    model = AutoModelForCausalLM.from_pretrained("llmware/slim-qa-gen-phi-3")
+    tokenizer = AutoTokenizer.from_pretrained("llmware/slim-qa-gen-phi-3")
 
     function = "generate"
     params = "boolean"
@@ -53,7 +53,7 @@ For fast inference use, we would recommend the 'quantized tool' version, e.g.,
 
     print("output only: ", output_only)  
 
-    [OUTPUT]:  {'llm_response': {'question': ['Did Telsa stock decline more than 8% yesterday?']} }  
+    [OUTPUT]:  {'llm_response': {'question': ['Did Telsa stock decline more than 5% yesterday?'], 'answer':['yes'] } }  
     
     # here's the fun part
     try:
@@ -72,7 +72,7 @@ For fast inference use, we would recommend the 'quantized tool' version, e.g.,
 <summary>Using as Function Call in LLMWare</summary>
 
     from llmware.models import ModelCatalog
-    slim_model = ModelCatalog().load_model("llmware/slim-q-gen-phi-3", sample=True, temperature=0.7)  
+    slim_model = ModelCatalog().load_model("llmware/slim-qa-gen-phi-3", sample=True, temperature=0.5)  
     response = slim_model.function_call(text,params=["boolean"], function="generate")  
 
     print("llmware - llm_response: ", response)