Skip to content

Commit f175a31

Browse files
Updated docs (user.md)
1 parent 50b23d6 commit f175a31

File tree

1 file changed

+21
-15
lines changed

1 file changed

+21
-15
lines changed

app/docs/user.md

Lines changed: 21 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,30 @@
11
# chatGPT
22

33
## What does it do?
4-
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.
4+
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

66
## What does the teacher need to input?
77
- `Model`
8-
- As of now, `gpt-3.5-turbo` is the only model available. In the future, more openAI and other models can be implemented.
9-
-
8+
- Suggest (July 2025), `gpt-4o-mini` or `gpt-4.1-mini`.
109
- `Main_prompt`
11-
- In this prompt you should explain the question and answer to gpt.
10+
- In this prompt you should explain the question and answer to gpt.
1211

13-
- `Default_prompt`
14-
- As of now, this prompt should not be changed.
15-
- It tells gpt to output a Boolean, which marks the student's answer as correct or incorrect.
16-
- In the future, this could be changed so that 'partially incorrect' answers, etc, are possible.
17-
18-
- `Feedback_prompt`
19-
- Leave this prompt **blank** if you do not want any textual feedback to be given to the student, but just correct/incorrect.
20-
- 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`:
12+
- `Default_prompt` [do not change from default]
13+
- To determine the completeness of the response.
14+
- It tells GPT to output a Boolean, which marks the student's answer as correct (complete) or incorrect (incomplete).
15+
16+
- `Feedback_prompt` [optional]
17+
- Leave this prompt **blank** if you do not want any textual/qualitative feedback to be given to the student.
18+
- Fill in this prompt to tell gpt how to give written feedback to the student. Examples of things you may want to include in your `feedback_prompt`:
2119
- `Give the student objective and constructive feedback on their answer in first person.`
2220
- `If the student is incorrect, provide feedback/hints to help them, but do not reveal the answer.`
2321

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).
25-
22+
The cost and performance of LLMs changes by the month, so do not assume that your prompts, and model choice, are good in the long term. Approaches with LLMs should be considered experimental.
2623

2724
## Usage examples
2825
Each example below demonstrates the potential usage of `main_prompt` and `feedback_prompt` for different questions.
2926

30-
### Simple descriptive observation
27+
### Technical question, for correctness and with no feedback.
3128
**Main Prompt**:
3229
> In this question, the student is asked to make a comment about the behaviour of a partial sum. The correct answer is 'fast convergence'. Accept any paraphrasing/equivalent answers. To be correct, they must mention both aspects (fast and convergence).
3330
@@ -36,3 +33,12 @@ Each example below demonstrates the potential usage of `main_prompt` and `feedba
3633
3734
<img src="https://github.com/lambda-feedback/chatGPT/assets/138524447/af083bff-fade-4186-89aa-bc0b7f48ce0d" width="450">
3835

36+
### Essay with feedback.
37+
**Main Prompt**:
38+
> Students should write an essay for GCSE English ... [details to go here]
39+
40+
**Feedback Prompt**:
41+
> Give objective feedback. Be concise.
42+
43+
44+

0 commit comments

Comments
 (0)