Duplicate from abidlabs/gradio-discord-bot-server

Co-authored-by: Abubakar Abid <[email protected]>

.gitattributes

@@ -0,0 +1,34 @@
+*.7z filter=lfs diff=lfs merge=lfs -text
+*.arrow filter=lfs diff=lfs merge=lfs -text
+*.bin filter=lfs diff=lfs merge=lfs -text
+*.bz2 filter=lfs diff=lfs merge=lfs -text
+*.ckpt filter=lfs diff=lfs merge=lfs -text
+*.ftz filter=lfs diff=lfs merge=lfs -text
+*.gz filter=lfs diff=lfs merge=lfs -text
+*.h5 filter=lfs diff=lfs merge=lfs -text
+*.joblib filter=lfs diff=lfs merge=lfs -text
+*.lfs.* filter=lfs diff=lfs merge=lfs -text
+*.mlmodel filter=lfs diff=lfs merge=lfs -text
+*.model filter=lfs diff=lfs merge=lfs -text
+*.msgpack filter=lfs diff=lfs merge=lfs -text
+*.npy filter=lfs diff=lfs merge=lfs -text
+*.npz filter=lfs diff=lfs merge=lfs -text
+*.onnx filter=lfs diff=lfs merge=lfs -text
+*.ot filter=lfs diff=lfs merge=lfs -text
+*.parquet filter=lfs diff=lfs merge=lfs -text
+*.pb filter=lfs diff=lfs merge=lfs -text
+*.pickle filter=lfs diff=lfs merge=lfs -text
+*.pkl filter=lfs diff=lfs merge=lfs -text
+*.pt filter=lfs diff=lfs merge=lfs -text
+*.pth filter=lfs diff=lfs merge=lfs -text
+*.rar filter=lfs diff=lfs merge=lfs -text
+*.safetensors filter=lfs diff=lfs merge=lfs -text
+saved_model/**/* filter=lfs diff=lfs merge=lfs -text
+*.tar.* filter=lfs diff=lfs merge=lfs -text
+*.tflite filter=lfs diff=lfs merge=lfs -text
+*.tgz filter=lfs diff=lfs merge=lfs -text
+*.wasm filter=lfs diff=lfs merge=lfs -text
+*.xz filter=lfs diff=lfs merge=lfs -text
+*.zip filter=lfs diff=lfs merge=lfs -text
+*.zst filter=lfs diff=lfs merge=lfs -text
+*tfevents* filter=lfs diff=lfs merge=lfs -text

README.md

@@ -0,0 +1,14 @@
+---
+title: Gradio Discord Bot Server
+emoji: 📚
+colorFrom: purple
+colorTo: pink
+sdk: gradio
+sdk_version: 3.23.0
+app_file: app.py
+pinned: false
+license: openrail
+duplicated_from: abidlabs/gradio-discord-bot-server
+---
+
+Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference

app.py

@@ -0,0 +1,192 @@
+import asyncio
+import argparse
+from collections import Counter
+import json
+import os
+import pathlib
+import re
+from threading import Thread
+from pathlib import Path
+
+
+import discord
+from discord.ext import commands
+import gradio as gr
+from gradio import utils
+import requests
+
+from typing import Dict, List
+
+from utils import *
+
+
+lock = asyncio.Lock()
+
+bot = commands.Bot("", intents=discord.Intents(messages=True, guilds=True))
+
+
+GUILD_SPACES_FILE = "guild_spaces.pkl"
+
+
+if pathlib.Path(GUILD_SPACES_FILE).exists():
+    guild_spaces = read_pickle_file(GUILD_SPACES_FILE)
+    assert isinstance(guild_spaces, dict), f"{GUILD_SPACES_FILE} in invalid format."
+    guild_blocks = {}
+    delete_keys = []
+    for k, v in guild_spaces.items():
+        try:
+            guild_blocks[k] = gr.Interface.load(v, src="spaces")
+        except ValueError:
+            delete_keys.append(k)
+    for k in delete_keys:
+        del guild_spaces[k]
+else:
+    guild_spaces: Dict[int, str] = {}
+    guild_blocks: Dict[int, gr.Blocks] = {}
+
+
+HASHED_USERS_FILE = "users.pkl"
+
+if pathlib.Path(HASHED_USERS_FILE).exists():
+    hashed_users = read_pickle_file(HASHED_USERS_FILE)
+    assert isinstance(hashed_users, list), f"{HASHED_USERS_FILE} in invalid format."
+else:
+    hashed_users: List[str] = []
+
+
+@bot.event
+async def on_ready():
+    print(f"Logged in as {bot.user}")
+    print(f"Running in {len(bot.guilds)} servers...")
+
+
+async def run_prediction(space: gr.Blocks, *inputs):
+    inputs = list(inputs)
+    fn_index = 0
+    processed_inputs = space.serialize_data(fn_index=fn_index, inputs=inputs)
+    batch = space.dependencies[fn_index]["batch"]
+
+    if batch:
+        processed_inputs = [[inp] for inp in processed_inputs]
+
+    outputs = await space.process_api(
+        fn_index=fn_index, inputs=processed_inputs, request=None, state={}
+    )
+    outputs = outputs["data"]
+
+    if batch:
+        outputs = [out[0] for out in outputs]
+
+    processed_outputs = space.deserialize_data(fn_index, outputs)
+    processed_outputs = utils.resolve_singleton(processed_outputs)
+
+    return processed_outputs
+
+
+async def display_stats(message: discord.Message):
+    await message.channel.send(
+        f"Running in {len(bot.guilds)} servers\n"
+        f"Total # of users: {len(hashed_users)}\n"
+        f"------------------"
+    )
+    await message.channel.send(f"Most popular spaces:")
+    # display the top 10 most frequently occurring strings and their counts
+    spaces = guild_spaces.values()
+    counts = Counter(spaces)
+    for space, count in counts.most_common(10):
+        await message.channel.send(f"- {space}: {count}")
+
+
+async def load_space(guild: discord.Guild, message: discord.Message, content: str):
+    iframe_url = (
+        requests.get(f"https://huggingface.co/api/spaces/{content}/host")
+        .json()
+        .get("host")
+    )
+    if iframe_url is None:
+        return await message.channel.send(
+            f"Space: {content} not found. If you'd like to make a prediction, enclose the inputs in quotation marks."
+        )
+    else:
+        await message.channel.send(
+            f"Loading Space: https://huggingface.co/spaces/{content}..."
+        )
+    interface = gr.Interface.load(content, src="spaces")
+    guild_spaces[guild.id] = content
+    guild_blocks[guild.id] = interface
+    asyncio.create_task(update_pickle_file(guild_spaces, GUILD_SPACES_FILE))
+    if len(content) > 32 - len(f"{bot.name} []"):  # type: ignore
+        nickname = content[: 32 - len(f"{bot.name} []") - 3] + "..."  # type: ignore
+    else:
+        nickname = content
+    nickname = f"{bot.name} [{nickname}]"  # type: ignore
+    await guild.me.edit(nick=nickname)
+    await message.channel.send(
+        "Ready to make predictions! Type in your inputs and enclose them in quotation marks."
+    )
+
+
+async def disconnect_space(bot: commands.Bot, guild: discord.Guild):
+    guild_spaces.pop(guild.id, None)
+    guild_blocks.pop(guild.id, None)
+    asyncio.create_task(update_pickle_file(guild_spaces, GUILD_SPACES_FILE))
+    await guild.me.edit(nick=bot.name)  # type: ignore
+
+
+async def make_prediction(guild: discord.Guild, message: discord.Message, content: str):
+    if guild.id in guild_spaces:
+        params = re.split(r' (?=")', content)
+        params = [p.strip("'\"") for p in params]
+        space = guild_blocks[guild.id]
+        predictions = await run_prediction(space, *params)
+        if isinstance(predictions, (tuple, list)):
+            for p in predictions:
+                await send_file_or_text(message.channel, p)
+        else:
+            await send_file_or_text(message.channel, predictions)
+        return
+    else:
+        await message.channel.send(
+            "No Space is currently running. Please type in the name of a Hugging Face Space name first, e.g. abidlabs/en2fr"
+        )
+        await guild.me.edit(nick=bot.name)  # type: ignore
+
+
+@bot.event
+async def on_message(message: discord.Message):
+    if message.author == bot.user:
+        return
+    h = hash_user_id(message.author.id)
+    if h not in hashed_users:
+        hashed_users.append(h)
+        asyncio.create_task(update_pickle_file(hashed_users, HASHED_USERS_FILE))
+    else:
+        if message.content:
+            content = remove_tags(message.content)
+            print("Message received: " + content)
+            guild = message.channel.guild
+            assert guild, "Message not sent in a guild."
+
+            if content.strip() == "exit":
+                await disconnect_space(bot, guild)
+            elif content.strip() == "stats":
+                await display_stats(message)
+            elif content.startswith('"') or content.startswith("'"):
+                await make_prediction(guild, message, content)
+            else:
+                await load_space(guild, message, content)
+
+bot.env = "prod"  # type: ignore
+bot.name = "GradioBot"  # type: ignore
+
+
+t = Thread(target=bot.run, daemon=True, args=(os.getenv("discord_token"), ))
+t.start()
+
+import gradio as gr
+
+with gr.Blocks() as demo:
+    gr.Markdown(Path('landing.md').read_text())
+
+demo.launch()
+    

