[Fix] Refine tutorials docs #666
Conversation
wHao-Wu
commented
Jun 21, 2021
wHao-Wu
commented
- Fix some urls in tutorials with fixed codebase version
- Fix some typo errors in tutorials
Codecov Report
@@ Coverage Diff @@
## master #666 +/- ##
==========================================
+ Coverage 50.97% 51.01% +0.04%
==========================================
Files 202 204 +2
Lines 15311 15383 +72
Branches 2488 2488
==========================================
+ Hits 7805 7848 +43
- Misses 6988 7017 +29
Partials 518 518
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
docs/tutorials/data_pipeline.md
Outdated
| @@ -98,11 +98,11 @@ For each operation, we list the related dict fields that are added/updated/remov | |||
|
|
|||
| `GlobalRotScaleTrans` | |||
| - add: pcd_trans, pcd_rotation, pcd_scale_factor | |||
| - update: points, *bbox3d_fields | |||
| - update: points, bbox3d_fields | |||
There was a problem hiding this comment.
I think the * here indicate that, input_dict['bbox3d_fields'] itself is not changed, but input_dict[item] for item in bbox3d_fields will be changed. For example here in GlobalRotScaleTrans, it changes all the boxes, where the boxes key in the dict is indicated by bbox3d_fields.
There was a problem hiding this comment.
Yep, I have also considered that case. I just wonder whether to unify the format of bbox3d_fields in data loading and pre-processing, or just to follow the reasonable pipeline in practice.
There was a problem hiding this comment.
I got your point. But at least bbox3d_fields itself is not changed right? I prefer leaving *bbox3d_fields unchanged here.
There was a problem hiding this comment.
You are definitely right. Maybe we need a further review.
There was a problem hiding this comment.
I think keeping * will be better.
docs/tutorials/customize_runtime.md
Outdated
| ``` | ||
|
|
||
| - Use `custom_imports` in the config to manually import it | ||
| or use `custom_imports` in the config to manually import it |
docs/tutorials/customize_runtime.md
Outdated
| @@ -248,7 +248,7 @@ __all__ = [..., 'MyHook'] | |||
|
|
|||
| ``` | |||
|
|
|||
| - Use `custom_imports` in the config to manually import it | |||
| or use `custom_imports` in the config to manually import it | |||
