x4d-devkit 0.49.0__tar.gz → 0.50.0__tar.gz

{x4d_devkit-0.49.0 → x4d_devkit-0.50.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: x4d-devkit
-Version: 0.49.0
+Version: 0.50.0
 Summary: Official X-4D external SDK and CLI for datasets, platform APIs, training bridges, and automation
 Author: windzu
 License-Expression: Apache-2.0

{x4d_devkit-0.49.0 → x4d_devkit-0.50.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "x4d-devkit"
-version = "0.49.0"
+version = "0.50.0"
 description = "Official X-4D external SDK and CLI for datasets, platform APIs, training bridges, and automation"
 readme = "README.md"
 license = "Apache-2.0"

x4d_devkit-0.50.0/tests/test_image_groups.py

@@ -0,0 +1,249 @@
+from copy import deepcopy
+
+import pytest
+
+from tests.image_fixtures import clip_payload, line_object
+from x4d_devkit._image_contract import canonical
+from x4d_devkit.image_clip import build_image_identity, parse_image_clip
+from x4d_devkit.image_groups import (
+    IMAGE_OBJECT_GROUPS_VERSION,
+    parse_image_object_groups,
+)
+from x4d_devkit.image_schema import parse_image_schema_body
+from x4d_devkit.image_schema_upgrade import additive_image_schema_changes
+from x4d_devkit.image_work_session import (
+    IMAGE_WORK_SESSION_VERSION,
+    build_image_submit,
+    image_candidate,
+    parse_image_submit,
+    parse_image_work_session,
+)
+
+
+def grouped_payload():
+    value = clip_payload()
+    body = value["label_schema"]["body"]
+    body["categories"][0]["groupable"] = True
+    value["label_schema"]["identity"] = parse_image_schema_body(body).identity.to_dict()
+    first = line_object()
+    second = deepcopy(first)
+    second["id"] = "line_b"
+    second["attributes"] = {"visible": True}
+    second["attribute_ranges"][0]["attributes"] = {"style": "b"}
+    value["image_annotation"]["objects"] = [first, second]
+    value["image_annotation"]["object_groups"] = {
+        "contract_version": IMAGE_OBJECT_GROUPS_VERSION,
+        "groups": [
+            {
+                "id": "group_1",
+                "image_id": "image_a",
+                "view_id": "objects",
+                "object_ids": ["line_a", "line_b"],
+            }
+        ],
+    }
+    value["identity"] = build_image_identity(value)
+    return value
+
+
+def test_relations_preserve_independent_objects_and_all_source_components():
+    value = grouped_payload()
+    original = deepcopy(value)
+    clip = parse_image_clip(value)
+    assert clip.to_dict() == original
+    session = parse_image_work_session(
+        {"contract_version": IMAGE_WORK_SESSION_VERSION, "clip": value}
+    )
+    request = build_image_submit(session, value["image_annotation"]).to_dict()
+    assert (
+        parse_image_submit(request).to_dict()["image_annotation"]
+        == original["image_annotation"]
+    )
+    candidate = image_candidate(session.clip, request["image_annotation"]).to_dict()
+    assert candidate == original
+    value["image_annotation"]["object_groups"]["groups"][0]["object_ids"].clear()
+    assert clip.to_dict() == original
+
+
+def test_relation_changes_enter_revision_without_changing_geometry_or_source():
+    value = grouped_payload()
+    before = parse_image_clip(value)
+    annotation = deepcopy(value["image_annotation"])
+    annotation["object_groups"]["groups"][0]["id"] = "changed_group_identity"
+    after = image_candidate(before, annotation).to_dict()
+    for name in ("source_revision", "schema_fingerprint"):
+        assert after["identity"][name] == value["identity"][name]
+    for name in ("annotation_revision", "clip_revision"):
+        assert after["identity"][name] != value["identity"][name]
+    assert after["image_annotation"]["objects"] == value["image_annotation"]["objects"]
+    assert (
+        after["image_annotation"]["completion"]
+        == value["image_annotation"]["completion"]
+    )
+    annotation["object_groups"]["groups"] = []
+    ungrouped = image_candidate(before, annotation).to_dict()
+    assert (
+        ungrouped["image_annotation"]["objects"] == value["image_annotation"]["objects"]
+    )
+    assert ungrouped["image_annotation"]["object_groups"]["groups"] == []
+
+
+def test_existing_documents_remain_byte_identical_and_do_not_infer_groups():
+    old = clip_payload()
+    assert canonical(parse_image_clip(old).to_dict()) == canonical(old)
+    assert (
+        "groupable"
+        not in parse_image_schema_body(old["label_schema"]["body"]).to_dict()[
+            "categories"
+        ][0]
+    )
+    value = grouped_payload()
+    del value["image_annotation"]["object_groups"]
+    value["identity"] = build_image_identity(value)
+    parsed = parse_image_clip(value).to_dict()
+    assert "object_groups" not in parsed["image_annotation"]
+    assert (
+        parsed["image_annotation"]["objects"][0]["geometry"]
+        == parsed["image_annotation"]["objects"][1]["geometry"]
+    )
+    assert canonical(parsed) == canonical(value)
+
+
+@pytest.mark.parametrize(
+    "change",
+    [
+        "unknown_member",
+        "one_member",
+        "empty_members",
+        "duplicate_member",
+        "duplicate_group",
+        "duplicate_membership",
+        "cross_image",
+        "cross_view",
+        "disallowed_category",
+        "missing_permission",
+        "false_permission",
+        "colliding_id",
+        "unknown_version",
+        "null_fragment",
+        "extra_fragment",
+        "extra_group",
+        "object_provenance",
+        "geometry_mismatch",
+        "removed_member",
+        "non_array_members",
+    ],
+)
+def test_invalid_relations_fail_with_paths_without_repair(change):
+    value = grouped_payload()
+    annotation = value["image_annotation"]
+    fragment = annotation["object_groups"]
+    group = fragment["groups"][0]
+    if change == "unknown_member":
+        group["object_ids"][1] = "missing"
+    elif change == "one_member":
+        group["object_ids"].pop()
+    elif change == "empty_members":
+        group["object_ids"] = []
+    elif change == "duplicate_member":
+        group["object_ids"][1] = "line_a"
+    elif change == "duplicate_group":
+        fragment["groups"].append(deepcopy(group))
+    elif change == "duplicate_membership":
+        fragment["groups"].append({**group, "id": "group_2"})
+    elif change == "cross_image":
+        group["image_id"] = "another_image"
+    elif change == "cross_view":
+        group["view_id"] = "semantics"
+    elif change == "disallowed_category":
+        annotation["objects"][1].update(
+            category_id="box",
+            attributes={},
+            attribute_ranges=[],
+            geometry={
+                "geometry_type": "box_2d",
+                "box": {"x_min": 1, "y_min": 2, "x_max": 10, "y_max": 20},
+            },
+        )
+    elif change == "missing_permission":
+        del value["label_schema"]["body"]["categories"][0]["groupable"]
+    elif change == "false_permission":
+        value["label_schema"]["body"]["categories"][0]["groupable"] = False
+    elif change == "colliding_id":
+        group["id"] = "line_a"
+    elif change == "unknown_version":
+        fragment["contract_version"] = "unknown"
+    elif change == "null_fragment":
+        annotation["object_groups"] = None
+    elif change == "extra_fragment":
+        fragment["origin"] = "split"
+    elif change == "extra_group":
+        group["origin"] = "split"
+    elif change == "object_provenance":
+        annotation["objects"][0]["split_from"] = "original"
+    elif change == "geometry_mismatch":
+        annotation["objects"][1]["geometry"]["geometry_type"] = "box_2d"
+    elif change == "removed_member":
+        annotation["objects"].pop()
+    elif change == "non_array_members":
+        group["object_ids"] = "line_a,line_b"
+    body = value["label_schema"]["body"]
+    value["label_schema"]["identity"] = parse_image_schema_body(body).identity.to_dict()
+    value["identity"] = build_image_identity(value)
+    original = deepcopy(value)
+    with pytest.raises(ValueError) as caught:
+        parse_image_clip(value)
+    assert caught.value.path
+    assert value == original
+
+
+@pytest.mark.parametrize("value", [None, 0, 1, "true", [], {}])
+def test_grouping_permission_is_an_explicit_boolean(value):
+    body = clip_payload()["label_schema"]["body"]
+    body["categories"][0]["groupable"] = value
+    with pytest.raises(ValueError) as caught:
+        parse_image_schema_body(body)
+    assert caught.value.path.endswith("groupable")
+
+
+def test_unknown_business_category_can_use_groups_without_a_catalogue():
+    value = grouped_payload()
+    body = value["label_schema"]["body"]
+    body["categories"][0]["id"] = "new_business_after_sdk_release"
+    body["task_views"][0]["category_ids"][0] = "new_business_after_sdk_release"
+    for row in value["image_annotation"]["objects"]:
+        row["category_id"] = "new_business_after_sdk_release"
+    value["label_schema"]["identity"] = parse_image_schema_body(body).identity.to_dict()
+    value["identity"] = build_image_identity(value)
+    assert parse_image_clip(value).to_dict() == value
+
+
+def test_empty_fragment_is_valid_and_is_not_injected_when_absent():
+    assert (
+        parse_image_object_groups(
+            {"contract_version": IMAGE_OBJECT_GROUPS_VERSION, "groups": []}
+        ).to_dict()["groups"]
+        == []
+    )
+    value = clip_payload()
+    annotation = deepcopy(value["image_annotation"])
+    annotation["object_groups"] = {
+        "contract_version": IMAGE_OBJECT_GROUPS_VERSION,
+        "groups": [],
+    }
+    assert (
+        image_candidate(parse_image_clip(value), annotation).to_dict()[
+            "image_annotation"
+        ]
+        == annotation
+    )
+    assert "object_groups" not in parse_image_clip(value).to_dict()["image_annotation"]
+
+
+def test_grouping_permission_changes_are_not_silently_additive_upgrades():
+    old = clip_payload()["label_schema"]["body"]
+    new = deepcopy(old)
+    new["version"] = "2.0.0"
+    new["categories"][0]["groupable"] = True
+    with pytest.raises(ValueError):
+        additive_image_schema_changes(old, new)

{x4d_devkit-0.49.0 → x4d_devkit-0.50.0}/tests/test_sdk_api.py

@@ -11,7 +11,7 @@ from x4d_devkit.eval.matching import MetricData
 
 
 def test_package_version_is_current_release():
-    assert x4d_devkit.__version__ == "0.49.0"
+    assert x4d_devkit.__version__ == "0.50.0"
 
 
 def test_loader_exposes_and_enforces_only_current_schema(tmp_path):

{x4d_devkit-0.49.0 → x4d_devkit-0.50.0}/x4d_devkit/_image_contract.py

@@ -26,10 +26,20 @@ def require(condition: bool, message: str, path: str) -> None:
         )
 
 
-def fields(value: Any, expected: set[str], path: str) -> None:
+def fields(
+    value: Any,
+    expected: set[str],
+    path: str,
+    *,
+    optional: frozenset[str] | set[str] = frozenset(),
+) -> None:
     require(
-        type(value) is dict and set(value) == expected,
-        f"expected exactly {sorted(expected)}",
+        type(value) is dict and expected <= set(value) <= expected | optional,
+        (
+            f"expected exactly {sorted(expected)}"
+            if not optional
+            else f"expected required {sorted(expected)} and only optional {sorted(optional)}"
+        ),
         path,
     )
 

{x4d_devkit-0.49.0 → x4d_devkit-0.50.0}/x4d_devkit/image_clip.py

@@ -25,6 +25,7 @@ from x4d_devkit._image_contract import (
     unique_ids,
 )
 from x4d_devkit.image_geometry import parse_image_attribute_ranges, parse_image_geometry
+from x4d_devkit.image_groups import validate_image_object_groups
 from x4d_devkit.image_schema import parse_image_schema_snapshot
 
 
@@ -243,6 +244,7 @@ def validate_image_annotations(
         value,
         {"contract_version", "clip_id", "objects", "descriptions", "completion"},
         "image_annotation",
+        optional={"object_groups"},
     )
     require(
         value["contract_version"] == IMAGE_ANNOTATION_CONTRACT_VERSION
@@ -328,6 +330,13 @@ def validate_image_annotations(
                 path + ".attribute_ranges",
             )
         occupied.add((row["image_id"], row["view_id"]))
+    if "object_groups" in value:
+        validate_image_object_groups(
+            value["object_groups"],
+            objects=objects,
+            categories=categories,
+            result_ids=set(objects) | set(descriptions),
+        )
     for name, row in descriptions.items():
         path = "image_annotation.descriptions." + name
         fields(row, {"id", "image_id", "view_id", "target_id", "fields"}, path)

x4d_devkit-0.50.0/x4d_devkit/image_groups.py

@@ -0,0 +1,83 @@
+"""Explicit native image object membership; no business names or edit provenance."""
+
+from typing import Any
+
+from x4d_devkit._image_contract import (
+    ImageDocument,
+    canonical,
+    document,
+    fields,
+    identifier,
+    require,
+    rows,
+    unique_ids,
+)
+
+IMAGE_OBJECT_GROUPS_VERSION = "x4d-image-object-groups-v1"
+
+
+def parse_image_object_groups(value: Any) -> ImageDocument:
+    """Validate the exact versioned fragment, preserving its IDs and ordering."""
+    canonical(value)
+    fields(value, {"contract_version", "groups"}, "object_groups")
+    require(
+        value["contract_version"] == IMAGE_OBJECT_GROUPS_VERSION,
+        "unsupported image object-group version",
+        "object_groups.contract_version",
+    )
+    groups = unique_ids(value["groups"], "object_groups.groups", nonempty=False)
+    occupied = set()
+    for name, group in groups.items():
+        path = "object_groups.groups." + name
+        fields(group, {"id", "image_id", "view_id", "object_ids"}, path)
+        identifier(group["image_id"], path + ".image_id")
+        identifier(group["view_id"], path + ".view_id")
+        members = rows(group["object_ids"], path + ".object_ids")
+        require(
+            len(members) >= 2,
+            "a group requires at least two objects",
+            path + ".object_ids",
+        )
+        for index, member in enumerate(members):
+            member_path = f"{path}.object_ids[{index}]"
+            identifier(member, member_path)
+            require(
+                member not in occupied,
+                "object is repeated or belongs to another group",
+                member_path,
+            )
+            occupied.add(member)
+    return document(value)
+
+
+def validate_image_object_groups(
+    value: Any, *, objects: dict, categories: dict, result_ids: set[str]
+) -> ImageDocument:
+    """Check membership in the already validated complete Annotation context."""
+    parsed = parse_image_object_groups(value)
+    for group in parsed.to_dict()["groups"]:
+        path = "image_annotation.object_groups.groups." + group["id"]
+        require(
+            group["id"] not in result_ids,
+            "result IDs must be Clip-unique",
+            path + ".id",
+        )
+        for index, member in enumerate(group["object_ids"]):
+            member_path = f"{path}.object_ids[{index}]"
+            require(member in objects, "unknown group member", member_path)
+            row = objects[member]
+            require(
+                row["image_id"] == group["image_id"]
+                and row["view_id"] == group["view_id"],
+                "group members must share the same image and task view",
+                member_path,
+            )
+            require(
+                categories[row["category_id"]].get("groupable") is True,
+                "member category does not permit grouping",
+                member_path,
+            )
+    return parsed
+
+
+__all__ = ["IMAGE_OBJECT_GROUPS_VERSION", "parse_image_object_groups"]

{x4d_devkit-0.49.0 → x4d_devkit-0.50.0}/x4d_devkit/image_schema.py

@@ -135,7 +135,14 @@ def parse_image_schema_body(value: Any) -> ImageSchemaBody:
             category,
             {"id", "display_name", "geometry_type", "color", "attributes"},
             path,
+            optional={"groupable"},
         )
+        if "groupable" in category:
+            require(
+                type(category["groupable"]) is bool,
+                "groupable must be boolean",
+                path + ".groupable",
+            )
         text(category["display_name"], path + ".display_name")
         require(
             type(category["geometry_type"]) is str

{x4d_devkit-0.49.0 → x4d_devkit-0.50.0}/x4d_devkit/image_work_session.py

@@ -19,6 +19,7 @@ from x4d_devkit.image_clip import (
     build_image_identity,
     parse_image_clip,
 )
+from x4d_devkit.image_groups import parse_image_object_groups
 
 
 IMAGE_WORK_SESSION_VERSION = "x4d-image-work-session-v1"
@@ -89,7 +90,10 @@ def parse_image_submit(value: Any) -> ImageDocument:
         value["image_annotation"],
         {"contract_version", "clip_id", "objects", "descriptions", "completion"},
         "image_submit.image_annotation",
+        optional={"object_groups"},
     )
+    if "object_groups" in value["image_annotation"]:
+        parse_image_object_groups(value["image_annotation"]["object_groups"])
     require(
         value["image_annotation"]["clip_id"] == value["clip_id"],
         "candidate belongs to another Clip",

{x4d_devkit-0.49.0 → x4d_devkit-0.50.0}/x4d_devkit.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: x4d-devkit
-Version: 0.49.0
+Version: 0.50.0
 Summary: Official X-4D external SDK and CLI for datasets, platform APIs, training bridges, and automation
 Author: windzu
 License-Expression: Apache-2.0

{x4d_devkit-0.49.0 → x4d_devkit-0.50.0}/x4d_devkit.egg-info/SOURCES.txt

@@ -27,6 +27,7 @@ tests/test_export_bundle.py
 tests/test_image_clip.py
 tests/test_image_export.py
 tests/test_image_geometry.py
+tests/test_image_groups.py
 tests/test_image_preannotation.py
 tests/test_image_reference.py
 tests/test_image_review.py
@@ -84,6 +85,7 @@ x4d_devkit/export_bundle.py
 x4d_devkit/image_clip.py
 x4d_devkit/image_export.py
 x4d_devkit/image_geometry.py
+x4d_devkit/image_groups.py
 x4d_devkit/image_preannotation.py
 x4d_devkit/image_reference.py
 x4d_devkit/image_review.py