Skip to content

Latest commit

 

History

History
101 lines (72 loc) · 6.93 KB

userGuide.md

File metadata and controls

101 lines (72 loc) · 6.93 KB

User Guide

Please ensure the application is deployed, instructions in the deployment guide here:

Once you have deployed the solution, the following user guide will help you navigate the functions available.

Index Description
Administrator View How the Admnistrator views the project
Instructor View How the Instructor views the project
Student View How the Student views the project

Administrator View

To sign up as an administrator, you need to sign up regularly first as a student: image

You then get a confirmation email to verify your email. Once you have a student account, to become an adminstrator, you need to change your user group with Cognito through the AWS Console: image

After clicking the user pool of the project, you need to find your email: image

After clicking your email, you can add the 'admin' user group: image image image

Once the 'admin' user group is added, delete the 'student' user group: image image

Upon logging in as an administrator, they see the following home page: image

Clicking the "ADD INSTRUCTOR" button opens a pop-up where the administrator can enter the email address of a user with an account to add them as an administrator: image

The administrator can also click an instructor in the list which takes them to a page consisting of that instructor's details which includes their name, email, and active courses: image

In the "Courses" tab, the administrator can view a list of the courses available in this project: image

Clicking the "Active" button leads to a page where the administrator can view all the instructors in that course while being able to change the status of the course: image

In the "Create Course" tab, the administrator can create a course by specifying the name, department, and code of the course. The administrator can also assign instructors to the course here while changing the "System Prompt" that the Large Language Model (LLM) uses as intructions when generating responses: image

Instructor View

Upon logging in as an instructor, they see the following home page: image

The instructor can click on the "Student View" to see the project how a student would. For more information on how a student views the project, click here. After clicking the "ACTIVE" button beside a course, the instructor can see the analytics of that course with several insights: image

Clicking the "Edit Concepts" tab leads to a page where the instructor can see a list of concepts within the course. Here a new concept can be created or existing concepts can be edited or deleted: image image image

Clicking the "Edit Modules" tab leads to a page where the instructor can see a list of modules along with the concepts they belong to in that course. Here a new module can be created or existing modules can be edited: image

Clicking the "CREATE NEW MODULE" button leads to a page where the instructor can create a module. The module's name can be specified here along with the concept it belongs to. The instructor can then upload files to this module from their device. PDF, DOCX, PPTX, TXT, XLSX, XPS, MOBI, and CBZ file types are supported. The "SAVE MODULE" button here saves the module: image

Clicking the "EDIT" button beside a course leads to a page similar to creating a module. The module's name and concept can be changed here. The instructor can also remove previous files from the module while adding new ones. Each file in the module can be downloaded on the instructor's device. The "SAVE MODULE" button here saves the changes made to the module and the "DELETE MODULE" deletes the entire module: image

Clicking the "Prompt Settings" tab leads to a page where the instructor can change the prompt applied to the LLM for this specific course. Upon applying a new prompt, the instructor can also scroll to previous prompts the course used: image

Clicking the "View Students" tab leads to a page where the instructor can view all the students in this course. The "Access Code" of the course is a special code that allows students to join the course. The instructor will have to send this code to them. The instructor can also generate a new course code on this page: image

The instructor can then click on a student which takes them to that student's chat logs for every module in the course. Each tab represents a different module. Different conversations with the LLM are rendered as different drop downs: image

Student View

Upon logging in as an student, they see the following home page: image

We are going to be looking at the CPSC 210 course as an example. Upon selecting CPSC 210, the student is shown a list of concepts at the top: Basics, Abstraction, Construction, and Design. Within each concept, there are several modules. For example, the Basics concept has the Program Structure, Methods And Calls, Classes, and Data Flow modules: image

If we click the "Review" button beside the Program Structure module, we are taken to a page where an LLM asks us a question and creates a new conversation: image

The student can then answer the questions the LLM asks in a conversation manner. Upon answering multiple questions correctly, the LLM determines when the student has achieved competency over the module: image image

Upon going back to the list of modules in this course, the student can see their learning journey as the module they achieved competency for is complete. The concept that module belonged to has also slightly changed in color by going from an inital red color to orange: image

After completing more modules, the concept those modules belongs to gradually changes color to show the student's learning journey: image image image