You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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 -->
Copy file name to clipboardExpand all lines: source/instructors/authoring/assessments/add-assessment.rst
+3-2Lines changed: 3 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -47,14 +47,14 @@ To add a new assessment for a course, follow these steps:
47
47
.. image:: /img/guides/add_assessment.png
48
48
:alt:Add Assessment
49
49
50
-
3. Click **Create**.
50
+
3. Fill the appropriate fields and click **Create**.
51
51
52
52
While creating/editing the assessment, you can still see/edit the guide page.
53
53
54
54
Assessment Auto-Generation
55
55
++++++++++++++++++++++++++
56
56
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>`
58
58
59
59
60
60
Refer to the specific topics for the type of assessment:
@@ -68,3 +68,4 @@ Refer to the specific topics for the type of assessment:
68
68
- :ref:`Grade Book <grade-book>`
69
69
- :ref:`Parsons Puzzle <parsons-puzzle>`
70
70
- :ref:`Random Assessment <random>`
71
+
- :ref:`LLM Rubric and LLM Rubric Autograde <llm-based-rubric>`
Copy file name to clipboardExpand all lines: source/instructors/authoring/assessments/llm-based-rubric.rst
+52-33Lines changed: 52 additions & 33 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,20 +6,27 @@
6
6
7
7
LLM-Based Rubric Grader
8
8
=======================
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>`.
10
9
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:
12
16
13
17
1. Rubric generation
14
18
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
+
15
22
3. Manual approval of LLM-generated grades by the instructor
16
23
17
-
.. Note:: Step 3 is required - LLM feedback will not be released to the student until the instructor reviews and approves it.
24
+
18
25
19
26
LLM-Based Rubric Creation (Step 1)
20
27
----------------------------------
21
28
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.
23
30
24
31
25
32
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
34
41
35
42
- Add a solution file (1) if you wish the rubric creation process to consider your solution.
36
43
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
40
47
41
-
- Click the **Generate Rubrics** (2) button to initiate the process.
48
+
- Click the **Generate Rubrics** (2) button to initiate the process.
42
49
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:
44
51
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
55
58
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.
59
60
61
+
Add your requirements in the **Rubric Requirements** dialog (optional):
60
62
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
62
66
63
67
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.
66
71
67
72
68
73
LLM Grading Based on the Created Rubric (Step 2)
69
74
------------------------------------------------
70
75
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:
72
77
73
78
- Instructions provided in the **General** tab of the assessment
74
79
- Contents of the Guide page where the assessment is located
75
80
- Contents of the specified solution file
76
81
- The student file
77
82
- The rubric generated in the previous step to identify the grading criteria
78
83
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)
.. 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:
80
97
81
98
.. image:: /img/guides/rubricprelim.png
82
99
:height:600
83
100
:alt:Preliminary grading information displayed to the student
84
101
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.
85
105
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
89
111
90
-
.. image:: /img/guides/rubricapproval.png
91
-
:height:600
92
-
:alt:The teacher approves each comment generated by the LLM grader
0 commit comments