[Docs] Fix the format of return#1462
Merged
ZwwWayne merged 6 commits intoopen-mmlab:masterfrom Dec 9, 2021
Merged
Conversation
ZwwWayne
approved these changes
Nov 8, 2021
ZCMax
reviewed
Dec 6, 2021
ZCMax
reviewed
Dec 6, 2021
ZCMax
reviewed
Dec 6, 2021
ZCMax
reviewed
Dec 6, 2021
mmcv/ops/nms.py
Outdated
| tuple: kept dets(boxes and scores) and indice, which is always the \ | ||
| same data type as the input. | ||
| tuple: kept dets (boxes and scores) and indice, which is always the | ||
| same data type as the input. |
Contributor
There was a problem hiding this comment.
which is always the same data type -> which always have the same data type
ZCMax
reviewed
Dec 6, 2021
ZCMax
reviewed
Dec 6, 2021
mmcv/ops/pixel_group.py
Outdated
| pixel_assignment (List[List[float]]): The instance coordinate list. | ||
| Each element consists of averaged confidence, pixel number, and | ||
| coordinates (x_i, y_i for all pixels) in order. | ||
| list[list[float]]: The instance coordinate list. Each element consists |
ZCMax
reviewed
Dec 6, 2021
ZCMax
reviewed
Dec 6, 2021
ZCMax
reviewed
Dec 6, 2021
ZCMax
reviewed
Dec 6, 2021
ZCMax
reviewed
Dec 6, 2021
ZCMax
reviewed
Dec 6, 2021
mmcv/ops/points_sampler.py
Outdated
| features (Tensor): (B, C, N) Descriptors of the features. | ||
| points_xyz (torch.Tensor): (B, N, 3) xyz coordinates of the | ||
| features. | ||
| features (torch.Tensor): (B, C, N) Descriptors of the features. |
Contributor
There was a problem hiding this comment.
points_xyz (torch.Tensor): (B, N, 3) xyz coordinates of the points.
features (torch.Tensor): (B, C, N) features of the points.
ZCMax
reviewed
Dec 6, 2021
ZCMax
reviewed
Dec 6, 2021
ZCMax
reviewed
Dec 6, 2021
ZCMax
reviewed
Dec 6, 2021
ZCMax
reviewed
Dec 6, 2021
mmcv/ops/three_interpolate.py
Outdated
| indices (torch.Tensor): (B, n, 3) index three nearest neighbors | ||
| of the target features in features | ||
| weight (Tensor): (B, n, 3) weights of interpolation | ||
| weight (torch.Tensor): (B, n, 3) weights of interpolation |
Contributor
There was a problem hiding this comment.
weights of three nearest neighbor features for the target features.
ZCMax
reviewed
Dec 6, 2021
ZCMax
reviewed
Dec 6, 2021
mmcv/ops/three_nn.py
Outdated
| Tensor: shape (B, N, 3), L2 distance of each point in target | ||
| set to their corresponding nearest neighbors. | ||
| torch.Tensor: shape (B, N, 3), L2 distance of each point in target | ||
| set to their corresponding nearest neighbors. |
Contributor
There was a problem hiding this comment.
Suggested change
| set to their corresponding nearest neighbors. | |
| set to their corresponding top-3 nearest neighbors. |
ZCMax
reviewed
Dec 6, 2021
ZCMax
reviewed
Dec 6, 2021
* update ops docstring * fix typos Co-authored-by: ChaimZhu <zhuchenming@pjlab.org.cn>
ZwwWayne
approved these changes
Dec 9, 2021
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Thanks for your contribution and we appreciate it a lot. The following instructions would make your pull request more healthy and more easily get feedback. If you do not understand some items, don't worry, just make the pull request and seek help from maintainers.
Motivation
Fix the format of
returnModification
mmcv/ops/*.py
BC-breaking (Optional)
Does the modification introduce changes that break the backward-compatibility of the downstream repositories?
If so, please describe how it breaks the compatibility and how the downstream projects should modify their code to keep compatibility with this PR.
Use cases (Optional)
If this PR introduces a new feature, it is better to list some use cases here, and update the documentation.
Checklist
Before PR:
After PR: