chore: sync table definition with tier4_perception_dataset by SamratThapa120 · Pull Request #185 · tier4/t4-devkit

SamratThapa120 · 2025-09-01T12:11:10Z

This pull request introduces changes to sync the table definitions in tier4_perception_dataset with t4-devkit. Only remaining sync is for the lidarseg table, which is addressed in PR #184

Autolabeling metadata support

Added the AutolabelModel type to the schema, including its definition in documentation (docs/schema/table.md) and implementation in code (t4_devkit/schema/tables/autolabel_metadata.py). This type tracks model name, score, and uncertainty for autolabeling. [1] [2] [3]
Introduced an autolabel_metadata field to SampleAnnotation, SampleData, ObjectAnn, and SurfaceAnn tables, allowing storage of autolabeling model information wherever automatic_annotation is used. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12]

Category and annotation field extensions

Added has_orientation and has_number fields to the Category schema and documentation, enabling category-level control over the presence of orientation and number fields in object annotations. [1] [2]
Added orientation and number fields to the ObjectAnn schema and documentation, supporting specialized annotation for traffic light arrows and numeric traffic lights, gated by category settings. [1] [2] [3]

Documentation updates

Updated docs/schema/table.md to document all new fields, types, and their usage, including detailed explanations for AutolabelModel, autolabel_metadata, has_orientation, has_number, orientation, and number. [1] [2] [3] [4] [5] [6] [7]

Codebase integration

Registered the new autolabel_metadata module in the schema package and imported AutolabelModel into all affected schema tables to enable type checking and conversion. [1] [2] [3] [4] [5]

Validation and conversion logic

Implemented validation and conversion logic for the new fields in all affected schema classes, ensuring correct handling of lists of AutolabelModel instances and optional fields. [1] [2] [3] [4] [5]

…kit into chore/sync_table_definition

Copilot

Pull Request Overview

This PR syncs table definitions with tier4_perception_dataset by introducing autolabeling metadata support and category-specific annotation field extensions. The changes enable tracking of ML model information for automatically generated annotations and support specialized fields for traffic light annotations.

Added AutolabelModel type and autolabel_metadata fields to support tracking of autolabeling model information
Extended Category schema with has_orientation and has_number flags to control presence of specialized annotation fields
Added orientation and number fields to ObjectAnn for traffic light arrow directions and numeric displays

Reviewed Changes

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

Show a summary per file

File	Description
`t4_devkit/schema/tables/autolabel_metadata.py`	New module defining `AutolabelModel` dataclass for autolabeling metadata
`t4_devkit/schema/tables/__init__.py`	Added import for new autolabel metadata module
`t4_devkit/schema/tables/category.py`	Added `has_orientation` and `has_number` optional boolean fields
`t4_devkit/schema/tables/object_ann.py`	Added `orientation`, `number`, and `autolabel_metadata` fields with validation
`t4_devkit/schema/tables/sample_annotation.py`	Added `autolabel_metadata` field with validation logic
`t4_devkit/schema/tables/sample_data.py`	Added `autolabel_metadata` field with validation logic
`t4_devkit/schema/tables/surface_ann.py`	Added `autolabel_metadata` field with validation logic
`docs/schema/table.md`	Updated documentation to describe all new fields and `AutolabelModel` type
`tests/schema/conftest.py`	Updated test fixtures to include new fields with sample data

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

ktro2828

@SamratThapa120 Thank you for following up! I left some comments please take a look.

ktro2828 · 2025-09-02T03:54:18Z

+        converter=lambda x: [
+            AutolabelModel(**model) if isinstance(model, dict) else model for model in x
+        ]
+        if isinstance(x, list)
+        else x,


[WANT] Can you define this conversion function in annotation_metadata.py like below?
This function can be reused in the other schema field conversions.

def to_autolabel_model(x) -> AutolabelModel: // ...

ktro2828 · 2025-09-02T17:09:27Z

[MEMO] I encountered errors while running pytest, and they were fixed by the following changes:

───────┬──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
       │ File: t4_devkit/schema/tables/autolabel_metadata.py
