Skip to content

Commit e86cf32

Browse files
committed
header docs for Turn
1 parent 3ec028b commit e86cf32

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

docs/source/attempt.rst

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,16 @@
11
garak.attempt
22
=============
33

4-
In garak, ``attempt`` objects track a single prompt and the results of running it on through the generator.
5-
Probes work by creating a set of garak.attempt objects and setting their class properties.
4+
In garak, ``Attempt`` objects track a single prompt and the results of running it on through the generator.
5+
Probes work by creating a set of garak.attempt.Attempt objects and setting their class properties.
66
These are passed by the harness to the generator, and the output added to the attempt.
77
Then, a detector assesses the outputs from that attempt and the detector's scores are saved in the attempt.
88
Finally, an evaluator makes judgments of these scores, and writes hits out to the hitlog for any successful probing attempts.
99

10+
Within this, ``Turn`` objects encapsulate conversational turns either sent to models (i.e. prompts)
11+
or returned from models (i.e. model output).
12+
garak uses an object to encapsulate this to allow easy switching with multimodal probes and generators.
13+
1014
garak.attempt
1115
=============
1216

0 commit comments

Comments
 (0)