[Fix] Update MMScan's README #99
Open
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
Tai-Wang
reviewed
Jan 25, 2025
Tai-Wang
reviewed
Jan 25, 2025
Tai-Wang
reviewed
Jan 25, 2025
Tai-Wang
reviewed
Jan 25, 2025
Tai-Wang
reviewed
Jan 25, 2025
Tai-Wang
reviewed
Jan 25, 2025
Tai-Wang
reviewed
Jan 26, 2025
| - **--------------For Visual Grounding Task** | ||
| - **"target_id"** (list\[int\]): IDs of target objects. | ||
| - **"text"** (str): Grounding text. | ||
| - **"sub_class"**: The sample category of the sample. |
There was a problem hiding this comment.
sample's category
or
category of the sample
Tai-Wang
reviewed
Jan 26, 2025
| - **"pcds"** (np.ndarray): Point cloud data with dimensions [n_points, 6(xyz+rgb)], representing the coordinates and color of each point. | ||
| - **"instance_labels"** (np.ndarray): Instance ID assigned to each point in the point cloud. | ||
| - **"class_labels"** (np.ndarray): Class IDs assigned to each point in the point cloud. | ||
| - **"bboxes"** (dict): Information about bounding boxes within the scan. |
Tai-Wang
reviewed
Jan 26, 2025
| - **"text"** (str): Grounding text. | ||
| - **"sub_class"**: The sample category of the sample. | ||
| - **"ID"**: A unique identifier for the sample. | ||
| - **"scan_id"**:Identifier corresponding to the related scan. |
Tai-Wang
reviewed
Jan 26, 2025
| - **"target_id"** (list\[int\]): IDs of target objects. | ||
| - **"text"** (str): Grounding text. | ||
| - **"sub_class"**: The sample category of the sample. | ||
| - **"ID"**: A unique identifier for the sample. |
There was a problem hiding this comment.
Recommend directly using id in the next version of release
Tai-Wang
reviewed
Jan 26, 2025
| - **"scan_id"**:Identifier corresponding to the related scan. | ||
| - *For Visual Grounding task* | ||
| - **"target_id"** (list\[int\]): IDs of target objects. | ||
| - **"text"** (str): Text used for grounding. |
There was a problem hiding this comment.
Text prompt to specify the target grounding object.
Tai-Wang
reviewed
Jan 26, 2025
| - **"answers"** (list\[str\]): List of possible answers. | ||
| - **"object_ids"** (list\[int\]): Object IDs referenced in the question. | ||
| - **"object_names"** (list\[str\]): Types of referenced objects. | ||
| - **"input_bboxes_id"** (list\[int\]): IDs of input bounding boxes. | ||
| - **"input_bboxes"** (list\[np.ndarray\]): Input bounding boxes, 9 DoF. | ||
| - **"input_bboxes"** (list\[np.ndarray\]): Input bounding box data, with 9 degrees of freedom. |
There was a problem hiding this comment.
Input 9-DoF bounding boxes.
Tai-Wang
reviewed
Jan 26, 2025
| - **'img_path'** (str): File path to the RGB image. | ||
| - **'depth_img_path'** (str): File path to the depth image. | ||
| - **'intrinsic'** (np.ndarray): Intrinsic parameters of the camera for RGB images. | ||
| - **'depth_intrinsic'** (np.ndarray): Intrinsic parameters of the camera for Depth images. |
Tai-Wang
reviewed
Jan 26, 2025
| @@ -182,7 +186,9 @@ For the visual grounding task, our evaluator computes multiple metrics including | |||
|
|
|||
| - **AP and AR**: These metrics calculate the precision and recall by considering each sample as an individual category. | |||
| - **AP_C and AR_C**: These versions categorize samples belonging to the same subclass and calculate them together. | |||
| - **gtop-k**: An expanded metric that generalizes the traditional top-k metric, offering insights into broader performance aspects. | |||
| - **gTop-k**: An expanded metric that generalizes the traditional Top-k metric, offering insights into broader performance aspects. | |||
There was a problem hiding this comment.
Specify offering what "insights" into broader performance aspects
Tai-Wang
reviewed
Jan 26, 2025
| @@ -47,6 +51,11 @@ These are 3D visual grounding models adapted for the mmscan-devkit. Currently, t | |||
| # Multiple GPU testing | |||
| python tools/test.py configs/grounding/pcd_4xb24_mmscan_vg_num256.py path/to/load_pth --launcher="pytorch" | |||
| ``` | |||
| #### ckpts & Logs | |||
There was a problem hiding this comment.
ckpts & logs -> Results and Models
Please also fix other places
Tai-Wang
reviewed
Jan 26, 2025
There was a problem hiding this comment.
setup the Env -> setup the environment
There was a problem hiding this comment.
multiple GPU -> multiple GPUs
There was a problem hiding this comment.
Consider polish the readme carefully using ChatGPT
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.
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
Please describe the motivation of this PR and the goal you want to achieve through this PR.
Modification
Please briefly describe what modification is made in this PR.
BC-breaking (Optional)
Does the modification introduce changes that break the back-compatibility of the downstream repos?
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