docs: add document for lidarseg directory#237
Merged
Merged
Conversation
Signed-off-by: ktro2828 <kotaro.uetake@tier4.jp>
Signed-off-by: ktro2828 <kotaro.uetake@tier4.jp>
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request enhances the dataset documentation by adding clarity to the directory structure and introducing information about optional LiDAR segmentation annotations. The changes make it explicit which items are directories and document support for LiDAR segmentation data in the nuScenes format.
Key changes:
- Clarified directory structure notation by adding trailing slashes to distinguish directories from files
- Added documentation for the optional
lidarseg/directory and its annotation format - Updated
mkdocs.yamlconfiguration with anextrasection for documentation generation options
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| mkdocs.yaml | Added extra section to mkdocstrings plugin options for future configuration |
| docs/schema/index.md | Updated directory structure notation and added LiDAR segmentation annotation documentation |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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.
What
This pull request updates the dataset documentation to clarify the directory structure and add information about optional LiDAR segmentation annotations. The changes improve clarity and provide guidance for datasets that include LiDAR segmentation in the nuScenes format.
Documentation improvements:
docs/schema/index.mdto indicate thatannotation,data,input_bag, andmapare directories, and added an optionallidarseg/directory for LiDAR segmentation annotations.lidarseg/annotation/directory.Configuration update:
extrasection to theoptionsinmkdocs.yamlfor documentation generation, which may be used for further configuration.