Skip to content

DOC reorganize converter docs #1268

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
romanlutz wants to merge 11 commits into
base: main
Choose a base branch
from
Open

DOC reorganize converter docs #1268

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
e21cb8e
reorganize converter docs
romanlutz Dec 20, 2025
dadcbb3
linting
romanlutz Dec 20, 2025
3ab06d3
Merge branch 'main' of https://github.com/Azure/PyRIT into romanlutz/…
romanlutz Dec 20, 2025
e737e61
more linting
romanlutz Dec 20, 2025
5982ebd
linting, links
romanlutz Dec 21, 2025
52b1037
fix unit tests
romanlutz Dec 21, 2025
2133647
Merge branch 'main' of https://github.com/Azure/PyRIT into romanlutz/…
romanlutz Dec 21, 2025
917341b
lint
romanlutz Dec 21, 2025
d841270
Merge branch 'main' of https://github.com/Azure/PyRIT into romanlutz/…
romanlutz Dec 21, 2025
4514d26
Update doc/code/converters/1_text_to_text_converters.py
romanlutz Dec 23, 2025
d1ee2a7
Add subclass validation to enforce INPUT_TYPES and OUTPUT_TYPES for P…
rlundeen2 Dec 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 7 additions & 12 deletions doc/_toc.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,18 +83,13 @@ chapters:
- file: code/targets/realtime_target
- file: code/converters/0_converters
sections:
- file: code/converters/1_llm_converters
- file: code/converters/2_using_converters
- file: code/converters/3_audio_converters
- file: code/converters/4_image_converters
- file: code/converters/5_selectively_converting
- file: code/converters/6_human_converter
- file: code/converters/7_video_converters
- file: code/converters/ansi_attack_converter
- file: code/converters/char_swap_attack_converter
- file: code/converters/pdf_converter
- file: code/converters/math_prompt_converter
- file: code/converters/transparency_attack_converter
- file: code/converters/1_text_to_text_converters
- file: code/converters/2_audio_converters
- file: code/converters/3_image_converters
- file: code/converters/4_video_converters
- file: code/converters/5_file_converters
- file: code/converters/6_selectively_converting
- file: code/converters/7_human_converter
Comment on lines +86 to +92
Copy link
Contributor

@hannahwestra25 hannahwestra25 Dec 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like this organization a lot! this is much more streamlined. I have a slight preference to remove 7_human_converter so that human converter is just an example in the 1_text_to_text_converters notebook

Copy link
Contributor Author

@romanlutz romanlutz Dec 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The interaction mode is VERY different, though, and it prevents us from running it in automation. Plus, I imagine with the GUI this will actually disappear.

- file: code/scoring/0_scoring
sections:
- file: code/scoring/1_azure_content_safety_scorers
Expand Down
1 change: 1 addition & 0 deletions doc/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -392,6 +392,7 @@ API Reference
EmojiConverter
FirstLetterConverter
FlipConverter
get_converter_modalities
HumanInTheLoopConverter
ImageCompressionConverter
IndexSelectionStrategy
Expand Down
Loading