Update README.md

README.md

@@ -11,3 +11,52 @@ license: apache-2.0
 ---
 
 Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+
+# AI-Assistant-Chatbot🚀
+Building an AI is everyone's dream right? It is very simple to make your own AI chatbot using falcon 7b-instruct llm in hugging face and framing it as a chatbot using LangChain library and making it as an application to use.
+
+## Resources Used in the Projects🌟
+  *  **Falcon** as LLM
+  *  **Langchain** as framework for LLM
+  *  **Falcon-Model** from HuggingFace
+  *  **Gradio** for deploying the application with interface
+
+## Steps Involved are🌟
+  *  First integrate the model and run the model in notebooks or in local IDE without any errors
+  *  Create an Interface for the model using **Gradio**
+  *  Create a repository in the Hugging Face Spaces
+  *  Add app.py file and requirements.txt file into the repository
+  *  Now the model is deployed in the HuggingFace Repository Space and ready to use anytime
+
+## System Requirement🌟
+  *  You must have Python 3.10 or later installed or use google colab for testing the model.
+  *  You must have Hugging Face Account
+
+## File Description🌟
+  *  **app.py** - The file contains the entire source code to deploy which is used in Hugging Face Repository for deployment
+  *  **requirements.txt** - This file contains all the names of the packages needed to be installed in the environment
+  *  **chatbot-falcon.ipynb** - It a colab notebook file which has the entire source should have to run in your colab for testing
+  *  **gradio.txt** - The context about gradio framework
+  *  **langchain.txt** - The context about langchain framework
+  *  **huggingface.txt** - The context about Hugging Face Platform
+
+# Steps to Create Repository in Hugging Face and Deploy the model
+
+## Creating Hugging Face Repository
+  1. Goto Hugging Face Website - https://huggingface.co/
+  2. Click the **+New** icon below the Hugging Face logo
+  3. Then click on Spaces
+  4. Enter your Repo name, type of license being used, type of SDK used (in ou case, it is Gradio)
+  5. Now set as public or private and click on create Space
+
+## Adding files to Repository
+  1. Now inside repository, click on Files and click on Add file at right upper middle of screen
+  2. Click Upload File and upload the app.py and requirements.txt files to the repo
+  3. Now it shows **Building** once **Running** note comes click on to the **APP** window and start using your Application
+
+
+# Disclaimer❗
+Here the content are open source but owned by some organizations and they have some terms & conditions for usage of their models. Do not use for Commercial purpose, it is meant for Research and learning. Do not Misuse any of the data or resources provided in the repository. Repository or author are not responsible for illegal use of resources.
+
+~ Content by Abishek
+