DOC reorganize converter docs #1268
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…organize_converters
…organize_converters
…organize_converters
rlundeen2
reviewed
Dec 21, 2025
rlundeen2
reviewed
Dec 21, 2025
rlundeen2
reviewed
Dec 21, 2025
rlundeen2
approved these changes
Dec 21, 2025
Contributor
rlundeen2
left a comment
rlundeen2
left a comment
There was a problem hiding this comment.
Approving - great work!
I feel like with both my comments we should reach consensus. You may change my mind about either, but if you agree and implement the changes we don't need to resync
jsong468
reviewed
Dec 22, 2025
…organize_converters
Co-authored-by: hannahwestra25 <hannahwestra@microsoft.com>
…organize_converters
…manlutz/PyRIT into romanlutz/organize_converters
…organize_converters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Bringing better order to converter docs by showing all converters at least once, sorting by I/O modalities.
This also meant adding a function to get all converters sorted by modality which is showcased in the notebook indexed with 0. For simplicity, the I/O modalities are now on a class constant and retrieved for the property getters
supported_input_typesandsupported_output_types.Tests and Documentation
Added test to make sure all converters (except base classes) are indeed shown in the converter docs there is a new unit test file.
Reran all the converter notebooks.