Upload README.md

README.md

@@ -1,13 +1,28 @@
----
-title: Native Chatbot
-emoji: ⚡
-colorFrom: blue
-colorTo: pink
-sdk: streamlit
-sdk_version: 1.37.1
-app_file: app.py
-pinned: false
-license: apache-2.0
----
-
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+# Native Chatbot
+
+<p>
+This LLM-powered chatbot was created by Langchain. It acts like a native teacher who can guide you to write and talk like a native speaker.<br/>
+
+**The supported LLMs:**<br/>
+- llama-3.1-405b-instruct (meta)
+- gemma-2-27b-it (google)
+- mistral-nemo-12b-instruct (nv-mistralai)
+- nemotron-4-340b-instruct (nvidia)
+- phi-3-medium-128k-instruct (microsoft)
+- arctic (snowflake)
+
+</p>
+
+# Usage
+1. To use <a href="https://huggingface.co/spaces/amirhoseinsedaghati/Native_Chatbot">the online version on HuggingFace</a>, just select your desired LLM, pass your question into the text area, and click on <b>Generate Answer</b>.
+<br></br>
+2. To use it on your local machine, clone the project from <a href="https://github.com/amirho3einsedaghati/Native_Chatbot">this URL GitHub</a> using <pre>git clone git@github.com:amirho3einsedaghati/Native_Chatbot.git</pre> fill in the .env file in the tools directory with the <a href="https://build.nvidia.com/explore/discover">NVIDIA API KEY</a>, then navigate to the Native_Chatbot directory which contains the main.py file and run the Streamlit application using the following command. <pre>streamlit run main.py</pre>
+
+# License
+<a href="https://huggingface.co/spaces/amirhoseinsedaghati/Native_Chatbot/blob/main/LICENSE">Apache-2.0</a>
+
+# Appendix:
+<a href="https://github.com/amirho3einsedaghati/Native_Chatbot">https://github.com/amirho3einsedaghati/Native_Chatbot</a>
+
+# Maintainer Contact:
+<a href="https://linktr.ee/amirhoseinsedaghati">https://linktr.ee/amirhoseinsedaghati</a>