Update README.md

README.md

@@ -9,5 +9,52 @@ app_file: app.py
 pinned: false
 license: cc-by-4.0
 ---
+# Project Title: Diabetes Assistant
+
+## Objective
+The objective of this project was to showcase our individual learnings about large language models, translation application, chatbot, gradio and hugging face.
+
+## Sources
+- ChatGPT
+- Copilot
+- Hugging Face
+- Gradio
+- OpenAI Whisper (https://openai.com/research/whisper)
+
+## Method
+
+L3-AI Created an assistant to ask your diabetes questions and when needed translate responses to an alternate language.
+   
+1. <b>Transcription:</b> Individuals could either voice their questions by hitting the microphone, upload an mp3 of their question, or write their diabetes
+   related questions within the Hugging Face Application.  For questions that were either voice activated or mp3 uploaded we used <i>openai/whisper-large</i> to
+   transcribe the audio into written format.
+
+2. <b>LLM Model:</b> Using <i>WikipediaLoader</i>, we created a large language model that tapped into Wikipedia specifically grabbing information related to the diabetes
+   question.
+
+3. <b>Chatbot Response and Voice Over:</b> L3-AI added a feature that allowed our Hugging Face Application to verbalize the response from the LLM as well as provide responses in
+   written format.  We used <i>gTTS</i>, to provide written text to speech. 
+
+4. <b>Translation:</b> <i>Helsinki-NLP</i> was used to translate the information provided from the LLM. 
+
+5. <b>Gradio:</b> L3-AI used the gradio application to organize and produce each level and response of the four different models utilized. 
+   
+6. <b>Hugging Face:</b> Finally, L3-AI pushed all information to Hugging Face Application for speed as well as production. 
+
+
+## Interface
+
+https://huggingface.co/spaces/L3-AI/diabetes_assistant
+
+![image/png](https://cdn-uploads.huggingface.co/production/uploads/6604cd9fda664781b225e0b6/jP1tHn0iF6NVWChSTxcr9.png)
+
+## Learnings
+Throughout this project we learned how to embed a chatbot function that called four different models and put into production our application in Hugging Face.
+
+## Opportunities and Next Steps 
+For L3-AI concept design we centered on diabetes however, we thought in future endeavors expanding to other disease states would enhance the work that was started. 
+
+
+## Credits
+We would like to thank our pets who kept us company as we worked on coding and this application.  
 
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference