Rewrite with hikari

backend/oasst_backend/api/v1/tasks.py

@@ -55,7 +55,7 @@ def generate_task(
                 hint="Ask the assistant about a current event."  # this is optional
             )
         case protocol_schema.TaskRequestType.prompter_reply:
-            logger.info("Generating a UserReplyTask.")
+            logger.info("Generating a PrompterReplyTask.")
             messages = pr.fetch_random_conversation("assistant")
             task_messages = [
                 protocol_schema.ConversationMessage(
@@ -86,7 +86,7 @@ def generate_task(
             messages = pr.fetch_random_initial_prompts()
             task = protocol_schema.RankInitialPromptsTask(prompts=[msg.payload.payload.text for msg in messages])
         case protocol_schema.TaskRequestType.rank_prompter_replies:
-            logger.info("Generating a RankUserRepliesTask.")
+            logger.info("Generating a RankPrompterRepliesTask.")
             conversation, replies = pr.fetch_multiple_random_replies(message_role="assistant")
 
             task_messages = [

discord-bot/.env.example

@@ -0,0 +1,7 @@
+BOT_TOKEN=<discord bot token>
+DECLARE_GLOBAL_COMMANDS=<testing guild id>
+OWNER_IDS=[<your user id>, <other user ids>]
+PREFIX="./"
+
+OASST_API_URL="http://localhost:8080"  # No trailing '/'
+OASST_API_KEY=""

discord-bot/.gitignore

@@ -1,3 +1,10 @@
 .env
 *.egg-info/
 __pycache__/
+
+.venv
+.nox
+.env
+
+# Database files
+*.db

discord-bot/README.md

@@ -1,20 +1,120 @@
 # Open-Assistant Data Collection Discord Bot
 
-This bot collects human feedback to create a dataset for RLHF-alignment of an assistant chat bot based on a large langugae model. You and other people can teach the bot how to respond to user requests by demonstration and by garding and ranking the bot's outputs. If you want to learn more about RLHF please refer [to OpenAI's InstructGPT blog post](https://openai.com/blog/instruction-following/).
+This bot collects human feedback to create a dataset for RLHF-alignment of an assistant chat bot based on a large language model. You and other people can teach the bot how to respond to user requests by demonstration and by ranking the bot's outputs. If you want to learn more about RLHF please refer [to OpenAI's InstructGPT blog post](https://openai.com/blog/instruction-following/).
 
 ## Invite official bot
 
 To add the official Open-Assistant data collection bot to your discord server [click here](https://discord.com/api/oauth2/authorize?client_id=1054078345542910022&permissions=1634235579456&scope=bot). The bot needs access to read the contents of user text messages.
 
-## Bot token for development
+## Contributing
+
+If you are unfamiliar with `hikari`, `lightbulb`, or `miru`, please refer to the [large list of examples](https://gist.github.com/AlexanderHOtt/7805843a7120f755938a3b75d680d2e7)
+
+### Setup
+
+To run the bot
+
+```bash
+cp .env.example .env
+
+python -V  # 3.10
+
+pip install -r requirements.txt
+python -m bot
+```
+
+Before you push, make sure the `pre-commit` hooks are installed and run successfully.
+
+```bash
+pip install pre-commit
+pre-commit install
+
+...
+
+git add .
+git commit -m "<good commit message>"
+# if the pre-commit fails
+git add .
+git commit -m "<good commit message>"
+```
 
 To test the bot on your own discord server you need to register a discord application at the [Discord Developer Portal](https://discord.com/developers/applications) and get at bot token.
 
 1. Follow a tutorial on how to get a bot token, for example this one: [Creating a discord bot & getting a token](https://github.com/reactiflux/discord-irc/wiki/Creating-a-discord-bot-&-getting-a-token)
-2. The bot script expects the bot token to be in an environment variable called `BOT_TOKEN`.
+2. The bot script expects the bot token to be in the `.env` file under the `TOKEN` variable.
 
-The simplest way to configure the token is via an `.env` file:
+### Resources
 
+#### Structure
+
+Important files
+
+```graphql
+.env                        # Environment variables
+.env.example                # Example environment variables
+CONTRIBUTING.md             # This file
+README.md                   # Project readme
+EXAMPLES.md                 # Examples for commands and listeners
+requirements.txt            # Requirements
+
+bot/
+├─  __main__.py             # Entrypoint
+├─  api_client.py           # API Client for interacting with the backend
+├─  bot.py                  # Main bot class
+├─  settings.py             # Settings and secrets
+├─  utils.py                # Utility Functions
+│
+├─  db/                     # Database related code
+│   ├─  database.db         # SQLite database
+│   ├─  schema.sql          # SQL schema
+│   └─  schemas.py          # Python table schemas
+│
+└── extensions/             # Application logic, see https://hikari-lightbulb.readthedocs.io/en/latest/guides/extensions.html
+    ├─  work.py             # Task handling logic  <-- most important file
+    ├─  guild_settings.py   # Server specific settings
+    └─  hot_reload.py       # Utility for hot reload extensions during development
 ```
-BOT_TOKEN=XYZABC123...
+
+#### Adding a new command/listener
+
+1. Create a new file in the `extensions` folder
+2. Copy the template below
+
+```py
+# -*- coding: utf-8 -*-
+"""My plugin."""
+import lightbulb
+
+plugin = lightbulb.Plugin("MyPlugin")
+
+# Add your commands here
+
+def load(bot: lightbulb.BotApp):
+    """Add the plugin to the bot."""
+    bot.add_plugin(plugin)
+
+
+def unload(bot: lightbulb.BotApp):
+    """Remove the plugin to the bot."""
+    bot.remove_plugin(plugin)
 ```
+
+#### Docs
+
+Discord
+
+- [Discord API Reference](https://discord.com/developers/docs/intro)
+
+`hikari` (main framework)
+
+- [Hikari Repo](https://github.com/hikari-py/hikari)
+- [Hikari Docs](https://docs.hikari-py.dev/en/latest/)
+
+`lightbulb` (command handler)
+
+- [Lightbulb Repo](https://github.com/tandemdude/hikari-lightbulb)
+- [Lightbulb Docs](https://hikari-lightbulb.readthedocs.io/en/latest/)
+
+`miru` (component handler: buttons, modals, etc... )
+
+- [Miru Repo](https://github.com/HyperGH/hikari-miru)