Skip to content

Commit ea96fa2

Browse files
authored
added LLM-based rubric auto-grade (#426)
Please hold off on reviewing until I am done with the coderabbit comments. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** - Clarified assessment creation step text to “Fill the appropriate fields and click Create.” - Expanded assessment auto-generation options to include Standard Code Test, Multiple Choice, Fill in the Blanks, Free Text, and Parsons Puzzle. - Split LLM rubric docs into two workflows (LLM Rubric Autograde and LLM Rubric), added step-by-step flows, manual-approval step, updated sample views/images, and revised rubric requirements wording. * **Changelog** - Added entry announcing LLM-based rubric autograde feature. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
1 parent da6a947 commit ea96fa2

5 files changed

Lines changed: 56 additions & 35 deletions

File tree

306 KB
Loading

source/img/guides/rubricfinal.png

189 KB
Loading

source/instructors/authoring/assessments/add-assessment.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,14 +47,14 @@ To add a new assessment for a course, follow these steps:
4747
.. image:: /img/guides/add_assessment.png
4848
:alt: Add Assessment
4949

50-
3. Click **Create**.
50+
3. Fill the appropriate fields and click **Create**.
5151

5252
While creating/editing the assessment, you can still see/edit the guide page.
5353

5454
Assessment Auto-Generation
5555
++++++++++++++++++++++++++
5656

57-
Assessments can be auto-generated based on the text found on a guides page. Currently only :ref:`Multiple Choice <multiple-choice>`, :ref:`Fill in the Blanks <fill-in-blanks>`, :ref:`Free Text <free-text>` and :ref:`Parsons Puzzle <parsons-puzzle>` assessments can be auto-generated. For more information, please check out :ref:`Generating Assessments With AI <ai-assessment-generation>`
57+
Assessments can be auto-generated based on the text found on a guides page. Currently only :ref:`Multiple Choice <multiple-choice>`, :ref:`Fill in the Blanks <fill-in-blanks>`, :ref:`Free Text <free-text>`, :ref:`Standard Code Test <standard-code-test>`, and :ref:`Parsons Puzzle <parsons-puzzle>` assessments can be auto-generated. For more information, please check out :ref:`Generating Assessments With AI <ai-assessment-generation>`
5858

5959

6060
Refer to the specific topics for the type of assessment:
@@ -68,3 +68,4 @@ Refer to the specific topics for the type of assessment:
6868
- :ref:`Grade Book <grade-book>`
6969
- :ref:`Parsons Puzzle <parsons-puzzle>`
7070
- :ref:`Random Assessment <random>`
71+
- :ref:`LLM Rubric and LLM Rubric Autograde <llm-based-rubric>`

source/instructors/authoring/assessments/llm-based-rubric.rst

Lines changed: 52 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,27 @@
66

77
LLM-Based Rubric Grader
88
=======================
9-
You can find the **LLM Based Rubric** assessment in the **Manually Graded** section of the Assessments tab. More information about adding assessments can be found in our :ref:`assessment documentation <add-assessment>`.
109

11-
There are three steps to this process.
10+
Codio has provided two versions of the **LLM-Based Rubric Grader**. One requires the instructor to approve the LLM-generated feedback, and the other automatically displays it to the student.
11+
12+
The **LLM Rubric Autograde** assessment is in the **Auto-Graded** section of the assessments menu and the **LLM Rubric** assessment is in the **Manually Graded** section.
13+
More information about adding assessments can be found in our :ref:`assessment documentation <add-assessment>`.
14+
15+
The first two steps are the same for both versions:
1216

1317
1. Rubric generation
1418
2. LLM-based grading using the generated rubric
19+
20+
.. Note:: Step 3 is required only for the manually graded version - LLM feedback will not be released to the student until the instructor reviews and approves it.
21+
1522
3. Manual approval of LLM-generated grades by the instructor
1623

17-
.. Note:: Step 3 is required - LLM feedback will not be released to the student until the instructor reviews and approves it.
24+
1825

1926
LLM-Based Rubric Creation (Step 1)
2027
----------------------------------
2128

22-
Add an **LLM Based Rubric** assessment to your guide page and follow the steps below.
29+
Add an **LLM Rubric** or **LLM Rubric Autograde** assessment to your guide page and follow the steps below.
2330

2431

2532
1. On the **General** page, enter the following information:
@@ -34,62 +41,74 @@ Add an **LLM Based Rubric** assessment to your guide page and follow the steps b
3441

3542
- Add a solution file (1) if you wish the rubric creation process to consider your solution.
3643

37-
.. image:: /img/guides/llmbasedrubric.png
38-
:height: 600
39-
:alt: Generate a rubric
44+
.. image:: /img/guides/llmbasedrubric.png
45+
:height: 600
46+
:alt: Generate a rubric
4047

41-
- Click the **Generate Rubrics** (2) button to initiate the process.
48+
- Click the **Generate Rubrics** (2) button to initiate the process.
4249

43-
The **Rubric Creation Agent** uses the following items to generate the rubric items:
50+
The **Rubric Creation Agent** uses the following items to generate the rubric items:
4451

45-
- The assessment name
46-
- Instructions provided in the **General** tab of the assessment
47-
- Content of the Guide Page where the assessment is being added
48-
- Contents of the provided solution file
49-
- The Course, Module, and Assignment name
50-
- Requirements specified in the Rubric creation tab
51-
52-
.. Note:: If you do not add rubric requirements; the process will use general code grading norms to supply rubric items.
53-
54-
(optional) Add your requirements in the **Rubrics Requirements** dialog:
52+
- The assessment name
53+
- Instructions provided in the **General** tab of the assessment
54+
- Content of the Guide Page where the assessment is being added
55+
- Contents of the provided solution file
56+
- The Course, Module, and Assignment name
57+
- Requirements specified in the Rubric creation tab
5558

56-
.. image:: /img/guides/llmrubricreqs.png
57-
:height: 600
58-
:alt: Area to add your rubric requirements
59+
.. Note:: If you do not add rubric requirements; the process will use general code grading norms to supply rubric items.
5960

61+
Add your requirements in the **Rubric Requirements** dialog (optional):
6062

61-
- Once you are done, click **Generate Using AI**.
63+
.. image:: /img/guides/llmrubricreqs.png
64+
:height: 600
65+
:alt: Area to add your rubric requirements
6266

6367

64-
- You can provide additional rubric items by clicking **Add Rubric** and entering information.
65-
- Once you have reviewed the rubric items and other settings, click **Save** to save the assessment.
68+
- Once you are done, click **Generate Using AI**.
69+
- You can provide additional rubric items by clicking **Add Rubric** and entering information.
70+
- Once you have reviewed the rubric items and other settings, click **Save** to save the assessment.
6671

6772

6873
LLM Grading Based on the Created Rubric (Step 2)
6974
------------------------------------------------
7075

71-
The LLM Grading agent uses the following to grade the student work:
76+
The grading occurs when the student clicks the **Check It** button. The LLM Grading agent uses the following to grade the student's work:
7277

7378
- Instructions provided in the **General** tab of the assessment
7479
- Contents of the Guide page where the assessment is located
7580
- Contents of the specified solution file
7681
- The student file
7782
- The rubric generated in the previous step to identify the grading criteria
7883

79-
.. Note:: The grading occurs when the student clicks the **Check It** button. The student receives information about whether they have passed or failed each rubric item, but does not see the rest of the LLM-generated feedback until after the instructor conducts their review.
84+
Sample feedback for the Auto-Graded Version:
85+
86+
.. image:: /img/guides/rubricfinal.png
87+
:height: 600
88+
:alt: Final grading information displayed to the student
89+
90+
91+
Manual Approval by Instructor (Step 3 - only for the manually-graded version)
92+
-----------------------------------------------------------------------------
93+
.. Note:: The student receives information about whether they have passed or failed each rubric item, but does not see the rest of the LLM-generated feedback until after the instructor conducts their review.
94+
95+
96+
Sample student view of the feedback, before instructor approval:
8097

8198
.. image:: /img/guides/rubricprelim.png
8299
:height: 600
83100
:alt: Preliminary grading information displayed to the student
84101

102+
In the case of the manually graded version of this assessment, the instructor must open the student's assignment and select the passing test cases as part of the :ref:`grading process <grading>`. The instructor can also edit the comments generated by the LLM. Once this process is complete, click on **Apply Grade**.
103+
104+
.. Warning:: Once feedback is released to students, it cannot be modified.
85105

86-
Manual Approval by Instructor (Step 3)
87-
--------------------------------------
88-
The final step involves the instructor opening the student assignment and selecting the passing test cases as part of the :ref:`grading process <grading>`. The instructor can also edit the comments generated by the LLM. Once this process is complete, click on **Apply Grade**. Once the feedback is released to students, it cannot be modified.
106+
Sample Instructor view of LLM-generated feedback:
107+
108+
.. image:: /img/guides/rubricapproval.png
109+
:height: 600
110+
:alt: Instructor view of LLM-generated feedback for approval
89111

90-
.. image:: /img/guides/rubricapproval.png
91-
:height: 600
92-
:alt: The teacher approves each comment generated by the LLM grader
93112

94113

95114
Rubric Requirements Example

source/instructors/getstarted/support/changelog.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ We do not report small bug fixes or issues that affect individual users, who we
1818
- `[I] [24th]`: Pyret support has been deprecated.
1919
- `[I] [22nd]`: Pagination is now persistent across pages.
2020
- `[I] [20th]`: Added support for the Math markdown code block.
21+
- `[F] [17th]`: Add Ability to :ref:`Auto-Grade using an LLM-based rubric grader <llm-based-rubric>`
2122
- `[I] [14th]`: Behavior insight information is available in the assignment CSV file. :ref:`Assignment data <export-assignment>`
2223
- `[I] [9th]`: New Guides button for :ref:`uploading files<upload-file-button>`.
2324

0 commit comments

Comments
 (0)