Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Lazy list for array field #8229

Merged
merged 17 commits into from
Aug 6, 2024
Merged

Lazy list for array field #8229

merged 17 commits into from
Aug 6, 2024

Conversation

Bobronium
Copy link
Member

@Bobronium Bobronium commented Jul 29, 2024

Motivation and context

Decided to split changes in this PR: #8223

  1. Annotations import (Optimize annotations import #8226)
  2. Array fields optimization (this PR)
  3. Logging function optimization (Remove deepcopy from handle_annotations_change #8228)

How has this been tested?

Checklist

  • I submit my changes into the develop branch
  • I have created a changelog fragment
  • I have updated the documentation accordingly
  • I have added tests to cover my changes
  • I have linked related issues (see GitHub docs)
  • I have increased versions of npm packages if it is necessary
    (cvat-canvas,
    cvat-core,
    cvat-data and
    cvat-ui)

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.

Summary by CodeRabbit

  • New Features

    • Introduced the LazyList class for efficient, on-demand parsing of list elements from strings.
    • Added support for custom transformations through a converter function.
    • Enhanced lazy evaluation with new decorators for improved performance on list operations.
  • Tests

    • Implemented a comprehensive test suite for the LazyList class, validating core functionalities and ensuring robustness.

Copy link
Contributor

coderabbitai bot commented Jul 29, 2024

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 recent changes enhance the LazyList class in the cvat/apps/engine/models.py file, introducing lazy evaluation for list elements derived from strings. Key features include new decorators for parsing on access, a customizable constructor, improved representation, and deep copying capabilities. A corresponding test suite in test_lazy_list.py ensures the robustness of these modifications, validating functionality and integration with standard list operations.

Changes

File Change Summary
cvat/apps/engine/models.py Enhanced LazyList class with lazy evaluation features, new decorators, customizable constructors, and state management.
cvat/apps/engine/tests/test_lazy_list.py Added comprehensive unit tests for LazyList, covering various list operations and ensuring robustness.

Poem

In fields of code where bunnies play,
A LazyList hops in a clever way.
With lazy grace, it parses anew,
Each string it nibbles, just for you.
Testing its charm, a dance so neat,
Now watch it leap, oh what a treat! 🐇✨


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
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 Configuration 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.

1. Support pickling
2. Handle cases where LazyList is extended with/added to another LazyList
3. Fix cases when unparsed LazyList was being compared result
4. Fix cases when deep copying resulted in duplicate values
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

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 9306dce and 2a68e50.

Files selected for processing (2)
  • cvat/apps/engine/models.py (3 hunks)
  • cvat/apps/engine/tests/test_lazy_list.py (1 hunks)
Additional comments not posted (28)
cvat/apps/engine/tests/test_lazy_list.py (28)

16-19: LGTM!

The test_skipped_values function correctly tests the handling of skipped values in the LazyList.


21-24: LGTM!

The test_len function correctly tests the length of the LazyList.


26-31: LGTM!

The test_repr function correctly tests the string representation of the LazyList.


33-37: LGTM!

The test_deepcopy function correctly tests the deep copy functionality of the LazyList.


39-41: LGTM!

The test_getitem function correctly tests the item access functionality of the LazyList.


43-49: LGTM!

The test_iter function correctly tests the iterator functionality of the LazyList.


51-53: LGTM!

The test_append function correctly tests the append functionality of the LazyList.


55-57: LGTM!

The test_copy function correctly tests the copy functionality of the LazyList.


59-61: LGTM!

The test_insert function correctly tests the insert functionality of the LazyList.


63-66: LGTM!

The test_pop function correctly tests the pop functionality of the LazyList.


68-70: LGTM!

The test_remove function correctly tests the remove functionality of the LazyList.


72-74: LGTM!

The test_reverse function correctly tests the reverse functionality of the LazyList.


76-79: LGTM!

The test_sort function correctly tests the sort functionality of the LazyList.


81-83: LGTM!

The test_clear function correctly tests the clear functionality of the LazyList.


85-86: LGTM!

The test_index function correctly tests the index functionality of the LazyList.


88-89: LGTM!

The test_count function correctly tests the count functionality of the LazyList.


91-93: LGTM!

The test_setitem function correctly tests the set item functionality of the LazyList.


95-97: LGTM!

The test_delitem function correctly tests the delete item functionality of the LazyList.


99-100: LGTM!

The test_contains function correctly tests the contains functionality of the LazyList.


102-103: LGTM!

The test_reversed function correctly tests the reversed functionality of the LazyList.


105-106: LGTM!

The test_mul function correctly tests the multiplication functionality of the LazyList.


108-109: LGTM!

The test_rmul function correctly tests the reverse multiplication functionality of the LazyList.


111-113: LGTM!

The test_imul function correctly tests the in-place multiplication functionality of the LazyList.


115-117: LGTM!

The test_extend function correctly tests the extend functionality of the LazyList.


119-121: LGTM!

The test_add function correctly tests the addition functionality of the LazyList.


123-124: LGTM!

The test_eq function correctly tests the equality functionality of the LazyList.


126-128: LGTM!

The test_iadd function correctly tests the in-place addition functionality of the LazyList.


130-162: LGTM!

The test functions correctly test the respective functionalities of the LazyList.

zhiltsov-max pushed a commit that referenced this pull request Jul 31, 2024
<!-- Raise an issue to propose your change
(https://github.com/cvat-ai/cvat/issues).
It helps to avoid duplication of efforts from multiple independent
contributors.
Discuss your ideas with maintainers to be sure that changes will be
approved and merged.
Read the [Contribution guide](https://docs.cvat.ai/docs/contributing/).
-->

<!-- Provide a general summary of your changes in the Title above -->

### Motivation and context
Decided to split changes in this PR:
#8223

1. Annotations import (#8226)
2. Array fields optimization (#8229)
3. Logging function optimization (this PR)

### How has this been tested?
<!-- Please describe in detail how you tested your changes.
Include details of your testing environment, and the tests you ran to
see how your change affects other areas of the code, etc. -->

### Checklist
<!-- Go over all the following points, and put an `x` in all the boxes
that apply.
If an item isn't applicable for some reason, then ~~explicitly
strikethrough~~ the whole
line. If you don't do that, GitHub will show incorrect progress for the
pull request.
If you're unsure about any of these, don't hesitate to ask. We're here
to help! -->
- [x] I submit my changes into the `develop` branch
- [ ] I have created a changelog fragment <!-- see top comment in
CHANGELOG.md -->
- [ ] I have updated the documentation accordingly
- [ ] I have added tests to cover my changes
- [ ] I have linked related issues (see [GitHub docs](

https://help.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword))
- [ ] I have increased versions of npm packages if it is necessary

([cvat-canvas](https://github.com/cvat-ai/cvat/tree/develop/cvat-canvas#versioning),

[cvat-core](https://github.com/cvat-ai/cvat/tree/develop/cvat-core#versioning),

[cvat-data](https://github.com/cvat-ai/cvat/tree/develop/cvat-data#versioning)
and

[cvat-ui](https://github.com/cvat-ai/cvat/tree/develop/cvat-ui#versioning))

### License

- [x] I submit _my code changes_ under the same [MIT License](
https://github.com/cvat-ai/cvat/blob/develop/LICENSE) that covers the
project.
  Feel free to contact the maintainers if that's a concern.


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **Bug Fixes**
- Improved data integrity by ensuring annotations change handling occurs
every time an item is deleted.

- **New Features**
- Enhanced data filtering logic for annotations, allowing for more
efficient processing without unnecessary deep copies.
- Introduced a new function for streamlined filtering of track data,
simplifying data management.

- **Refactor**
- Consolidated data filtering into reusable functions for better
maintainability and clarity.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
zhiltsov-max pushed a commit that referenced this pull request Jul 31, 2024
<!-- Raise an issue to propose your change
(https://github.com/cvat-ai/cvat/issues).
It helps to avoid duplication of efforts from multiple independent
contributors.
Discuss your ideas with maintainers to be sure that changes will be
approved and merged.
Read the [Contribution guide](https://docs.cvat.ai/docs/contributing/).
-->

<!-- Provide a general summary of your changes in the Title above -->

### Motivation and context
Decided to split changes in this PR:
#8223
1. Annotations import (this PR)
2. Array fields optimization (#8229)
3. Logging function optimization
(#8228)

### How has this been tested?
<!-- Please describe in detail how you tested your changes.
Include details of your testing environment, and the tests you ran to
see how your change affects other areas of the code, etc. -->

### Checklist
<!-- Go over all the following points, and put an `x` in all the boxes
that apply.
If an item isn't applicable for some reason, then ~~explicitly
strikethrough~~ the whole
line. If you don't do that, GitHub will show incorrect progress for the
pull request.
If you're unsure about any of these, don't hesitate to ask. We're here
to help! -->
- [x] I submit my changes into the `develop` branch
- [ ] I have created a changelog fragment <!-- see top comment in
CHANGELOG.md -->
- [ ] I have updated the documentation accordingly
- [ ] I have added tests to cover my changes
- [ ] I have linked related issues (see [GitHub docs](

https://help.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword))
- [ ] I have increased versions of npm packages if it is necessary

([cvat-canvas](https://github.com/cvat-ai/cvat/tree/develop/cvat-canvas#versioning),

[cvat-core](https://github.com/cvat-ai/cvat/tree/develop/cvat-core#versioning),

[cvat-data](https://github.com/cvat-ai/cvat/tree/develop/cvat-data#versioning)
and

[cvat-ui](https://github.com/cvat-ai/cvat/tree/develop/cvat-ui#versioning))

### License

- [x] I submit _my code changes_ under the same [MIT License](
https://github.com/cvat-ai/cvat/blob/develop/LICENSE) that covers the
project.
  Feel free to contact the maintainers if that's a concern.


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **New Features**
- Improved data type consistency for shape points during the annotation
loading process, ensuring all coordinates are treated as numeric values.
- Enhanced clarity and reliability in loading various shape types (box,
ellipse, cuboid, mask) by converting relevant attributes to floats.

- **Bug Fixes**
- Removed redundant database initialization calls during annotation
import, potentially improving the efficiency of the import process.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
cvat/apps/engine/models.py Outdated Show resolved Hide resolved
cvat/apps/engine/models.py Outdated Show resolved Hide resolved
cvat/apps/engine/models.py Outdated Show resolved Hide resolved
cvat/apps/engine/models.py Outdated Show resolved Hide resolved
cvat/apps/engine/models.py Outdated Show resolved Hide resolved
cvat/apps/engine/models.py Outdated Show resolved Hide resolved
cvat/apps/engine/tests/test_lazy_list.py Show resolved Hide resolved
@codecov-commenter
Copy link

codecov-commenter commented Jul 31, 2024

Codecov Report

Attention: Patch coverage is 98.52941% with 2 lines in your changes missing coverage. Please review.

Project coverage is 83.40%. Comparing base (9306dce) to head (dcf4b3d).
Report is 6 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #8229      +/-   ##
===========================================
+ Coverage    83.30%   83.40%   +0.09%     
===========================================
  Files          388      389       +1     
  Lines        41352    41526     +174     
  Branches      3856     3856              
===========================================
+ Hits         34450    34636     +186     
+ Misses        6902     6890      -12     
Components Coverage Δ
cvat-ui 79.72% <ø> (+0.09%) ⬆️
cvat-server 86.67% <98.52%> (+0.07%) ⬆️

Copy link

sonarcloud bot commented Aug 1, 2024

@zhiltsov-max zhiltsov-max merged commit 5b4e199 into develop Aug 6, 2024
33 checks passed
@bsekachev bsekachev deleted the lazy-list-for-array-field branch August 12, 2024 09:08
@Bobronium Bobronium mentioned this pull request Aug 13, 2024
7 tasks
zhiltsov-max pushed a commit that referenced this pull request Aug 13, 2024
<!-- Raise an issue to propose your change
(https://github.com/cvat-ai/cvat/issues).
It helps to avoid duplication of efforts from multiple independent
contributors.
Discuss your ideas with maintainers to be sure that changes will be
approved and merged.
Read the [Contribution guide](https://docs.cvat.ai/docs/contributing/).
-->

<!-- Provide a general summary of your changes in the Title above -->

### Motivation and context
Following
[v2.16.2](https://github.com/cvat-ai/cvat/releases/tag/v2.16.2) release,
we noticed an issue with annotations export with CVAT format and masks.

Upon investigation, we found that the problem stemmed from changes
introduced in this PR: #8229.

The issue was caused by the improper handling of slices with negative
positions in LazyList, particularly affecting the computation of
resulting data. This behaviour was triggered by the following line:

https://github.com/cvat-ai/cvat/blob/cfce7be5a9422da2c367296f56d70181185f503e/cvat/apps/dataset_manager/formats/cvat.py#L797


<!-- Why is this change required? What problem does it solve? If it
fixes an open
issue, please link to the issue here. Describe your changes in detail,
add
screenshots. -->

### How has this been tested?
<!-- Please describe in detail how you tested your changes.
Include details of your testing environment, and the tests you ran to
see how your change affects other areas of the code, etc. -->

### Checklist
<!-- Go over all the following points, and put an `x` in all the boxes
that apply.
If an item isn't applicable for some reason, then ~~explicitly
strikethrough~~ the whole
line. If you don't do that, GitHub will show incorrect progress for the
pull request.
If you're unsure about any of these, don't hesitate to ask. We're here
to help! -->
- [x] I submit my changes into the `develop` branch
- [x] I have created a changelog fragment <!-- see top comment in
CHANGELOG.md -->
- [ ] I have updated the documentation accordingly
- [x] I have added tests to cover my changes
- [ ] I have linked related issues (see [GitHub docs](

https://help.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword))
- [ ] I have increased versions of npm packages if it is necessary

([cvat-canvas](https://github.com/cvat-ai/cvat/tree/develop/cvat-canvas#versioning),

[cvat-core](https://github.com/cvat-ai/cvat/tree/develop/cvat-core#versioning),

[cvat-data](https://github.com/cvat-ai/cvat/tree/develop/cvat-data#versioning)
and

[cvat-ui](https://github.com/cvat-ai/cvat/tree/develop/cvat-ui#versioning))

### License

- [x] I submit _my code changes_ under the same [MIT License](
https://github.com/cvat-ai/cvat/blob/develop/LICENSE) that covers the
project.
  Feel free to contact the maintainers if that's a concern.


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **New Features**
- Enhanced handling of negative indices in list slicing, improving
robustness and performance.
- Added new test methods to validate slicing operations, ensuring
correct behavior for various scenarios.

- **Bug Fixes**
- Adjusted existing tests to account for empty values in the list,
improving accuracy of expected outputs.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants