/tutor-gpt

LangChain LLM application. Dynamic few-shot metaprompting for theory-of-mind-powered tutoring.

Primary LanguagePythonGNU General Public License v3.0GPL-3.0

tutor-gpt

Tutor-GPT is a LangChain LLM application. It dynamically reasons about your learning needs and updates its own prompts to best serve you.

We leaned into theory of mind experiments and Bloom is now more than just a literacy tutor, it’s an expansive learning companion. Read more about how it works here or you can join our Discord to try out our implementation for free (while our OpenAI spend lasts 😄).

Alternatively, you can run your own instance of the bot by following the instructions below.

Installation

This project requires docker to be installed and running locally. Install docker and ensure it's running before proceeding.

Getting Started

This app requires you to have a few different environment variables set. Create a .env file from the .env.template.

OPENAI_API_KEY: Go to OpenAI to generate your own API key.
BOT_TOKEN: This is the discord bot token. You can find instructions on how to create a bot and generate a token in the pycord docs.
THOUGHT_CHANNEL_ID: This is the discord channel for the bot to output thoughts to. Make a channel in your server and copy the ID by right clicking the channel and copying the link. The channel ID is the last string of numbers in the link.

Docker/Containerization

The repository containers a Dockerfile for running the bot in a containerized workflow. Use the follow command to build and run the container

docker build -t tutor-gpt:latest .
docker run tutor-gpt:latest 

The current behaviour will utilize the .env file in your local repository and run the bot.