Skip to content

docs: update document for dataset schema#176

Merged
ktro2828 merged 6 commits into
mainfrom
docs/schema-design
Aug 28, 2025
Merged

docs: update document for dataset schema#176
ktro2828 merged 6 commits into
mainfrom
docs/schema-design

Conversation

@ktro2828

@ktro2828 ktro2828 commented Aug 27, 2025

Copy link
Copy Markdown
Collaborator

What

This PR updates the document for T4 dataset schema definitions.

These updates are basically moved from tier4_perception_dataset/docs/t4_format_3d_defailed.md.

Notes for Reviewers

You can check the preview of the document on your local device as follows:

mkdocs serve

Copilot AI review requested due to automatic review settings August 27, 2025 08:27
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Aug 27, 2025

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull Request Overview

This PR updates documentation for the T4 dataset schema by adding comprehensive schema documentation moved from an external repository. The changes create a dedicated dataset schema section in the documentation with detailed table definitions and sensor data specifications.

  • Adds new documentation structure for dataset schema with three main sections
  • Creates detailed schema table definitions for mandatory and optional tables
  • Adds sensor data format specifications for LiDAR, camera, and radar data
  • Removes references to external schema documentation

Reviewed Changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
mkdocs.yaml Adds new "Dataset Schema" navigation section with three subsections
docs/schema/table.md Comprehensive documentation of schema table definitions and data types
docs/schema/index.md Overview of dataset directory structure and schema organization
docs/schema/data.md Detailed specifications for LiDAR, camera, and radar sensor data formats
docs/index.md Removes reference to external dataset format documentation
README.md Removes reference to external dataset format documentation and updates navigation

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Comment thread docs/schema/table.md Outdated
Comment thread docs/schema/data.md Outdated
@ktro2828

Copy link
Copy Markdown
Collaborator Author

I need to add a new field for SampleData after #175 has been merged.

@ktro2828 ktro2828 marked this pull request as draft August 28, 2025 02:33
@ktro2828 ktro2828 marked this pull request as ready for review August 28, 2025 04:50
ktro2828 and others added 6 commits August 28, 2025 13:57
Signed-off-by: ktro2828 <kotaro.uetake@tier4.jp>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: ktro2828 <kotaro.uetake@tier4.jp>
Signed-off-by: ktro2828 <kotaro.uetake@tier4.jp>
Signed-off-by: ktro2828 <kotaro.uetake@tier4.jp>
@ktro2828 ktro2828 force-pushed the docs/schema-design branch from 283ec69 to 35a2b95 Compare August 28, 2025 04:57
@ktro2828

Copy link
Copy Markdown
Collaborator Author

info_filename field has been added into the document of SampleData in 5a506d4

@ktro2828 ktro2828 merged commit e1b6d47 into main Aug 28, 2025
5 checks passed
@ktro2828 ktro2828 deleted the docs/schema-design branch August 28, 2025 05:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants