Skip to content
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

[Doc] Add SUN RGB-D doc #770

Merged
merged 20 commits into from
Jul 30, 2021
Merged

[Doc] Add SUN RGB-D doc #770

merged 20 commits into from
Jul 30, 2021

Conversation

yezhen17
Copy link
Collaborator

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

Add SUN RGB-D doc.

Modification

  • Add SUN RGB-D doc (mainly based on ScanNet doc).
  • Modify ScanNet doc for consistency.

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

  1. Pre-commit or other linting tools are used to fix the potential lint issues.
  2. The modification is covered by complete unit tests. If not, please add more unit test to ensure the correctness.
  3. If the modification has potential influence on downstream projects, this PR should be tested with downstream projects.
  4. The documentation has been modified accordingly, like docstring or example tutorials.

@yezhen17
Copy link
Collaborator Author

TBD: Multi-modality related contents.

@yezhen17 yezhen17 added the WIP label Jul 21, 2021
@codecov
Copy link

codecov bot commented Jul 21, 2021

Codecov Report

Merging #770 (bc9eee0) into master (c07e960) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #770   +/-   ##
=======================================
  Coverage   49.03%   49.03%           
=======================================
  Files         210      210           
  Lines       15964    15964           
  Branches     2547     2547           
=======================================
  Hits         7828     7828           
  Misses       7634     7634           
  Partials      502      502           
Flag Coverage Δ
unittests 49.03% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.


Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c07e960...bc9eee0. Read the comment docs.

@yezhen17 yezhen17 removed the WIP label Jul 29, 2021
Copy link
Contributor

@Wuziyi616 Wuziyi616 left a comment

Choose a reason for hiding this comment

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

We also need to add this doc to index.rst. And please add the corresponding Chinese doc (An empty file containing a head title is OK)

tools/data_converter/sunrgbd_data_utils.py Show resolved Hide resolved
docs/datasets/sunrgbd_det.md Outdated Show resolved Hide resolved
Copy link
Contributor

@Wuziyi616 Wuziyi616 left a comment

Choose a reason for hiding this comment

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

Almost ready for merge

@yezhen17
Copy link
Collaborator Author

Made a mistake in the dataset preparation part. @Wuziyi616 Please go through that part again. It's been too long that I've processed the raw data orz

Copy link
Contributor

@Wuziyi616 Wuziyi616 left a comment

Choose a reason for hiding this comment

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

Some minor typos in Chinese doc

docs_zh-CN/datasets/sunrgbd_det.md Outdated Show resolved Hide resolved
docs_zh-CN/datasets/sunrgbd_det.md Outdated Show resolved Hide resolved
docs_zh-CN/datasets/sunrgbd_det.md Outdated Show resolved Hide resolved
@ZwwWayne ZwwWayne merged commit 43b4632 into open-mmlab:master Jul 30, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants