Most of our documentation is located within the doc directory. There is no single way to read the documentation, and it's perfectly fine to jump around. However, here is a recommended reading order. Note that in many sections there are numbered documentation pages. If there is no number attached, it is supplemental and the recommended reading order would be to skip it on a first pass.
- How to Guide: This provides an overview of the PyRIT framework.
- Installation: Before diving in, it's useful to have a working version so you can follow along.
- Setup: Includes help setting up PyRIT and related resources for users.
- Contributing: Contains information for people contributing to the project.
- Architecture: This section provides a high-level overview of all the components. Understanding any single component is difficult without some knowledge of the others.
- Orchestrators: These are the top-level components of PyRIT. Reviewing their usage can help users understand where all components fit.
- Targets: These are the endpoints that PyRIT sends prompts to. Nearly any scenario where PyRIT is used will need targets. This section dives into what targets are available and how to use them.
- Converters: These transform prompts from one format to another. This is one of the most powerful capabilities within PyRIT.
- Scorers: These are how PyRIT makes decisions and records output.
- Memory: This is how PyRIT components communicate about the state of things.
- Auxiliary Attacks: (Optional) Attacks and techniques that do not fit into the core PyRIT functionality.
Miscellaneous Extra Docs:
- Deployment: Includes code to download, deploy, and score open-source models (such as those from Hugging Face) on Azure.