Skip to content

Commit 101614f

Browse files
Update user.md
1 parent d5f65e4 commit 101614f

File tree

1 file changed

+4
-8
lines changed

1 file changed

+4
-8
lines changed

app/docs/user.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,29 +3,25 @@
33
## What does it do?
44
This chatGPT evaluation function is designed to automatically evaluate student responses to questions. It currently uses the openAI API to determine the correctness (true/false) of the student's answer and can also provide them with feedback.
55

6-
76
## What does the teacher need to input?
87
- `Model`
9-
108
- As of now, `gpt-3.5-turbo` is the only model available. In the future, more openAI and other models can be implemented.
9+
-
1110
- `Main_prompt`
12-
1311
- In this prompt you should explain the question and answer to gpt.
1412

1513
- `Default_prompt`
16-
1714
- As of now, this prompt should not be changed.
1815
- It tells gpt to output a Boolean, which marks the student's answer as correct or incorrect.
1916
- In the future, this could be changed so that 'partially incorrect' answers, etc, are possible.
20-
- `Feedback_prompt`
21-
17+
18+
- `Feedback_prompt`
2219
- Leave this prompt **blank** if you do not want any textual feedback to be given to the student, but just correct/incorrect.
2320
- Fill in this prompt to tell gpt how to give feedback to the student. Examples of things you may want to include in your `feedback_prompt`:
24-
2521
- `Give the student objective and constructive feedback on their answer in first person.`
2622
- `If the student is incorrect, provide feedback/hints to help them, but do not reveal the answer.`
2723

28-
Please be aware that `gpt-3.5-turbo` often gets overwhelmed by a long prompts, and can sometimes ignore your instructions. It is recommended to do testing with your question, and use `gpt-4` if neccesary. Be aware that the cost of `gpt-4` is ~20x more than `gpt-3.5-turbo` (at the time of writing - 6th Sep 2023).
24+
Please be aware that `gpt-3.5-turbo` often gets overwhelmed by long prompts, and can sometimes ignore your instructions. It is recommended to do testing with your question, and use `gpt-4` if neccesary. Be aware that the cost of `gpt-4` is ~20x more than `gpt-3.5-turbo` (at the time of writing - 6th Sep 2023).
2925

3026

3127
## Usage examples

0 commit comments

Comments
 (0)