DOC: Architecture Responsibilities by rlundeen2 · Pull Request #2089 · microsoft/PyRIT

rlundeen2 · 2026-06-26T23:58:08Z

Restructures the Architecture portion of doc/code/framework.md to clearly define each component's responsibilities

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Restructure framework.md to clearly define each component's responsibilities using an Owns / Does NOT own template, fix structural inconsistencies, and correct typos. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Reorder and rename the landing-page cards to match the Core Components / Core library section order, add an Attack Techniques card, and drop the Attacks-and-Executors / Setup-and-Configuration labels in favor of the section names. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Adds a Framework Documentation card and links the section header to the notebooks contributing guide, treating it as a Core library item. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

…rters Clarify that an attack may use defaults but should always accept its scorers, datasets/seeds (prepended_conversation and next_message), objective/adversarial targets, and converters as parameters so it can be packaged as an attack technique. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Add a Core library Backend section (presentation-specific REST API; reuse pyrit.models and the registry). Add a Source path line to every component section so the doc can be pointed at for code reviews. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

romanlutz

I am 100% in favor of these changes. The comments may improve/add things here and there but even as is it's a huge improvement.

…ture Bring framework.md fully up to date: top-down Core Components ordering, renamed Shared Library and new Application surfaces sections, normalized terminology (Scorers, Targets, seeds, Executors and Attacks), nesting hierarchy diagram, expanded 'Does not own' boundaries, header links, and matching Responsibility lines in the converter/dataset/models/target instruction guides. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Output's printers fetch result data from CentralMemory to render it; the module never writes to memory. Reverse the OUT->MEM edge to MEM->OUT and label it 'reads' to reflect the actual data dependency. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Scenarios return results; they don't render them. The entry points (Scanner/CLI, GUI/Backend, Framework/Notebooks) invoke Output to display results, pulling the data from Memory. Re-point the render edge from entry points instead of Scenario. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

… responsibilities in review Reference doc/code/framework.md as the canonical architecture/responsibility guide, and make 'each component owns only its job' the top code-review priority (flag responsibility bleed between bricks). Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Add a 'Does not own' note pointing to framework.md in the pluggable-brick instruction files (converters, datasets, targets, scorers, attacks, scenarios, output) so responsibility bleed is flagged during review. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

rlundeen2 and others added 6 commits June 26, 2026 16:31

Update framework.md architecture with new responsibility structure

a7315d1

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

DOC: Architecture Responsibilities

2bd584f

Restructure framework.md to clearly define each component's responsibilities using an Owns / Does NOT own template, fix structural inconsistencies, and correct typos. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

DOC: add Framework Documentation as a Core library card

b250edd

Adds a Framework Documentation card and links the section header to the notebooks contributing guide, treating it as a Core library item. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>