Update docs to not mention 'registration mechanism' - and move corresponding utils out of Beta #7142
Conversation
This file contains 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
pmeier
reviewed
Feb 1, 2023
There was a problem hiding this comment.
Rendered docs. One suggestion below. Plus, there is a merge conflict that needs to be resolved.
docs/source/models.rst
Outdated
|
|
||
| .. betastatus:: registration mechanism | ||
| .. betastatus:: these helpers |
There was a problem hiding this comment.
This is rendered as
"The these helpers is in Beta stage, and backward compatibility is not guaranteed."
See
vision/docs/source/beta_status.py
Line 10 in 43df72f
Suggested change
| .. betastatus:: these helpers | |
| .. betastatus:: API for listing and retrieving available models |
There was a problem hiding this comment.
Ah yes, thanks.
You know what, let's just remove that and make them stable. We won't be breaking them anyway so there's no reason they should be beta.
pmeier
approved these changes
Feb 1, 2023
NicolasHug
changed the title
facebook-github-bot
pushed a commit
that referenced
this pull request
Feb 9, 2023
…ve corresponding utils out of Beta (#7142) Summary: Co-authored-by: Philip Meier <github.pmeier@posteo.de> Reviewed By: vmoens Differential Revision: D43116113 fbshipit-source-id: 473b96862ac025c68d1b2300efeb503779e665a4
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
I removed the terms "Registration Mechanism" from the docs. The "registration mechanism" is not the feature we're exposing to users, it's merely the implementation of the feature. The actual feature is the ability to list and retrieve the models and their corresponding weights. The fact that the models are "registered" should bear no meaning to users.
I suspect that our use of "registration mechanism" in our docs may give the false impression that we support registration of external models (e.g. from other libraries) - see thread from #6365 (comment). We don't support that, we only support listing and retrieving torchvision models - not registration.