Skip to content

Commit 56458b4

Browse files
committed
more changes
1 parent f61a980 commit 56458b4

File tree

4 files changed

+26
-23
lines changed

4 files changed

+26
-23
lines changed

.github/assets/collab-full.png

18.3 KB
Loading

.github/assets/example2-full.png

25 KB
Loading
-111 KB
Loading

README.md

Lines changed: 26 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11

22
# ClassroomLM
3+
34
![ClassroomLM Banner](.github/assets/main-banner.png)
45

56
**ClassroomLM provides each of the many classrooms within an organization a specialized LLM assistant that is specific and accurate to the subject matter and resources of that particular classroom.**
@@ -24,14 +25,14 @@ Teachers can create classrooms, upload documents (PDFs, slides, handwritten note
2425

2526
### **Classroom-Specific AI Assistants**
2627

27-
Each classroom has access to an LLM assistant that is RAG-enabled, allowing it to be more specific and accurate, while also being more grounded and smarter at retrieving information from the class' resources, unlocking greater potential for engaging learning, peer interaction, and more.
28+
Each classroom has access to an LLM assistant that is RAG-enabled, allowing it to be more specific and accurate, while also being more grounded and capable of retrieving information from the class' resources, unlocking greater potential for engaging learning, peer interaction, and more.
2829

2930
![Personal Assistant Example](.github/assets/personal-example.png)
3031

31-
#### **Advantages over current user-facing AI assistant systems with use case examples**
32+
#### **Advantages over current user-facing AI assistant systems**
3233

3334
**More accurate, specific, and grounded**: ClassroomLM's LLM assistant
34-
provides responses with full awareness and knowledge of the classroom's specific or niche context through the use of the instructor's documents, rather than operate in the default context of LLMs: "the entire world's knowledge."
35+
provides responses with full awareness and knowledge of the classroom's specific or niche context, rather than operating in the default context of LLMs: the entire world/internet's knowledge.
3536

3637
> **Use case example**: An NYU Professor has a variation of assembly created specifically for the classroom, called E20. Putting the E20 manual into the shared classroom dataset gave all students within this classroom access to **an assistant that is now specialized, knowledgeable, and with full context of this niche, not-seen-before language personally created by a professor.** \
3738
> Compared to ClassroomLM, other user-facing assistant systems gave vague, nonspecific, and non-accurate answers relevant to other assembly variants.
@@ -46,44 +47,46 @@ Rather than an entire classroom's worth of students having to upload their docum
4647
4748
---
4849

49-
**Powerful and highly flexible abilities**: Your imagination is the only limit on what is possible with your RAG-enabled LLM assistant.\
50-
**ClassroomLM brings out the full potential of LLM assistants for educators and students, so the existing, highly flexible powers and capabilities of LLMs that people expect are not only retained, but enhanced.**
50+
**Powerful and highly flexible abilities**:
51+
**ClassroomLM brings out the full potential of LLM assistants** for educators and students, meaning the **existing,** highly flexible **powers** and capabilities of LLMs that people expect are not only **retained, but enhanced.**
5152

52-
The assistant can be used to generate exam questions, review material, interrogate the classroom documents, have a discussion about the content, judge and correct your own understanding, and many other tested abilities, and with even more possible.\
53-
And again, **in comparison to existing user-facing systems, all of these will be more accurate and specific because of the grounding that comes from the classroom's resource dataset.**
53+
- The assistant can be used to generate exam questions, review material, interrogate the classroom documents, have a discussion about the content, judge and correct your own understanding, and many other tested abilities, and with even more possible.
54+
- And again, **in comparison to existing user-facing systems, all of these will be more accurate and specific because of the grounding that comes from the classroom's resource dataset.**
5455

5556
---
5657
**Tested in diverse contexts**:
57-
In terms of contexts, ClassroomLM was tested to be useful for subjects ranging from physics, different math topics, computer science, different topics within the humanities, etc. As an example, for something like philosophy or other classes with many readings, ClassroomLM shines because it's able to synthesize across the many readings, and without each student having to reupload all documents.
58+
In terms of contexts, ClassroomLM was tested to be useful for subjects ranging from physics, different math topics, computer science, different topics within the humanities, etc. As an example, for something like philosophy, a class with many texts, ClassroomLM shines because it's able to synthesize across the many readings, and without each student having to reupload all documents.
5859

59-
### **Collaborative AI Chats**
60+
### **Collaborative Chats with ClassroomLM**
6061

61-
Group chat support with other students the AI can participate with full chat context.
62+
***Group chats with other class members and an AI assistant that's a full conversation participant, not just a bot responding to one-off Q&As***
6263

6364
- Students can create multiple chatrooms per classroom and choose who to invite within each chatroom.
6465
- Within the chatroom, students can pull the LLM into the conversation in the manner of a group chat with the **`/ask [message]`** command.
6566
- The assistant in this case retains all the benefits described above for the personal chat, as it is also RAG enabled.
66-
- To be clear, this isn’t the common implementation of a "group chat with an assistant" very often found in company Slacks, etc. where the LLM is just responding to the message that triggered it.\
67-
That case is only more useful than just asking the LLM personally since now everyone can benefit from seeing the answer.\
68-
Instead here, when triggered with the `/ask` command the LLM will have knowledge of all the previous conversation and respond accordingly, as if it’s just part of the conversation.
6967

70-
![Collaborative Chat Example](.github/assets/collab-full.png)
71-
72-
First, spots a correction to make many messages ago.
68+
#### Unique to ClassroomLM: Collaborative chat with full conversation context *and* grounded with RAG on a classroom's resources
69+
70+
- With ClassroomLM, when triggered with the `/ask` command the LLM will have knowledge of the previous conversation and respond accordingly.
71+
- Will make corrections to messages long ago and otherwise **act like a full participant in the conversation, rather than just a bot that you Q&A one-off messages.**
72+
- This is **unlike the common implementations of a "group chat with an AI assistant" idea very often found in company Slacks, etc.** where the LLM is only aware of the message that triggered it and responds just to that.
73+
The only benefit of those implementations is that everyone in the chat witnesses the Q&A, compared to just personally asking it.
7374

74-
Proceeds to answer the question triggered with the /ask
75-
Note: answer is grounded in information from the knowledge base as seen in
75+
#### Collaborative chat example
7676

77+
![Collaborative Chat Example](.github/assets/collab-full.png)
78+
7779
<!-- <details>
7880
<summary>
7981
test
8082
</summary>
8183
-->
84+
#### Another collaborative chat example
85+
<!-- markdownlint-disable MD033 -->
86+
- We see the ClassroomLM assistant as an actual conversation participant, <ins>**understanding that it needs to keep giving new questions within a group review session one-by-one and waiting till the end to evaluate**</ins>.
87+
- We also see that the **questions are rooted in the knowledge base**, and that the **evaluation correctly and faithfully sticks to the resources** to provide the additional relevant context and give feedback.
8288
![Collaborative chat with interactivity](.github/assets/example2-full.png)
8389

84-
??? add commentts to this, it comes from the main doc
85-
86-
<!-- </details> -->
8790

8891
## Technical Overview
8992

@@ -94,7 +97,7 @@ This is especially true in terms of handling bugs and having a comprehensive and
9497

9598
### RAGFlow vs. ClassroomLM's responsibilities
9699

97-
As seen above in the diagram, the **RAGFlow** instance (note that this is self-hosted) **is responsible for storing the documents within knowledge bases and handling RAG functionality during LLM chats.\ ClassroomLM is responsible for the layer above this in terms of managing classrooms, collaborative chats, etc. For example, the ClassroomLM application is what links the siloed datasets within RAGFlow to the corresponding classroom for all LLM assistant functionality.**
100+
As seen above in the diagram, the **RAGFlow** instance (note that it's self-hosted) is responsible for storing the documents within knowledge bases and handling RAG functionality during LLM chats. **ClassroomLM is responsible for the layer above this in terms of managing classrooms, collaborative chats, etc**. For example, the ClassroomLM application is what links the siloed datasets within RAGFlow to the corresponding classroom for all LLM assistant functionality.
98101

99102
### Repository contents
100103

@@ -246,6 +249,6 @@ Then deploy:
246249
ClassroomLM was initially created by the first cohort of [Tech@NYU's](https://techatnyu.org) Dev Team Program in the Spring 2025 semester.
247250
248251
**Tech Lead**: Safi Patel\
249-
**Program manager**: Sanjay Chunduru\
252+
**Program Manager**: Sanjay Chunduru\
250253
**Developers**: Yixiang Chen, Joseph Cheng, Pranit Singh Gandhi, Xiaomin Liu, Shubham Parab, Emily Silkina, Kavya Srikumar, Austin Tan, Benjamin Tian, Chenxin Yan\
251254
**Product design**: Jennifer Huang, Haley Ngai

0 commit comments

Comments
 (0)