wassname/stampy-chat
1
0
Fork 0
mirror of https://github.com/wassname/stampy-chat.git synced 2026-09-12 13:00:42 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
ccstan99
2023-04-30 17:38:15 -07:00
parent 7cbd0d54fc
commit 98d4c83c82
2 changed files with 18 additions and 44 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+18 -6
View File
@@ -1,11 +1,23 @@
# AlignmentSearch
# stampy-chat
![img](resources/screenshot.png)
The Stampy conversational chatbot answers questions about AI Safety & Alignment based on information retrieved from the [Alignment Research Dataset (ARD)](https://github.com/moirage/alignment-research-dataset). The project has 3 components:
## Project Layout
1. `src/` **Data** - ARD is ingested by splitting text into chunks then embedded and uploaded into a vector store along with relevant metadata about the chunk of text.
2. `api/` **Backend API** - Given a user's query and chat history, the most semantically similar chunks are retrieved from the vector store then a large language model is prompted to answer the query based on the retrieved context. The generated answer is returned along with cited sources.
3. `web/` **Frontend GUI** - Web app that calls the backend API and displaying the conversation flow.
- `src/` stuff around processing our dataset and constructing embeddings
- `api/` a flask app serving as our backend
- `web/` a NextJS app for the frontend
## What is the purpose of Stampy?
With the recent development in AI, growing concern and interest in AI Safety & Alignment is coupled with tons of information and misinformation. Sifting through all the text while trying to identify quality sources is a daunting barrier for entry. Stampy not only strives to provide quality information but also allows people to contribute while learning. The FAQs are hand curated and limited by volunteer bandwidth. A chatbot can leverage LLMs to synthesize & summarize the ever expanding literature.
## Who are the users?
In general, the Stampy project serves users at 3 levels of understanding:
- **New** - People completely new to AI Safety & Alignment. Many volunteers have technical backgrounds but not necessarily much experience with ML per se. The website & chatbot should be accessible by the general public, so jargon should be minimized where possible.
- **Moderate** - However, there should also be enough “meaty” content for people who are ready to delve deeper. Beyond raising general awareness about the field, another objective for the project is to engage & build a community for those hoping to upskill or transition into the field. People can contribute by answering questions, developing software, or offering skills they have.
- **Knowledgeable** experts who might want to share their research by answering questions.
Given the disparate backgrounds of users, for both the website and chatbot, we should consider having users identify their starting level (new, moderate, knowledgeable). On the website, the list of starter and recommended questions would be tuned to the user’s level. Similarly, the chatbot's usage of technical terminology could be adjusted to their level.