skeletons in datumaro format

[Eldies]

Summary

• Added skeletons for datumaro format

How to test

unit tests

Checklist

• I submit my changes into the develop branch
• I have added description of my changes into CHANGELOG
• I have updated the documentation accordingly
• I have added tests to cover my changes
• I have linked related issues

License

• I submit my code changes under the same MIT License that covers the project.
  Feel free to contact the maintainers if that's a concern.
• I have updated the license header for each file (see an example below)

# Copyright (C) 2022 CVAT.ai Corporation
#
# SPDX-License-Identifier: MIT

Summary by CodeRabbit

• New Features

  • Introduced support for skeleton annotations in the Datumaro format.
  • Enhanced the env.detect_dataset() function to return a list of detected formats at all recursion levels.

• Bug Fixes

  • Improved annotation handling by allowing Category.from_iterable to accept a broader range of iterable types.

• Tests

  • Added new tests to ensure proper saving and loading of skeleton annotations.

[coderabbitai]

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The update implements skeleton support in the Datumaro format and enhances the env.detect_dataset() function to identify dataset formats at all recursion levels. The Category class's from_iterable method now accepts any iterable of union types, and significant modifications were made to include and handle the new Skeleton type across converters, extractors, and tests.

Changes

Files	Change Summary
CHANGELOG.md	Documented the introduction of skeleton support and enhancements to dataset detection.
datumaro/components/annotation.py	Updated from_iterable in Category class to accept an Iterable of union types.
datumaro/plugins/datumaro_format/converter.py, datumaro/plugins/datumaro_format/extractor.py	Added support for Skeleton type in converter and extractor methods, including necessary imports.
tests/test_datumaro_format.py	Introduced tests for saving and loading Skeleton annotations.

Poem

In Datumaro's code, new features bloom,
Skeletons dance in data's room.
Categories now with types so free,
Enhanced detections for all to see.
Tests ensure it’s working right,
Data's future, shining bright.
🐇✨📊

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 5b8ef82 and 4438410.

Files selected for processing (5)

• CHANGELOG.md (1 hunks)
• datumaro/components/annotation.py (1 hunks)
• datumaro/plugins/datumaro_format/converter.py (3 hunks)
• datumaro/plugins/datumaro_format/extractor.py (2 hunks)
• tests/test_datumaro_format.py (2 hunks)

Additional comments not posted (6)

datumaro/plugins/datumaro_format/extractor.py (1)

255-267: Handling Skeleton annotations looks good.

The addition of the Skeleton annotation type in the _load_annotations function is correct. The nested call to _load_annotations ensures that skeleton elements are properly loaded.

datumaro/plugins/datumaro_format/converter.py (2)

147-148: Handling Skeleton annotations in _SubsetWriter looks good.

The addition of the Skeleton annotation type in _SubsetWriter is correct and ensures Skeleton annotations are processed correctly.

---

272-280: The _convert_skeleton_object method looks good.

The _convert_skeleton_object method correctly converts Skeleton annotations, including converting its elements to points objects.

tests/test_datumaro_format.py (1)

524-581: The test_can_save_and_load_with_skeleton method looks good.

The new test method test_can_save_and_load_with_skeleton correctly tests the saving and loading of Skeleton annotations, including various attributes and elements.

datumaro/components/annotation.py (1)

711-715: The from_iterable method in PointsCategories looks good.

The updated from_iterable method correctly handles the new iterable type, enhancing flexibility in input structure.

CHANGELOG.md (1)

46-47: LGTM!

The entry correctly documents the addition of skeleton support in the datumaro format. Including the reference to the pull request is a good practice for traceability.

[zhiltsov-max]

Could you add a skeleton annotation example in the dataset here? We store dataset examples in different formats there.

[Eldies]

Could you add a skeleton annotation example in the dataset here? We store dataset examples in different formats there.

Done

[zhiltsov-max]

These examples are parsed in the tests. I suggest that this example is merged with the existing dataset or a separate parsing test is added.

[Eldies]

These examples are parsed in the tests. I suggest that this example is merged with the existing dataset or a separate parsing test is added.

Done

[sonarcloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud