Skip to content

Commit ef07099

Browse files
committed
README formatting fix, added LLM feedback description
1 parent 549b39c commit ef07099

File tree

1 file changed

+17
-6
lines changed

1 file changed

+17
-6
lines changed

README.md

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ See the [Configuration Guide](configs/default_config.yaml) for a full list of op
185185

186186
## Artifacts Channel
187187

188-
OpenEvolve includes a **artifacts side-channel** that allows evaluators to capture build errors, profiling results, etc. to provide better feedback to the LLM in subsequent generations. This feature enhances the evolution process by giving the LLM context about what went wrong and how to fix it.
188+
OpenEvolve includes an **artifacts side-channel** that allows evaluators to capture build errors, profiling results, etc. to provide better feedback to the LLM in subsequent generations. This feature enhances the evolution process by giving the LLM context about what went wrong and how to fix it.
189189

190190
The artifacts channel operates alongside the traditional fitness metrics.
191191

@@ -205,17 +205,28 @@ return EvaluationResult(
205205
```
206206

207207
The next generation prompt will include:
208-
```
208+
```markdown
209209
## Last Execution Output
210210
### Stderr
211-
```
212211
SyntaxError: invalid syntax (line 15)
213-
```
212+
214213
### Traceback
215-
```
216214
...
217215
```
216+
217+
## Example: LLM Feedback
218+
219+
An example for an LLM artifact side channel is part of the default evaluation template, which ends with
220+
```markdown
221+
Return your evaluation as a JSON object with the following format:
222+
{{
223+
"readability": [score],
224+
"maintainability": [score],
225+
"efficiency": [score],
226+
"reasoning": "[brief explanation of scores]"
227+
}}
218228
```
229+
The non-float values, in this case the "reasoning" key of the json response that the evaluator LLM generates, will be available within the next generation prompt.
219230

220231
### Configuration
221232

@@ -240,7 +251,7 @@ export ENABLE_ARTIFACTS=false
240251
### Benefits
241252

242253
- **Faster convergence** - LLMs can see what went wrong and fix it directly
243-
- **Better error handling** - Compilation and runtime failures become learning opportunities
254+
- **Better error handling** - Compilation and runtime failures become learning opportunities
244255
- **Rich debugging context** - Full stack traces and error messages guide improvements
245256
- **Zero overhead** - When disabled, no performance impact on evaluation
246257

0 commit comments

Comments
 (0)