Hugging Face's logo

Spaces:
gizemsarsinlar
/
BeyondGPT-Demo
Sleeping

App Files Community
BeyondGPT-Demo / README.md
gizemsarsinlar's picture
gizemsarsinlar
Upload README.md
bfb56da verified
preview code
|
raw
history blame
7.1 kB
metadata
title: BeyondChatGPT Demo
emoji: 📉
colorFrom: pink
colorTo: yellow
sdk: docker
pinned: false
app_port: 7860

:wave: Welcome to Beyond ChatGPT!!

For a step-by-step YouTube video walkthrough, watch this! Deploying Chainlit app on Hugging Face

Beyond ChatGPT: Build Your First LLM Application

🤖 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 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!

🖥️ Accessing "gpt-3.5-turbo" (ChatGPT) like a developer

  1. Head to this notebook 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!

🏗️ Building Your First LLM App

  1. Clone this repo.

    git clone https://github.com/AI-Maker-Space/Beyond-ChatGPT.git

  2. Navigate inside this repo

    cd Beyond-ChatGPT

  3. Install the packages required for this python envirnoment in requirements.txt.

    pip install -r requirements.txt

  4. Open your .env file. Replace the ### in your .env file with your OpenAI Key and save the file.

    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.

    chainlit run app.py -w

Great work! Let's see if we can interact with our chatbot.

Awesome! Time to throw it into a docker container and prepare it for shipping!

🐳 Containerizing our App

  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.

    docker build -t llm-app .

  2. Run and test the Docker image locally using the run command. The -pparameter connects our host port # to the left of the : to our container port # on the right.

    docker run -p 7860:7860 llm-app

  3. Visit http://localhost:7860 in your browser to see if the app runs correctly.

Great! Time to ship!

🚀 Deploying Your First LLM App
  1. Let's create a new Huggingface Space. Navigate to Huggingface and click on your profile picture on the top right. Then click on New Space.

  1. 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

  1. 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.

  1. After pushing all files, navigate to the settings in the top right to add your OpenAI API key.

  1. Scroll down to Variables and secrets and click on New secret on the top right.

  1. Set the name to OPENAI_API_KEY and add your OpenAI key under Value. Click save.

  1. To ensure your key is being used, we recommend you Restart this Space.

  1. 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

That's it for now! And so it begins.... :)