Skip to content

Latest commit

 

History

History
139 lines (96 loc) · 8.68 KB

userGuide.md

File metadata and controls

139 lines (96 loc) · 8.68 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 Administrator 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 administrator, 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, you will 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 instructor: image

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

In the "Simulation Groups" tab, the administrator can view a list of the simulation groups available: image

Clicking on a simulation group leads to a page where the administrator can view all the instructors in that group while being able to change the status of the group: image

In the "Create Simulation Group" tab, the administrator can create a simulation group by specifying the name and description of the group. The administrator can also assign instructors to the group here while changing the "System Prompt" that the Large Language Model (LLM) uses as instructions when generating responses: image image

Instructor View

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

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

Additionally, the instructor can access detailed graphs that illustrate student interactions with patients and their performance levels. image

Clicking the "Edit Patients" tab leads to a page where the instructor can see a list of patients within the group. Here a new patient can be created or existing patients can be edited or deleted: image

The instructor can set for each patient whether or not they want the LLM to evaluate the student. image

By clicking the "CREATE NEW PATIENT" button, a pop-up will open where the instructor can create a new patient. image

The patient's name, age, and gender can be specified here along with a patient prompt to influence how they will act. image

The instructor can then upload LLM, Patient, and Answer Key files to this patient from their device. PDF, DOCX, PPTX, TXT, XLSX, XPS, MOBI, and CBZ file types are supported. The "SAVE PATIENT" button here saves the patient: image image

By clicking the "EDIT" button, a pop-up will open where the instructor can edit the patient. image

The patient's name, age, and gender can be edited here along with its patient prompt to influence how they will act. The instructor can also edit the LLM, Patient, and Answer Key files for the patient. image image image image

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

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

The instructor can then click on a student, which takes them to that student's chat logs for every simulation gorup in the simulation group. Each tab represents a different group. Different conversations with the LLM are rendered as different dropdowns: image

By clicking the session dropdown, we can view the chat history between that student and the LLM. image

The instructor can also set the completion status for a student on this page by toggling the switch for the patients. image

Student View

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

We are going to be looking at the Chronic Pain group as an example. Upon selecting Chronic Pain, the student is shown a list of patients, including Pamela and Timothy: image

If we click the "Review" button beside a patient (in this case, we will do Pamela), 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 conversational manner. The student can then respond to the questions the LLM asks to try and eventually find a cure or diagnose the patient. Once the student provides a cure or diagnosis, the LLM will either evaluate them (if the instructor has LLM evaluation on). image

Or the LLM will stop answering the student (if the instructor has LLM evaluation off). image

Additionally, on the chat page, the student can use the 'Notes' button to open a noteboard for anything they want to jot down while chatting with the patient. image image

The student can also access the patient info posted by the instructor. There, they can find useful information that may assist them in chatting with the patient. image image

The way students interact with patient information varies depending on the file type. For instance, as shown below, with an image, students can zoom in and flip it to examine details more closely. In contrast, with a PDF, they can scroll through pages or print the document for further review. image

If a student is completely stuck, they can access the instructor-provided answer key by simply clicking the "Reveal Answer" button and confirming their choice. image image

Upon going back to the list of patients, the student can see their learning journey as the patients they achieved competency for are marked complete: image