landing.md

@@ -0,0 +1,124 @@
+<p align="center">
+  <img width="200" src="file=gradio-discord.jpg">
+</p>
+
+# The Gradio Discord Bot<sup>BETA</sup>
+
+The Gradio Discord Bot is a way to use any [Hugging Face Space](https://hf.space) as a Bot from within your Discord server -- *all without writing any code*.
+
+Below, we show examples how to use the Bot in your server to:
+
+- 🌎 Translate between languages
+- 🗣️ Convert text to speech
+- 🔢 Do math calculations
+- 🖼️ Generate images
+
+All for free and without having to code anything! Installation instructions are below, or you can try it out right now in the [#gradio-bot-playground channel](https://discord.gg/Q7ZSBrZHjx) in the Hugging Face Discord.
+
+## Installing in your own Discord Server
+
+Installing the Gradio Discord Bot is very simple:
+
+1. Copy and paste the following link in your browser: https://discord.com/api/oauth2/authorize?client_id=1040198143695933501&permissions=294406716480&scope=bot  
+
+2. Choose which Discord server you'd like to add it to (you must have permissions to add Bots to that server of course)
+
+<p align="center">
+  <img width="600" alt="image" src="https://user-images.githubusercontent.com/1778297/208466659-00b23d23-fdc1-48e7-8868-dd248510acce.png">
+</p>
+
+3. Accept the permissions for the Gradio Bot
+
+<p align="center">
+ <img width="600" alt="image" src="https://user-images.githubusercontent.com/1778297/208466719-a6d64e0e-3aa1-4ead-90fc-23480f441b90.png">
+</p>
+
+* You can confirm that the Gradio Discord Bot has been successfully installed in your server by going to the server and seeing if there is an account with the name `@GradioBot` in your server:
+
+<p align="center">
+<img width="517" alt="image" src="https://user-images.githubusercontent.com/1778297/208510477-7a634158-885f-4083-981a-483d19ae7416.png">
+</p>
+
+4. (Optional) If you would like to use `@GradioBot` in a private channel, then you must add `@GradioBot` to that channel. In Discord, you can do this by right-clicking on the channel name, and then selecting ‘Edit Channel’. Then, go to ‘Permissions’ and select ‘Add a Role’ and find `@GradioBot` 
+
+
+## Usage
+
+Now that the Gradio Discord bot is installed, here's how to use it in any any channel in your Discord server:
+
+1. From the channel, tag `@GradioBot` followed by the name of a Space you'd like to try,
+such as `abidlabs/en2fr` ([a Space](https://huggingface.co/spaces/abidlabs/en2fr) that translates from English to French) or `abidlabs/speak` ([a Space](https://huggingface.co/spaces/abidlabs/speak) that converts text to spoken speech), or any of the more than 5,000 Gradio demos on [Hugging Face Spaces](https://hf.space). 
+
+<p align="center">
+<img width="446" alt="image" src="https://user-images.githubusercontent.com/1778297/208513251-5ba2e8bc-82e6-4037-995b-dfbba0720126.png">
+</p>
+
+2. Once you press enter, you'll notice that the name of `@GradioBot` will change to reflect the name of the Space that it has loaded:
+
+<p align="center">
+<img width="572" alt="image" src="https://user-images.githubusercontent.com/1778297/208517352-ca167539-c78a-4226-9cd1-c8fe6c1a2645.png">
+</p>
+
+3. Now type in the input you'd like to pass into the Space. In this example, we'll pass in an English phrase: "Hello, friends." The input **must be enclosed in double-quotes**. Otherwise, it will be interpreted as the name of a new Space that you are trying to load. Once you 
+
+<p align="center">
+<img width="438" alt="image" src="https://user-images.githubusercontent.com/1778297/208517591-f8024af3-fa2e-41e4-b043-994c4ce5693b.png">
+</p>
+
+4. If you'd like to load a new Space, just type in the name of a new Space (without any quotation marks) and `@GradioBot` will load the new Space instead. If you'd like to reset to the initial state of the `@GradioBot`, you can type in `@GradioBot exit`. 
+
+We'll show how to use `@GradioBot` with a few more complex Spaces below:
+
+## More examples
+
+### 🗣️ Convert text to speech (`abidlabs/speak`)
+
+The `@GradioBot` can handle media as well as text. For example, [this Space](https://huggingface.co/spaces/abidlabs/speak) converts text to speech recordings. Here's how to use it:
+
+1. In a channel, type `@GradioBot abidlabs/speak`
+
+2. Then, type in some text *in quotation marks* that you'd like to convert to speech, such as `@GradioBot "Look at this cool demo!"`. You should see an audio file returned by `@GradioBot`: 
+
+<p align="center">
+<img width="519" alt="image" src="https://user-images.githubusercontent.com/1778297/208524742-f568ec4e-accb-4087-9acb-0bdad80fd7d2.png">
+</p>
+
+
+*Note*: generation can take a minute or even longer, depending on the length of the input and how many other people are using this Space
+
+### 🔢 Do math calculations (`abidlabs/calc`)
+
+The `@GradioBot` can handle Spaces that take multiple inputs. Each input **must be in quotes and separated by a space**. For example, [this Space](https://huggingface.co/spaces/abidlabs/calc) takes in two numbers and a mathematical operation. Here's how to use it:
+
+1. In a channel, type `@GradioBot abidlabs/calc`
+
+2. Then, type in `@GradioBot `, followed by the inputs, separated by Spaces. For example: `@GradioBot "4" "divide" "3"` Here's how it looks:
+
+<p align="center">
+<img width="430" alt="image" src="https://user-images.githubusercontent.com/1778297/208525038-21f8273c-53ce-46ec-9423-1694ac646da6.png">
+</p>
+
+
+### 🖼️ Generate images (`abidlabs/images`)
+
+Here's another example that shows that `@GradioBot` can handle media. Using [this Space](https://huggingface.co/spaces/abidlabs/speak) converts text to images. Here's how to use it:
+
+1. In a channel, type `@GradioBot abidlabs/images`
+
+2. Then, type in some text *in quotation marks* that you'd like to convert into an image, such as `@GradioBot "a cartoon astronaut riding a horse"`. You should see an image file returned by `@GradioBot`: 
+
+<p align="center">
+<img width="437" alt="image" src="https://user-images.githubusercontent.com/1778297/208525226-c61c6263-5e68-448f-ae9d-25602732285f.png">
+</p>
+
+
+*Note*: generation can take a minute or even longer, depending on how many other people are using this Space
+
+## About
+
+The first version of the Gradio Discord Bot was built by the [Gradio team](https://www.gradio.dev) at a hackathon in Paris in Nov. 2022. We hope you enjoy it and find it useful! 
+
+## Contributing
+
+The Gradio Discord Bot is completely open-source. Feel free to open issues or pull requests in this repo to make it better!
+

requirements.txt

@@ -0,0 +1,2 @@
+discord.py
+requests

utils.py

@@ -0,0 +1,41 @@
+from __future__ import annotations
+
+import asyncio
+import pickle
+import hashlib
+import pathlib
+from typing import Dict, List
+
+import discord
+
+lock = asyncio.Lock()
+
+
+async def update_pickle_file(data: Dict | List, file_path: str):
+    async with lock:
+        with open(file_path, "wb") as fp:
+            pickle.dump(data, fp)
+
+
+def read_pickle_file(file_path: str):
+    with open(file_path, "rb") as fp:
+        return pickle.load(fp)
+
+
+async def send_file_or_text(channel, file_or_text: str):
+    # if the file exists, send as a file
+    if pathlib.Path(str(file_or_text)).exists():
+        with open(file_or_text, "rb") as f:
+            return await channel.send(file=discord.File(f))
+    else:
+        return await channel.send(file_or_text)
+
+
+def remove_tags(content: str) -> str:
+    content = content.replace("<@1040198143695933501>", "")
+    content = content.replace("<@1057338428938788884>", "")
+    return content.strip()
+
+
+def hash_user_id(user_id: int) -> str:
+    return hashlib.sha256(str(user_id).encode("utf-8")).hexdigest()