Introducing Gradio ClientsJoin us on Thursday, 9am PST
Livestream
š Creating Discord Bots from Gradio Apps š
We're excited to announce that Gradio can now automatically create a discord bot from a deployed app! š¤
Discord is a popular communication platform that allows users to chat and interact with each other in real-time. By turning your Gradio app into a Discord bot, you can bring cutting edge AI to your discord server and give your community a whole new way to interact.
š» How does it work? š»%20Copyright%202022%20Fonticons,%20Inc.%20--%3e%3cpath%20d='M172.5%20131.1C228.1%2075.51%20320.5%2075.51%20376.1%20131.1C426.1%20181.1%20433.5%20260.8%20392.4%20318.3L391.3%20319.9C381%20334.2%20361%20337.6%20346.7%20327.3C332.3%20317%20328.9%20297%20339.2%20282.7L340.3%20281.1C363.2%20249%20359.6%20205.1%20331.7%20177.2C300.3%20145.8%20249.2%20145.8%20217.7%20177.2L105.5%20289.5C73.99%20320.1%2073.99%20372%20105.5%20403.5C133.3%20431.4%20177.3%20435%20209.3%20412.1L210.9%20410.1C225.3%20400.7%20245.3%20404%20255.5%20418.4C265.8%20432.8%20262.5%20452.8%20248.1%20463.1L246.5%20464.2C188.1%20505.3%20110.2%20498.7%2060.21%20448.8C3.741%20392.3%203.741%20300.7%2060.21%20244.3L172.5%20131.1zM467.5%20380C411%20436.5%20319.5%20436.5%20263%20380C213%20330%20206.5%20251.2%20247.6%20193.7L248.7%20192.1C258.1%20177.8%20278.1%20174.4%20293.3%20184.7C307.7%20194.1%20311.1%20214.1%20300.8%20229.3L299.7%20230.9C276.8%20262.1%20280.4%20306.9%20308.3%20334.8C339.7%20366.2%20390.8%20366.2%20422.3%20334.8L534.5%20222.5C566%20191%20566%20139.1%20534.5%20108.5C506.7%2080.63%20462.7%2076.99%20430.7%2099.9L429.1%20101C414.7%20111.3%20394.7%20107.1%20384.5%2093.58C374.2%2079.2%20377.5%2059.21%20391.9%2048.94L393.5%2047.82C451%206.731%20529.8%2013.25%20579.8%2063.24C636.3%20119.7%20636.3%20211.3%20579.8%20267.7L467.5%20380z'/%3e%3c/svg%3e)
With gradio_client version 0.3.0, any gradio ChatInterface app on the internet can automatically be deployed as a discord bot via the deploy_discord method of the Client class.
Technically, any gradio app that exposes an api route that takes in a single string and outputs a single string can be deployed to discord. In this guide, we will focus on gr.ChatInterface as those apps naturally lend themselves to discord's chat functionality.
š ļø Requirements š ļø
Make sure you have the latest gradio_client and gradio versions installed.
pip install gradio_client>=0.3.0 gradio>=3.38.0Also, make sure you have a Hugging Face account and a write access token.
ā ļø Tip ā ļø: Make sure you login to the Hugging Face Hub by running huggingface-cli login. This will let you skip passing your token in all subsequent commands in this guide.
šāāļø Quickstart šāāļø
Step 1: Implementing our chatbot
Let's build a very simple Chatbot using ChatInterface that simply repeats the user message. Write the following code into an app.py
import gradio as gr
def slow_echo(message, history):
return message
demo = gr.ChatInterface(slow_echo).queue().launch()Step 2: Deploying our App
In order to create a discord bot for our app, it must be accessible over the internet. In this guide, we will use the gradio deploy command to deploy our chatbot to Hugging Face spaces from the command line. Run the following command.
gradio deploy --title echo-chatbot --app-file app.pyThis command will ask you some questions, e.g. requested hardware, requirements, but the default values will suffice for this guide. Note the URL of the space that was created. Mine is https://huggingface.co/spaces/freddyaboulton/echo-chatbot
Step 3: Creating a Discord Bot
Turning our space into a discord bot is also a one-liner thanks to the gradio deploy-discord. Run the following command:
gradio deploy-discord --src freddyaboulton/echo-chatbotāļø Advanced āļø: If you already have a discord bot token you can pass it to the deploy-discord command. Don't worry, if you don't have one yet!
gradio deploy-discord --src freddyaboulton/echo-chatbot --discord-bot-token <token>Note the URL that gets printed out to the console. Mine is https://huggingface.co/spaces/freddyaboulton/echo-chatbot-gradio-discord-bot
Step 4: Getting a Discord Bot Token
If you didn't have a discord bot token for step 3, go to the URL that got printed in the console and follow the instructions there. Once you obtain a token, run the command again but this time pass in the token:
gradio deploy-discord --src freddyaboulton/echo-chatbot --discord-bot-token <token>Step 5: Add the bot to your server
Visit the space of your discord bot. You should see "Add this bot to your server by clicking this link:" followed by a URL. Go to that URL and add the bot to your server!
Step 6: Use your bot!
By default the bot can be called by starting a message with /chat, e.g. /chat <your prompt here>.
ā ļø Tip ā ļø: If either of the deployed spaces goes to sleep, the bot will stop working. By default, spaces go to sleep after 48 hours of inactivity. You can upgrade the hardware of your space to prevent it from going to sleep. See this guide for more information.
Using the gradio_client.Client Class
You can also create a discord bot from a deployed gradio app with python.
import gradio_client as grc
grc.Client("freddyaboulton/echo-chatbot").deploy_discord()š¦¾ Using State of The Art LLMs š¦¾
We have created an organization on Hugging Face called gradio-discord-bots containing several template spaces that explain how to deploy state of the art LLMs powered by gradio as discord bots.
The easiest way to get started is by deploying Meta's Llama 2 LLM with 70 billion parameter. Simply go to this space and follow the instructions.
The deployment can be done in one line! š¤Æ
import gradio_client as grc
grc.Client("ysharma/Explore_llamav2_with_TGI").deploy_discord(to_id="llama2-70b-discord-bot")š¦ Additional LLMs š¦
In addition to Meta's 70 billion Llama 2 model, we have prepared template spaces for the following LLMs and deployment options:
- gpt-3.5-turbo, powered by openai. Required OpenAI key.
- falcon-7b-instruct powered by Hugging Face Inference Endpoints.
- Llama-2-13b-chat-hf powered by Hugging Face Inference Endpoints.
- Llama-2-13b-chat-hf powered by Hugging Face transformers.
To deploy any of these models to discord, simply follow the instructions in the linked space for that model.
Deploying non-chat gradio apps to discord
As mentioned above, you don't need a gr.ChatInterface if you want to deploy your gradio app to discord. All that's needed is an api route that takes in a single string and outputs a single string.
The following code will deploy a space that translates english to german as a discord bot.
import gradio_client as grc
client = grc.Client("freddyaboulton/english-to-german")
client.deploy_discord(api_names=['german'])Conclusion
That's it for this guide! We're really excited about this feature. Tag @Gradio on twitter and show us how your discord community interacts with your discord bots.