Skip to content

Commit 800bc4e

Browse files
authored
DOC: Delete cookbooks directory and fix cross-references - PR #3 (microsoft#1580)
1 parent 3186982 commit 800bc4e

18 files changed

Lines changed: 7 additions & 5015 deletions

doc/blog/2025_02_11.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,6 @@ See the updated documentation [here](../code/datasets/1_loading_datasets.ipynb).
3232

3333
## What else can we do with this?
3434

35-
Now that we've loaded our dataset into PyRIT as a `SeedPromptDataset` the really exciting red teaming can begin. A great example of this is in our [Sending a Million Prompts](../cookbooks/1_sending_prompts.ipynb) notebook! We can use the prompts to evaluate the target by sending all the previously loaded prompts, modifying which attacks to use, and storing the scores for further analysis.
35+
Now that we've loaded our dataset into PyRIT as a `SeedPromptDataset` the really exciting red teaming can begin. A great example of this is in our [Baseline-Only Execution](../code/scenarios/9_baseline_only.ipynb) notebook! We can use the prompts to evaluate the target by sending all the previously loaded prompts, modifying which attacks to use, and storing the scores for further analysis.
3636

3737
In this blog post, we've walked through how we use structured datasets through our `SeedPrompt` and `SeedPromptDataset` classes. PyRIT's architecture allows for customization at every stage - whether through converters or configuring different scorers - and seed prompts set us up to effectively probe for risks in AI systems. Send over any contributions to add more datasets, refine seed prompts, or any open issues on Github! Now that you understand a core component of PyRIT, go ahead and try it out!

doc/code/setup/1_configuration.ipynb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@
215215
"\n",
216216
"You can pass these in as arguments to every class initialization, but it can be a huge pain to set these every time. It would be nicer to just say out of the box that a scorer target LLM has a temperature of .5 by default, and a converter target LLM has a temperature of 1.1 by default. And it turns out you can!\n",
217217
"\n",
218-
"The following example shows how to use PyRIT initializers. This tackles a similar scenario to the [Sending Prompts](../../cookbooks/1_sending_prompts.ipynb) but is much easier because defaults are set."
218+
"The following example shows how to use PyRIT initializers. This tackles a similar scenario to [Baseline-Only Execution](../scenarios/9_baseline_only.ipynb) but is much easier because defaults are set."
219219
]
220220
},
221221
{
@@ -398,7 +398,7 @@
398398
" \"Explain the theory of relativity in simple terms\",\n",
399399
"]\n",
400400
"\n",
401-
"# This is similar to the cookbook \"Sending a Million Prompts\" but using defaults\n",
401+
"# This is similar to the \"Baseline-Only Execution\" scenario but using defaults\n",
402402
"\n",
403403
"# Create target without extensive configuration (uses defaults from initializer)\n",
404404
"endpoint = os.environ[\"OPENAI_CHAT_ENDPOINT\"]\n",

doc/code/setup/1_configuration.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@
128128
#
129129
# You can pass these in as arguments to every class initialization, but it can be a huge pain to set these every time. It would be nicer to just say out of the box that a scorer target LLM has a temperature of .5 by default, and a converter target LLM has a temperature of 1.1 by default. And it turns out you can!
130130
#
131-
# The following example shows how to use PyRIT initializers. This tackles a similar scenario to the [Sending Prompts](../../cookbooks/1_sending_prompts.ipynb) but is much easier because defaults are set.
131+
# The following example shows how to use PyRIT initializers. This tackles a similar scenario to [Baseline-Only Execution](../scenarios/9_baseline_only.ipynb) but is much easier because defaults are set.
132132

133133
# %%
134134
import os
@@ -172,7 +172,7 @@
172172
"Explain the theory of relativity in simple terms",
173173
]
174174

175-
# This is similar to the cookbook "Sending a Million Prompts" but using defaults
175+
# This is similar to the "Baseline-Only Execution" scenario but using defaults
176176

177177
# Create target without extensive configuration (uses defaults from initializer)
178178
endpoint = os.environ["OPENAI_CHAT_ENDPOINT"]

doc/cookbooks/1_sending_prompts.ipynb

Lines changed: 0 additions & 718 deletions
This file was deleted.

doc/cookbooks/1_sending_prompts.py

Lines changed: 0 additions & 253 deletions
This file was deleted.

0 commit comments

Comments
 (0)