Skip to content

Commit

Permalink
header docs for Turn
Browse files Browse the repository at this point in the history
  • Loading branch information
leondz committed Feb 18, 2025
1 parent 3ec028b commit e86cf32
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions docs/source/attempt.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
garak.attempt
=============

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

Within this, ``Turn`` objects encapsulate conversational turns either sent to models (i.e. prompts)
or returned from models (i.e. model output).
garak uses an object to encapsulate this to allow easy switching with multimodal probes and generators.

garak.attempt
=============

Expand Down

0 comments on commit e86cf32

Please sign in to comment.