───────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
  27   │         default=None,
  28   │         validator=validators.optional(
  29 ~ │             (validators.instance_of(float), validators.ge(0.0), validators.le(1.0))
  30   │         ),
  31   │     )
 ...   │ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ 8< ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─
  48   │ 
  49   │ 
  50 ~ │ @define(slots=False)
  51   │ class AutolabelMixin:
  52   │     """Mixin class for schema tables that use autolabel metadata with automatic annotation."""
  53   │ 
  54 ~ │     automatic_annotation: bool = field(
  55 ~ │         default=False, validator=validators.instance_of(bool), kw_only=True
  56 ~ │     )
  57   │     autolabel_metadata: list[AutolabelModel] | None = field(
  58   │         default=None,
 ...   │ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ 8< ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─
  61   │             validators.deep_iterable(validators.instance_of(AutolabelModel))
  62   │         ),
  63 + │         kw_only=True,
  64   │     )
  65   │ 
───────┴──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
───────┬──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
       │ File: tests/schema/conftest.py
───────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
  63   │         "description": "",
  64   │         "index": None,
  65 ~ │         "has_number": False,
  66 ~ │         "has_orientation": False,
  67   │     }
  68   │ 
 ...   │ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ 8< ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─
 181   │         "next": "7b0ae1dae7531b7b917f403cb22259e6",
 182   │         "prev": "",
 183 ~ │         "automatic_annotation": True,
 184   │         "autolabel_metadata": [{"name": "centerpoint_v1.2", "score": 0.95, "uncertainty": 0.1}],
 185   │     }
 ...   │ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ 8< ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─
 321   │         "bbox": [0, 408.0529355733727, 1920, 728.1832152454293],
 322   │         "mask": {"size": [1920, 1280], "counts": "UFBQWzI='"},
 323 ~ │         "automatic_annotation": True,
 324   │         "autolabel_metadata": [
 325   │             {"name": "yolo_v8_segmentation", "score": 0.87, "uncertainty": 0.15},
───────┴──────────────────────────────────────────────────────────────────────────────────

slots=True provides memory efficiency and faster attribute access, but it causes type-error because of field layout conflict if we define subclass with multiple classes defined by @define(slots=True).
validators must be hashable, so we need to set multiple validators by using tuple or validators.and_ instead of list.
Attrs has a strict rule: fields with default values cannot before fields without default values in the inheritance hierachy. To avoid error relevant to this rule, we need to set kw_only=True for fields with default values.

What are `slots` in Python?

>>> class FooWithoutSlots:
...     """A class without slots"""
...     def __init__(self, n: int) -> None:
...             self.n = n
... 
>>> class FooWithSlots:
...     """A class with slots"""
...     __slots__ = ("n",)
...     def __init__(self, n: int) -> None:
...             self.n = n
... 
>>> foo1 = FooWithoutSlots(1)
>>> foo2 = FooWithSlots(1)
>>> 
>>> # FooWithoutSlots creates __dict__ every time when it is constructed, but FooWitSlots doesn't
>>> foo1.__dict__
{'n': 1}
>>> foo2.__dict__
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
AttributeError: 'FooWithSlots' object has no attribute '__dict__'. Did you mean: '__dir__'?
>>> # instead of creating __dict__, __slots__ stores all attribute names 
>>> foo2.__slots__
('n',)
>>> 
>>> # Then nobody can add new attributes to the instance that has __slots__
>>> foo1.bar = 2  # OK
>>> foo2.bar = 2  # ERROR
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
AttributeError: 'FooWithSlots' object has no attribute 'bar'

github-actions · 2025-09-03T08:08:18Z

☂️ Python Coverage

current status: ❌

Overall Coverage

Lines	Covered	Coverage	Threshold	Status
2676	2034	76%	50%	🟢

New Files

File	Coverage	Status
t4_devkit/schema/tables/autolabel_metadata.py	100%	🟢
TOTAL	100%	🟢

Modified Files

File	Coverage	Status
t4_devkit/schema/tables/init.py	100%	🟢
t4_devkit/schema/tables/category.py	100%	🟢
t4_devkit/schema/tables/object_ann.py	86%	🟢
t4_devkit/schema/tables/sample_annotation.py	100%	🟢
t4_devkit/schema/tables/sample_data.py	100%	🟢
t4_devkit/schema/tables/surface_ann.py	73%	🔴
TOTAL	93%	🔴

updated for commit: f6bd11a by action🐍

SamratThapa120 · 2025-09-03T08:19:50Z

@ktro2828 Thank you for your detailed comments. I have fixed the tests.
I will also add newer tests to improve code coverage soon.

SamratThapa120 · 2025-09-03T10:00:33Z

@ktro2828 I have added tests for t4_devkit/schema/tables/autolabel_metadata.py, The lack of coverage for object_ann.py and surface_ann.py predates this PR, and should be addressed separately.

ktro2828

LGTM

SamratThapa120 added 2 commits September 1, 2025 20:57

update table definitions

060ed99

remove lidarseg

e438f5f

github-actions Bot added chore documentation Improvements or additions to documentation labels Sep 1, 2025

SamratThapa120 and others added 5 commits September 1, 2025 12:12

style(pre-commit): autofix

7d8f8e2

Merge branch 'main' into chore/sync_table_definition

0fb953a

Merge github.com:tier4/t4-devkit into chore/sync_table_definition

fc9e1e8

updated tests

6e5a56e

Merge branch 'chore/sync_table_definition' of github.com:tier4/t4-dev…

909de73

…kit into chore/sync_table_definition

github-actions Bot added the ci Continuous Integration (CI) processes and testing label Sep 2, 2025

style(pre-commit): autofix

702e627

SamratThapa120 marked this pull request as ready for review September 2, 2025 02:36

Copilot AI review requested due to automatic review settings September 2, 2025 02:36

Copilot AI reviewed Sep 2, 2025

View reviewed changes

SamratThapa120 requested a review from ktro2828 September 2, 2025 02:38

ktro2828 requested changes Sep 2, 2025

View reviewed changes

SamratThapa120 and others added 3 commits September 2, 2025 18:25

Merge github.com:tier4/t4-devkit into chore/sync_table_definition

4eb7ce2

removed redundancy

014cdca

style(pre-commit): autofix

befb644

SamratThapa120 added 2 commits September 3, 2025 16:55

fixed test failures

8b239b4

add ke_only

585b609

style(pre-commit): autofix

3d78f83

added test for autolabel_metadata

6bdfb68

SamratThapa120 requested a review from ktro2828 September 3, 2025 10:00

ktro2828 approved these changes Sep 4, 2025

View reviewed changes

style(pre-commit): autofix

f6bd11a

SamratThapa120 force-pushed the chore/sync_table_definition branch from 87cf840 to f6bd11a Compare September 8, 2025 03:56

SamratThapa120 merged commit 0f2b28d into main Sep 8, 2025
5 checks passed

SamratThapa120 deleted the chore/sync_table_definition branch September 8, 2025 03:57

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

chore: sync table definition with tier4_perception_dataset#185

chore: sync table definition with tier4_perception_dataset#185
SamratThapa120 merged 16 commits into
mainfrom
chore/sync_table_definition

SamratThapa120 commented Sep 1, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

ktro2828 left a comment

Uh oh!

Uh oh!

ktro2828 Sep 2, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

ktro2828 commented Sep 2, 2025 •

edited

Loading

Uh oh!

github-actions Bot commented Sep 3, 2025 •

edited

Loading

Uh oh!

SamratThapa120 commented Sep 3, 2025

Uh oh!

SamratThapa120 commented Sep 3, 2025

Uh oh!

ktro2828 left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

SamratThapa120 commented Sep 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Autolabeling metadata support

Category and annotation field extensions

Documentation updates

Codebase integration

Validation and conversion logic

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

ktro2828 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ktro2828 Sep 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

ktro2828 commented Sep 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What are __slots__ in Python?

Uh oh!

github-actions Bot commented Sep 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

☂️ Python Coverage

Overall Coverage

New Files

Modified Files

Uh oh!

SamratThapa120 commented Sep 3, 2025

Uh oh!

SamratThapa120 commented Sep 3, 2025

Uh oh!

ktro2828 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

SamratThapa120 commented Sep 1, 2025 •

edited

Loading

ktro2828 Sep 2, 2025 •

edited

Loading

ktro2828 commented Sep 2, 2025 •

edited

Loading

What are `slots` in Python?

github-actions Bot commented Sep 3, 2025 •

edited

Loading