docs: Clarify descriptions for mask_labels in Mask2Former #35514
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
|
@stevhliu, could you kindly review this PR when you get a chance? Thank you! |
stevhliu
reviewed
Jan 6, 2025
Co-authored-by: Steven Liu <[email protected]>
qubvel
reviewed
Jan 13, 2025
| @@ -2393,8 +2393,7 @@ def forward( | |||
| mask_labels (`List[torch.Tensor]`, *optional*): | |||
| List of mask labels of shape `(num_labels, height, width)` to be fed to a model | |||
| class_labels (`List[torch.LongTensor]`, *optional*): | |||
| list of target class labels of shape `(num_labels, height, width)` to be fed to a model. They identify the | |||
| labels of `mask_labels`, e.g. the label of `mask_labels[i][j]` if `class_labels[i][j]`. | |||
| List of class labels of shape `(labels)` to be fed to a model. | |||
There was a problem hiding this comment.
Suggested change
| List of class labels of shape `(labels)` to be fed to a model. | |
| List of class labels of shape `(num_labels,)` to be fed to a model. |
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.
This PR improves the documentation for class_labels in the Mask2Former model.
Clarified the description of class_labels to better explain the shape of the class_labels parameter.