Skip to content

Clean up model documentation #6003

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

Jump to bottom
Merged
merged 7 commits into from
May 12, 2022
Merged

Clean up model documentation #6003

merged 7 commits into from
May 12, 2022

Conversation

datumbox
Copy link
Contributor

@datumbox datumbox commented May 12, 2022 •
edited
Loading

Fixes partially #6014

This PR:

  • Removes the old "minimum input size" info from the docstring
  • Removes "currently only XYZ weights available" from the main page of MNASNET. This information is encoded in the model builder pages and might become stale on the future if the text is left there.
  • Fixes the text of wide_resnet101_2 which still mentioned the 50 variant
  • Makes the license URLs display as links (similar to recipes).
  • Clarifies the order of dims of min_size.
  • Removes lengthy keypoint_names from meta-table.

image

@datumbox datumbox marked this pull request as draft May 12, 2022 14:23
NicolasHug
NicolasHug approved these changes May 12, 2022
View reviewed changes
Copy link
Member

@NicolasHug NicolasHug left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Thanks!

EDIT oops didn't realize this was draft, will take another look later sorry

@datumbox datumbox changed the title [WIP] Clean up model documentation Clean up model documentation May 12, 2022
@datumbox datumbox marked this pull request as ready for review May 12, 2022 16:24
NicolasHug
NicolasHug approved these changes May 12, 2022
View reviewed changes
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.

Still LGTM! Thanks @datumbox

@datumbox datumbox merged commit c67a583 into pytorch:main May 12, 2022
@datumbox datumbox deleted the docs/cleanups branch May 12, 2022 17:03
@datumbox datumbox mentioned this pull request May 13, 2022
Closed
6 tasks
@datumbox datumbox linked an issue May 13, 2022 that may be closed by this pull request
Improve documentation for Multi-weight support #6014
Closed
6 tasks
facebook-github-bot pushed a commit that referenced this pull request May 24, 2022
@NicolasHug @facebook-github-bot
[fbsync] Clean up model documentation (#6003)
fdb4ce0 
Summary:
* Remove old "minimum input size" from docstrings.

* Remove "currently only XYZ weights available"

* Fix description of wide_resnet101_2

* Make display license URLs as links.

* Clarify the order of dims of min_size.

* Remove lengthy keypoint_names from meta-table.

Reviewed By: datumbox

Differential Revision: D36413360

fbshipit-source-id: 7c7178c8fe95c28af63593503bc913abf4933020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@NicolasHug NicolasHug NicolasHug approved these changes

Assignees
No one assigned
Labels
cla signed enhancement module: documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Improve documentation for Multi-weight support
3 participants
@datumbox @NicolasHug @facebook-github-bot