Update README.md

README.md

@@ -12,32 +12,24 @@ short_description: ChatBot using Microsoft's Phi-3-mini-4k-instruct
 
 # ChatBot for Jupyter Notebook
 
-## Table of Contents
-1. Introduction
-2. Getting Started
-3. Usage
-4. Code Documentation
-5. Troubleshooting & FAQ
-6. Contribution Guidelines
-7. Contact Information
-
 ## Introduction
-(Briefly describe your project, its purpose, and its benefits.)
+Welcome to the **Chatbot for Jupyter Notebooks project!** This repository contains an interactive chatbot built using Microsoft's Phi model(Phi-3-mini-4k-instruct), integrated with Jupyter Notebook. The chatbot is designed to assist users by providing relevant answers and insights based on the code and content present in the notebook.
 
-## Getting Started
-(Provide detailed instructions on how to install, configure, and get started with your project. Include any prerequisites, dependencies, and system requirements.)
+The primary goal of this project is to enhance the user experience by enabling an intuitive and efficient way to interact with the notebook's code. 
 
-## Usage
-(Explain how to use your project. Document each feature or command with examples.)
+### Key Features:
+- RAG Framework: Retrieval Augmented Generation Framework has been implemented to get the relevent context related to queries that deals with pointing a particular cell number, or with queries asking follow-up questions with respect to previous responses from the model.
+- Context-Aware Responses: By analyzing the code and content in the notebook, the chatbot provides contextually relevant answers.
 
-## Code Documentation
-(Document your codebase. Explain what each part of your code does.)
+## Usage
+Upload your Jupyter Notebook and start asking questions. Examples for the questions that you can ask for:
+- Explain the code present in 4th cell.
+- Can you summarize the above/previous response
 
-## Troubleshooting & FAQ
-(Include a section for troubleshooting common issues and frequently asked questions.)
+### Few things to remember:
+- Before uploading your notebook, make sure that the output of the cells are cleared, as it can cause errors occasionally.
+- If the notebook has MarkDown cells, it can sometimes disturb the order of the cells that the model gets as context for answering the query,
+  so it's better to avoid MarkDown cells if any.
+- The context has been provided in a way to answer your queries by just pointing out the cell number, But sometimes it might not be accurate to pick up the right cell number.
 
-## Contribution Guidelines
-(If you're open to contributions, provide clear guidelines on how others can contribute.)
 
-## Contact Information
-(Provide contact information for users to reach out for support or for any queries.)