Skip to content

DOC reorganize converter docs - #1268

Merged
Roman Lutz (romanlutz) merged 19 commits into
microsoft:mainfrom
romanlutz:romanlutz/organize_converters
Dec 30, 2025
Merged

Roman Lutz (romanlutz) merged 19 commits into
microsoft:mainfrom
romanlutz:romanlutz/organize_converters

Conversation

@romanlutz

@romanlutz Roman Lutz (romanlutz) commented Dec 20, 2025 •

Copy link
Copy Markdown
Contributor

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_types and supported_output_types.

image

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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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

Comment thread doc/code/converters/0_converters.ipynb Resolved
Comment thread doc/_toc.yml Resolved
@romanlutz
Roman Lutz (romanlutz) merged commit 97ebac5 into microsoft:main Dec 30, 2025
20 checks passed
@romanlutz
Roman Lutz (romanlutz) deleted the romanlutz/organize_converters branch December 30, 2025 02:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants