Update README.md

README.md

@@ -9,16 +9,13 @@ tags:
 ---
 # Llama-3-8B-RAG-v1
 
-This model is a fine-tuned version of Llama-3-8B for Retrieval-Augmented Generation (RAG) tasks.
+This model is a fine-tuned version of Llama-3-8B for Retrieval-Augmented Generation (RAG) tasks on the Glaive-RAG-v1 dataset.
 
 ## Model Details
 
-* **Developed by:** GlaiveAI
+* **Developed by:** (Glaive)[https://glaive.ai]
 * **Model type:** Llama-3 finetuned for RAG tasks
 
-## Uses
-
-This model is designed for RAG tasks, where it can answer questions based on provided documents.
 
 ## How to Get Started with the Model
 
@@ -37,13 +34,13 @@ user_query = """Document:0
 
 Title: Financial Compliance and Company Statements
 
-Text: [Document text...]
+Text: This document provides a detailed overview of the financial compliance measures and statements issued by corporations. It discusses various aspects of financial reporting, the importance of accurate financial disclosures, and the role of chief executive officers in certifying financial documents. The document elaborates on the legal frameworks that govern corporate financial disclosures, including the Securities Exchange Act of 1934, which mandates that public companies must provide periodic reports detailing their financial status. These reports are crucial for investors, regulators, and other stakeholders who rely on them to make informed decisions. The document also highlights the penalties for non-compliance with financial reporting requirements, which can include fines and criminal charges for executives who misreport financial information.
 
 Document:1
 
 Title: Certification of Financial Reports by CEO of Black Knight, Inc.
 
-Text: [Document text...]
+Text: Pursuant to 18 U.S.C. §1350, the Chief Executive Officer of Black Knight, Inc., a corporation registered in Delaware, has officially certified the periodic financial report containing the company's financial statements. The certification confirms that these reports comply fully with the requirements of Section 13(a) or 15(d) of the Securities Exchange Act of 1934. The CEO, Anthony M. Jabbour, asserts that the information contained within these reports fairly presents, in all material respects, the financial condition and results of operations of Black Knight, Inc. The certification is part of the official documents filed with the Securities and Exchange Commission and serves as a testament to the accuracy and fairness of the financial disclosures made by the company. This certification is crucial as it assures stakeholders of the reliability of the financial statements provided by Black Knight, Inc.
 
 Answer Mode: Grounded
 
@@ -75,7 +72,7 @@ print(output[0]['generated_text'])
 
 ## Output of above code block
 ```
-CopyCited Documents: 1
+Cited Documents: 1
 Answer: <co:1>The CEO of Black Knight, Inc., Anthony M. Jabbour, ensures compliance with the Securities Exchange Act of 1934 by certifying that the periodic financial report and financial statements comply fully with the requirements of Section 13(a) or 15(d) of the Act. This certification confirms that the information in the reports fairly presents, in all material respects, the financial condition and results of operations of Black Knight, Inc.</co> This certification is crucial as it assures stakeholders of the reliability of the financial statements provided by the company, thereby maintaining investor confidence and adherence to legal financial reporting standards.
 In this output:
 
@@ -85,11 +82,19 @@ The answer explains how the CEO ensures compliance and the implications of the c
 The citation is marked with <co:1></co> tags, indicating that this information comes directly from Document 1.
 ```
 
-## Code Explanation
-The code is split into two main parts:
+## Answer mode and citations
+
+The model can be instructed to answer only using grounded information from the documents, or to combine it's internal knowledge as well by using Answer Mode: Grounded/Mixed in the user prompt.
+
+Citations are generated at the beginning of each answer, and also present within the text in <co: doc_id> </co> blocks.
+
+
+## Future work
+
+We are working on the following improvements for the next version of the dataset:
 
-1. Chat Template Preparation: We create a chat list with a system message and a user query. The apply_chat_template method is used to format this chat into a prompt suitable for the model.
-2. Pipeline Setup and Generation: We set up a text-generation pipeline with our model and tokenizer. The prepared prompt is passed to the pipeline to generate a response.
+- Multi turn data
+- Diverse document sources