Skip to content

NOMRG Models docs revamp -- v2 #5577

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

Closed
wants to merge 11 commits into from

Conversation

NicolasHug
Copy link
Member

@NicolasHug NicolasHug commented Mar 9, 2022

Follow up to #5575, adding documentation for the Weight enums.

The Weight docs is embedded in the same page as their corresponding model builders: https://1256058-73328905-gh.circle-artifacts.com/0/docs/prototype_models/generated/torchvision.prototype.models.resnet50.html#torchvision.prototype.models.resnet50
image

@facebook-github-bot
Copy link

facebook-github-bot commented Mar 9, 2022

💊 CI failures summary and remediations

As of commit 2503263 (more details on the Dr. CI page):


  • 1/1 failures introduced in this PR

1 failure not recognized by patterns:

Job Step Action
CircleCI lint_python_and_config Lint Python code and config files 🔁 rerun

This comment was automatically generated by Dr. CI (expand for details).

Please report bugs/suggestions to the (internal) Dr. CI Users group.

Click here to manually regenerate this comment.

@@ -304,36 +305,81 @@ class Wide_ResNet101_2_Weights(WeightsEnum):
DEFAULT = IMAGENET1K_V2


# It may or may not be a good idea to somehow unify that with _VGG_DOC . It's
# too early to decide yet.
_RESNET_DOC = """ResNet-{num_layers} from `Deep Residual Learning for Image Recognition <https://arxiv.org/pdf/1512.03385.pdf>`__.
Copy link
Member Author

Choose a reason for hiding this comment

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

Please ignore _RESNET_DOC, it's not used anywhere and is replaced by _make_resnet_docstring. Will remove

allowed_values = ", ".join(f"``{v}``" for v in weights)

return f"""ResNet-{suffix} from `Deep Residual Learning for Image Recognition <https://arxiv.org/pdf/1512.03385.pdf>`__.
Image Recognition <https://arxiv.org/abs/1409.1556>`__.
Copy link
Member Author

Choose a reason for hiding this comment

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

TODO

Suggested change
Image Recognition <https://arxiv.org/abs/1409.1556>`__.

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.

2 participants