Skip to content

Commit 20149e4

Browse files
committed
Revise advanced options section in README.md for the generate command
1 parent 2882f71 commit 20149e4

File tree

1 file changed

+30
-29
lines changed

1 file changed

+30
-29
lines changed

README.md

Lines changed: 30 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -95,34 +95,6 @@ gh models generate my_prompt.prompt.yml
9595

9696
The `generate` command analyzes your prompt file and automatically creates test cases to evaluate the prompt's behavior across different scenarios and edge cases. This helps ensure your prompts are robust and perform as expected.
9797

98-
##### Advanced options
99-
100-
You can customize the test generation process with various options:
101-
102-
```shell
103-
# Specify effort level (low, medium, high)
104-
gh models generate --effort high my_prompt.prompt.yml
105-
106-
# Use a specific model for groundtruth generation
107-
gh models generate --groundtruth-model "openai/gpt-4.1" my_prompt.prompt.yml
108-
109-
# Disable groundtruth generation
110-
gh models generate --groundtruth-model "none" my_prompt.prompt.yml
111-
112-
# Load from existing session file
113-
gh models generate --session-file my_prompt.session.json my_prompt.prompt.yml
114-
115-
# Custom instructions for specific generation phases
116-
gh models generate --instruction-intent "Focus on edge cases" my_prompt.prompt.yml
117-
```
118-
119-
The command supports custom instructions for different phases of test generation:
120-
- `--instruction-intent`: Custom system instruction for intent generation
121-
- `--instruction-inputspec`: Custom system instruction for input specification generation
122-
- `--instruction-outputrules`: Custom system instruction for output rules generation
123-
- `--instruction-inverseoutputrules`: Custom system instruction for inverse output rules generation
124-
- `--instruction-tests`: Custom system instruction for tests generation
125-
12698
##### Understanding PromptPex
12799

128100
The `generate` command is based on [PromptPex](https://github.com/microsoft/promptpex), a Microsoft Research framework for systematic prompt testing. PromptPex follows a structured approach to generate comprehensive test cases by:
@@ -151,7 +123,36 @@ graph TD
151123
OR ==> PPT
152124
PUT ==> PPT
153125
IOR ==> PPT
154-
```
126+
```
127+
128+
##### Advanced options
129+
130+
You can customize the test generation process with various options:
131+
132+
```shell
133+
# Specify effort level (low, medium, high)
134+
gh models generate --effort high my_prompt.prompt.yml
135+
136+
# Use a specific model for groundtruth generation
137+
gh models generate --groundtruth-model "openai/gpt-4.1" my_prompt.prompt.yml
138+
139+
# Disable groundtruth generation
140+
gh models generate --groundtruth-model "none" my_prompt.prompt.yml
141+
142+
# Load from existing session file
143+
gh models generate --session-file my_prompt.session.json my_prompt.prompt.yml
144+
145+
# Custom instructions for specific generation phases
146+
gh models generate --instruction-intent "Focus on edge cases" my_prompt.prompt.yml
147+
```
148+
149+
The command supports custom instructions for different phases of test generation:
150+
- `--instruction-intent`: Custom system instruction for intent generation
151+
- `--instruction-inputspec`: Custom system instruction for input specification generation
152+
- `--instruction-outputrules`: Custom system instruction for output rules generation
153+
- `--instruction-inverseoutputrules`: Custom system instruction for inverse output rules generation
154+
- `--instruction-tests`: Custom system instruction for tests generation
155+
155156

156157
## Notice
157158

0 commit comments

Comments
 (0)