Skip to content

feat(schema): update schema of surface_ann.json#252

Closed
ktro2828 wants to merge 2 commits into
mainfrom
fix/schema/surface-ann
Closed

feat(schema): update schema of surface_ann.json#252
ktro2828 wants to merge 2 commits into
mainfrom
fix/schema/surface-ann

Conversation

@ktro2828
Copy link
Copy Markdown
Collaborator

What

This PR is related to tier4/tier4_perception_dataset#278.

This pull request extends the SurfaceAnn schema to support additional annotation details, specifically instance and attribute references, and updates related test fixtures accordingly. These changes improve the schema's flexibility for representing more complex annotation data.

Schema enhancements:

  • Added instance_token (optional string) and attribute_tokens (optional list of strings) fields to the SurfaceAnn schema to allow referencing instance and attribute categories. [1] [2]
  • Made the mask field in SurfaceAnn optional to align with the new schema flexibility. [1] [2]

Test updates:

  • Updated the surface_ann_dict test fixture to include the new instance_token and attribute_tokens fields, ensuring tests cover the extended schema.

Copilot AI review requested due to automatic review settings January 24, 2026 12:40
@github-actions github-actions Bot added bug Something isn't working ci Continuous Integration (CI) processes and testing labels Jan 24, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jan 24, 2026

☂️ Python Coverage

current status: ❌

Overall Coverage

Lines Covered Coverage Threshold Status
4205 3467 82% 50% 🟢

New Files

No new covered files...

Modified Files

File Coverage Status
t4_devkit/schema/tables/surface_ann.py 75% 🔴
TOTAL 75% 🔴

updated for commit: 612fd15 by action🐍

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

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 extends the SurfaceAnn schema to support instance and attribute references, making the schema more flexible for complex annotation data. The changes align with related work in tier4_perception_dataset pull request #278.

Changes:

  • Added optional instance_token and attribute_tokens fields to SurfaceAnn schema
  • Made the mask field optional in the schema
  • Updated test fixtures to include the new fields

Reviewed changes

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

File Description
t4_devkit/schema/tables/surface_ann.py Added instance_token and attribute_tokens fields to the schema, made mask optional
tests/schema/conftest.py Updated surface_ann_dict test fixture with new fields

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread t4_devkit/schema/tables/surface_ann.py Outdated
Comment thread t4_devkit/schema/tables/surface_ann.py Outdated
@ktro2828 ktro2828 changed the title fix: update schema of surface_ann.json feat: update schema of surface_ann.json Jan 24, 2026
@ktro2828 ktro2828 force-pushed the fix/schema/surface-ann branch 2 times, most recently from 743e1e2 to 92aeb32 Compare January 24, 2026 12:45
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Jan 25, 2026
@ktro2828 ktro2828 added new-feature New feature or request and removed bug Something isn't working labels Jan 26, 2026
@ktro2828 ktro2828 self-assigned this Jan 29, 2026
@ktro2828 ktro2828 changed the title feat: update schema of surface_ann.json feat(schema): update schema of surface_ann.json Jan 29, 2026
Signed-off-by: ktro2828 <kotaro.uetake@tier4.jp>
Signed-off-by: ktro2828 <kotaro.uetake@tier4.jp>
@ktro2828 ktro2828 force-pushed the fix/schema/surface-ann branch from a71f2a0 to 612fd15 Compare January 30, 2026 07:33
@github-actions github-actions Bot added the bug Something isn't working label Jan 30, 2026
@ktro2828 ktro2828 removed the bug Something isn't working label Jan 30, 2026
Copy link
Copy Markdown
Contributor

@SamratThapa120 SamratThapa120 left a comment

Choose a reason for hiding this comment

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

LGTM thanks.
It is okay as a different PR, but we should add sanity check to ensure instance_token and attribute_token refers to records in the Instance and Attribute tables.

@ktro2828
Copy link
Copy Markdown
Collaborator Author

ktro2828 commented Feb 4, 2026

NOTE: Merge this PR to #249.

@ktro2828 ktro2828 closed this Feb 4, 2026
@ktro2828 ktro2828 deleted the fix/schema/surface-ann branch February 13, 2026 06:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci Continuous Integration (CI) processes and testing documentation Improvements or additions to documentation new-feature New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants