releasing app to HF space

Dockerfile

@@ -0,0 +1,11 @@
+FROM python:3.9
+RUN useradd -m -u 1000 user
+USER user
+ENV HOME=/home/user \
+    PATH=/home/user/.local/bin:$PATH
+WORKDIR $HOME/app
+COPY --chown=user . $HOME/app
+COPY ./requirements.txt ~/app/requirements.txt
+RUN pip install -r requirements.txt
+COPY . .
+CMD ["chainlit", "run", "app.py", "--port", "7860"]

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Nithin Kamavaram
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,11 +1,189 @@
 ---
-title: Llm App
-emoji: 📚
-colorFrom: red
-colorTo: pink
+title: BeyondChatGPT Demo
+emoji: 📉
+colorFrom: pink
+colorTo: yellow
 sdk: docker
 pinned: false
-license: openrail
 ---
 
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+<p align = "center" draggable=”false” ><img src="https://github.com/AI-Maker-Space/LLM-Dev-101/assets/37101144/d1343317-fa2f-41e1-8af1-1dbb18399719" 
+     width="200px"
+     height="auto"/>
+</p>
+
+
+## <h1 align="center" id="heading">:wave: Welcome to Beyond ChatGPT!!</h1>
+
+For a step-by-step YouTube video walkthrough, watch this! [Deploying Chainlit app on Hugging Face](https://www.youtube.com/live/pRbbZcL0NMI?si=NAYhMZ_suAY84f06&t=2119)
+
+![Beyond ChatGPT: Build Your First LLM Application](https://github.com/AI-Maker-Space/Beyond-ChatGPT/assets/48775140/cb7a74b8-28af-4d12-a008-8f5a51d47b4c)
+
+## 🤖 Your First LLM App
+
+> If you need an introduction to `git`, or information on how to set up API keys for the tools we'll be using in this repository - check out our [Interactive Dev Environment for LLM Development](https://github.com/AI-Maker-Space/Interactive-Dev-Environment-for-LLM-Development/tree/main) which has everything you'd need to get started in this repository!
+
+In this repository, we'll walk you through the steps to create a Large Language Model (LLM) application using Chainlit, then containerize it using Docker, and finally deploy it on Huggingface Spaces.
+
+Are you ready? Let's get started!
+
+<details>
+  <summary>🖥️ Accessing "gpt-3.5-turbo" (ChatGPT) like a developer</summary>
+
+1. Head to [this notebook](https://colab.research.google.com/drive/1mOzbgf4a2SP5qQj33ZxTz2a01-5eXqk2?usp=sharing) and follow along with the instructions!
+
+2. Complete the notebook and try out your own system/assistant messages!
+
+That's it! Head to the next step and start building your application!
+
+</details>
+
+
+<details>
+  <summary>🏗️ Building Your First LLM App</summary>
+
+1. Clone [this](https://github.com/AI-Maker-Space/Beyond-ChatGPT/tree/main) repo.
+
+     ``` bash
+     git clone https://github.com/AI-Maker-Space/Beyond-ChatGPT.git
+     ```
+
+2. Navigate inside this repo
+     ``` bash
+     cd Beyond-ChatGPT
+     ```
+
+3. Install the packages required for this python envirnoment in `requirements.txt`.
+     ``` bash
+     pip install -r requirements.txt
+     ``` 
+
+4. Open your `.env` file. Replace the `###` in your `.env` file with your OpenAI Key and save the file.
+     ``` bash
+     OPENAI_API_KEY=sk-###
+     ```
+
+5. Let's try deploying it locally. Make sure you're in the python environment where you installed Chainlit and OpenAI. Run the app using Chainlit. This may take a minute to run.
+     ``` bash
+     chainlit run app.py -w
+     ```
+
+<p align = "center" draggable=”false”>
+<img src="https://github.com/AI-Maker-Space/LLMOps-Dev-101/assets/37101144/54bcccf9-12e2-4cef-ab53-585c1e2b0fb5"> 
+</p>
+
+Great work! Let's see if we can interact with our chatbot.
+
+<p align = "center" draggable=”false”>
+<img src="https://github.com/AI-Maker-Space/LLMOps-Dev-101/assets/37101144/854e4435-1dee-438a-9146-7174b39f7c61"> 
+</p> 
+
+Awesome! Time to throw it into a docker container and prepare it for shipping!
+</details>
+
+
+
+<details>
+  <summary>🐳 Containerizing our App</summary>
+
+1. Let's build the Docker image. We'll tag our image as `llm-app` using the `-t` parameter. The `.` at the end means we want all of the files in our current directory to be added to our image.
+     
+     ``` bash
+     docker build -t llm-app .
+     ```
+
+2. Run and test the Docker image locally using the `run` command. The `-p`parameter connects our **host port #** to the left of the `:` to our **container port #** on the right.
+    
+     ``` bash
+     docker run -p 7860:7860 llm-app
+     ```
+
+3. Visit http://localhost:7860 in your browser to see if the app runs correctly.
+
+<p align = "center" draggable=”false”>
+<img src="https://github.com/AI-Maker-Space/LLMOps-Dev-101/assets/37101144/2c764f25-09a0-431b-8d28-32246e0ca1b7"> 
+</p>
+
+Great! Time to ship!
+</details>
+
+
+<details>
+  <summary>🚀 Deploying Your First LLM App</summary>
+
+1. Let's create a new Huggingface Space. Navigate to [Huggingface](https://huggingface.co) and click on your profile picture on the top right. Then click on `New Space`.
+
+<p align = "center" draggable=”false”>
+<img src="https://github.com/AI-Maker-Space/LLMOps-Dev-101/assets/37101144/f0656408-28b8-4876-9887-8f0c4b882bae"> 
+</p>
+
+2. Setup your space as shown below:
+   
+- Owner: Your username
+- Space Name: `llm-app`
+- License: `Openrail`
+- Select the Space SDK: `Docker`
+- Docker Template: `Blank`
+- Space Hardware: `CPU basic - 2 vCPU - 16 GB - Free`
+- Repo type: `Public`
+
+<p align = "center" draggable=”false”>
+<img src="https://github.com/AI-Maker-Space/LLMOps-Dev-101/assets/37101144/8f16afd1-6b46-4d9f-b642-8fefe355c5c9"> 
+</p>
+
+3. You should see something like this. We're now ready to send our files to our Huggingface Space. After cloning, move your files to this repo and push it along with your docker file. You DO NOT need to create a Dockerfile. Make sure NOT TO push your `.env` file. This should automatically be ignored.
+
+<p align = "center" draggable=”false”>
+<img src="https://github.com/AI-Maker-Space/LLMOps-Dev-101/assets/37101144/cbf366e2-7613-4223-932a-72c67a73f9c6"> 
+</p>
+
+4. After pushing all files, navigate to the settings in the top right to add your OpenAI API key.
+
+<p align = "center" draggable=”false”>
+<img src="https://github.com/AI-Maker-Space/LLMOps-Dev-101/assets/37101144/a1123a6f-abdd-4f76-bea4-39acf9928762"> 
+</p>
+
+5. Scroll down to `Variables and secrets` and click on `New secret` on the top right.
+
+<p align = "center" draggable=”false”>
+<img src="https://github.com/AI-Maker-Space/LLMOps-Dev-101/assets/37101144/a8a4a25d-752b-4036-b572-93381370c2db"> 
+</p>
+
+6. Set the name to `OPENAI_API_KEY` and add your OpenAI key under `Value`. Click save.
+
+<p align = "center" draggable=”false”>
+<img src="https://github.com/AI-Maker-Space/LLMOps-Dev-101/assets/37101144/0a897538-1779-48ff-bcb4-486af30f7a14"> 
+</p>
+
+7. To ensure your key is being used, we recommend you `Restart this Space`.
+
+<p align = "center" draggable=”false”>
+<img src="https://github.com/AI-Maker-Space/LLMOps-Dev-101/assets/37101144/fb1d83af-6ebe-4676-8bf5-b6d88f07c583"> 
+</p>
+
+8. Congratulations! You just deployed your first LLM! 🚀🚀🚀 Get on linkedin and post your results and experience! Make sure to tag us at #AIMakerspace !
+
+Here's a template to get your post started!
+
+```
+🚀🎉 Exciting News! 🎉🚀
+
+🏗️ Today, I'm thrilled to announce that I've successfully built and shipped my first-ever LLM using the powerful combination of Chainlit, Docker, and the OpenAI API! 🖥️
+
+Check it out 👇
+[LINK TO APP]
+
+A big shoutout to the @**AI Makerspace** for all making this possible. Couldn't have done it without the incredible community there. 🤗🙏
+
+Looking forward to building with the community! 🙌✨ Here's to many more creations ahead! 🥂🎉
+
+Who else is diving into the world of AI? Let's connect! 🌐💡
+
+#FirstLLM #Chainlit #Docker #OpenAI #AIMakerspace
+```
+
+</details>
+
+<p></p>
+
+### That's it for now!  And so it begins.... :)

app.py

@@ -0,0 +1,80 @@
+# You can find this code for Chainlit python streaming here (https://docs.chainlit.io/concepts/streaming/python)
+
+# OpenAI Chat completion
+import os
+from openai import AsyncOpenAI  # importing openai for API usage
+import chainlit as cl  # importing chainlit for our app
+from chainlit.prompt import Prompt, PromptMessage  # importing prompt tools
+from chainlit.playground.providers import ChatOpenAI  # importing ChatOpenAI tools
+from dotenv import load_dotenv
+
+load_dotenv()
+
+# ChatOpenAI Templates
+system_template = """You are a helpful assistant who always speaks in a pleasant tone!
+"""
+
+user_template = """{input}
+Think through your response step by step.
+"""
+
+
+@cl.on_chat_start  # marks a function that will be executed at the start of a user session
+async def start_chat():
+    settings = {
+        "model": "gpt-3.5-turbo",
+        "temperature": 0,
+        "max_tokens": 500,
+        "top_p": 1,
+        "frequency_penalty": 0,
+        "presence_penalty": 0,
+    }
+
+    cl.user_session.set("settings", settings)
+
+
+@cl.on_message  # marks a function that should be run each time the chatbot receives a message from a user
+async def main(message: cl.Message):
+    settings = cl.user_session.get("settings")
+
+    client = AsyncOpenAI()
+
+    print(message.content)
+
+    prompt = Prompt(
+        provider=ChatOpenAI.id,
+        messages=[
+            PromptMessage(
+                role="system",
+                template=system_template,
+                formatted=system_template,
+            ),
+            PromptMessage(
+                role="user",
+                template=user_template,
+                formatted=user_template.format(input=message.content),
+            ),
+        ],
+        inputs={"input": message.content},
+        settings=settings,
+    )
+
+    print([m.to_openai() for m in prompt.messages])
+
+    msg = cl.Message(content="")
+
+    # Call OpenAI
+    async for stream_resp in await client.chat.completions.create(
+        messages=[m.to_openai() for m in prompt.messages], stream=True, **settings
+    ):
+        token = stream_resp.choices[0].delta.content
+        if not token:
+            token = ""
+        await msg.stream_token(token)
+
+    # Update the prompt object with the completion
+    prompt.completion = msg.content
+    msg.prompt = prompt
+
+    # Send and close the message stream
+    await msg.send()

chainlit.md

@@ -0,0 +1,3 @@
+# Beyond ChatGPT 
+
+This Chainlit app was created following instructions from [this repository!](https://github.com/AI-Maker-Space/Beyond-ChatGPT)

requirements.txt

@@ -0,0 +1,5 @@
+chainlit==0.7.700
+cohere==4.37
+openai==1.3.5
+tiktoken==0.5.1
+python-dotenv==1.0.0