Skip to content

Add preprocessing information on the Weights documentation #6009

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.

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

Merged
merged 4 commits into from
May 13, 2022

Conversation

datumbox
Copy link
Contributor

@datumbox datumbox commented May 13, 2022

Fixes partially #6014

Each weight comes with a human-readable description of how the preprocessing happens during inference:
image

Copy link
Contributor Author

@datumbox datumbox left a comment

Choose a reason for hiding this comment

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

Some comments:

Copy link
Member

@NicolasHug NicolasHug left a comment

Choose a reason for hiding this comment

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

Thanks @datumbox , I think it looks nice!

Maybe as a follow-up (very low pri) we could check if all the descriptions are the same for a given weight enum. And if they're all the same, then we would just need to document it once at the top, like

all weights below follow the following pre-processing: ...

Just a thought, definitely not worth bothering with that now.

@datumbox datumbox merged commit ee26e9c into pytorch:main May 13, 2022
@datumbox datumbox deleted the docs/preprocessing_info branch May 13, 2022 11:06
@datumbox datumbox linked an issue May 13, 2022 that may be closed by this pull request
6 tasks
facebook-github-bot pushed a commit that referenced this pull request May 24, 2022
…6009)

Summary:
* Adding `__repr__` in presets

* Adds `describe()` methods to all presets.

* Adding transform descriptions in the documentation.

* Change "preprocessing" to "inference"

Reviewed By: datumbox

Differential Revision: D36413356

fbshipit-source-id: f8a88b5e1cab5beca1008d4c5fb88b98102dc389
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve documentation for Multi-weight support
3 participants