Skip to content

Commit dadf56c

Browse files
author
Will Kukkamalla
committed
updated docs and help message for --prompt_text
1 parent 36a4fce commit dadf56c

File tree

2 files changed

+18
-18
lines changed

2 files changed

+18
-18
lines changed

README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -26,24 +26,24 @@ For the image scope, the program takes up to two files, depending on the prompt
2626
- Saves response output in Markdown format with a predefined template or prints to stdout.
2727

2828
## Argument Details
29-
| Argument | Description | Required |
30-
|----------------------|-------------------------------------------------------------------|----------|
31-
| `--submission_type` | Type of submission (from `arg_options.FileType`) ||
32-
| `--prompt` | Pre-defined prompt name or file path to custom prompt file |**|
33-
| `--prompt_text` | Additional string text prompt that can be fed to model or standalone prompt. |** |
34-
| `--scope` | Processing scope (`image` or `code` or `text`) ||
35-
| `--submission` | Submission file path ||
36-
| `--question` | Specific question to evaluate ||
37-
| `--model` | Model type (from `arg_options.Models`) ||
38-
| `--output` | File path for where to record the output ||
39-
| `--solution` | File path for the solution file ||
40-
| `--test_output` | File path for the file containing the results from tests ||
41-
| `--submission_image` | File path for the submission image file ||
42-
| `--solution_image` | File path for the solution image file ||
29+
| Argument | Description | Required |
30+
|----------------------|---------------------------------------------------------------------|----------|
31+
| `--submission_type` | Type of submission (from `arg_options.FileType`) ||
32+
| `--prompt` | Pre-defined prompt name or file path to custom prompt file |**|
33+
| `--prompt_text` | String prompt |** |
34+
| `--scope` | Processing scope (`image` or `code` or `text`) ||
35+
| `--submission` | Submission file path ||
36+
| `--question` | Specific question to evaluate ||
37+
| `--model` | Model type (from `arg_options.Models`) ||
38+
| `--output` | File path for where to record the output ||
39+
| `--solution` | File path for the solution file ||
40+
| `--test_output` | File path for the file containing the results from tests ||
41+
| `--submission_image` | File path for the submission image file ||
42+
| `--solution_image` | File path for the solution image file ||
4343
| `--system_prompt` | Pre-defined system prompt name or file path to custom system prompt ||
44-
| `--llama_mode` | How to invoke deepSeek-v3 (choices in `arg_options.LlamaMode`) ||
45-
| `--output_template` | Output template file (from `arg_options.OutputTemplate) ||
46-
** One of either `--prompt` or `--prompt_text` must be selected.
44+
| `--llama_mode` | How to invoke deepSeek-v3 (choices in `arg_options.LlamaMode`) ||
45+
| `--output_template` | Output template file (from `arg_options.OutputTemplate) ||
46+
** One of either `--prompt` or `--prompt_text` must be selected. If both are provided, `--prompt_text` will be appended to the contents of the file specified by `--prompt`.
4747

4848
## Scope
4949
The program supports three scopes: code or text or image. Depending on which is selected, the program supports different models and prompts tailored for each option.

ai_feedback/helpers/constants.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
HELP_MESSAGES = {
33
"submission_type": "The format of the submission file (e.g., Jupyter notebook, Python script).",
44
"prompt": "Pre-defined prompt name (from ai_feedback/data/prompts/user/) or file path to custom prompt file.",
5-
"prompt_text": "Optional standalone prompt or additional text to append to the base prompt.",
5+
"prompt_text": "The string prompt that is sent to the model",
66
"scope": "The section of the assignment the model should analyze (e.g., code or image).",
77
"submission": "The file path for the submission file.",
88
"solution": "The file path for the solution file.",

0 commit comments

Comments
 (0)