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

Memory optimisation #8382

Merged
merged 7 commits into from
Sep 4, 2024
Merged

Memory optimisation #8382

merged 7 commits into from
Sep 4, 2024

Conversation

Bobronium
Copy link
Member

@Bobronium Bobronium commented Aug 30, 2024

Motivation and context

By using tuple as a container for points when dealing with import from datumaro, we can achieve 2 things:

  • Reduce memory needed for copying shapes and tracks during import (running deepcopy on tuple[int] will return the same object, as opposed to list[int])
  • Guarantee type safety during later stages of data pipeline and skip additional conversion added in Convert points to float in import #1898

Same thing arguable should be done for CVAT format as well.

Benchmarks: memray_reports.zip

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

    • Improved handling of shape points during the import process for enhanced data accuracy.
    • Centralized conversion of shape points to floats, optimizing memory usage and performance.
  • Refactor

    • Enhanced code readability and maintainability by restructuring the point conversion logic.

Copy link
Contributor

coderabbitai bot commented Aug 30, 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 changes involve refactoring the dataset manager bindings in cvat/apps/dataset_manager/bindings.py. A new private method, _ensure_points_converted_to_floats, has been introduced to centralize the conversion of shape points to floats during the import process. This modification improves code organization and optimizes memory usage. Additionally, the construction of points in the import_dm_annotations function has been updated to utilize tuple unpacking.

Changes

Files Change Summary
cvat/apps/dataset_manager/bindings.py Introduced _ensure_points_converted_to_floats method for centralized point conversion; updated point construction in import_dm_annotations to use tuple unpacking.

Poem

In the dataset's warren, changes abound,
A method to convert, where clarity's found.
With points now in tuples, oh what a delight,
Memory saved, code shines so bright!
Hopping through bindings, I cheer with glee,
For a tidy new world, just wait and see! 🐇✨


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

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

@Bobronium Bobronium marked this pull request as ready for review August 30, 2024 14:25
@Bobronium Bobronium removed the request for review from zhiltsov-max August 30, 2024 14:27
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 878bb41 and 3954fa2.

Files selected for processing (1)
  • cvat/apps/dataset_manager/bindings.py (4 hunks)
Additional comments not posted (3)
cvat/apps/dataset_manager/bindings.py (3)

540-540: Refactor: Centralize point conversion logic.

The addition of _ensure_points_converted_to_floats method centralizes the conversion of points to floats, which is a significant improvement in terms of maintainability and readability. This method checks if the points are already in a suitable format before performing the conversion, which helps in optimizing memory usage.

  • The method is correctly placed within the CommonData class, which seems to handle various common functionalities related to data handling.
  • The method is called within _import_shape and _import_track methods to ensure all points are converted before further processing.

The changes are well-implemented and align with the PR's objective of memory optimization.

Also applies to: 566-566, 570-586


540-540: Ensure consistent data processing in _import_shape.

The inclusion of _ensure_points_converted_to_floats in _import_shape ensures that all points are converted to floats before any further processing. This change is crucial for maintaining consistency and accuracy in data handling.

The modification is correctly implemented and contributes to the overall goal of memory optimization.


566-566: Ensure consistent data processing in _import_track.

The inclusion of _ensure_points_converted_to_floats in _import_track ensures that all points are converted to floats before any further processing. This change is crucial for maintaining consistency and accuracy in data handling.

The modification is correctly implemented and contributes to the overall goal of memory optimization.

@codecov-commenter
Copy link

codecov-commenter commented Aug 30, 2024

Codecov Report

Attention: Patch coverage is 95.18072% with 4 lines in your changes missing coverage. Please review.

Project coverage is 83.56%. Comparing base (9fc70ef) to head (08840c3).
Report is 11 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #8382      +/-   ##
===========================================
+ Coverage    83.46%   83.56%   +0.10%     
===========================================
  Files          395      396       +1     
  Lines        41826    41891      +65     
  Branches      3881     3881              
===========================================
+ Hits         34909    35008      +99     
+ Misses        6917     6883      -34     
Components Coverage Δ
cvat-ui 79.51% <ø> (+0.12%) ⬆️
cvat-server 87.17% <95.18%> (+0.07%) ⬆️

Copy link

sonarcloud bot commented Sep 3, 2024

@Bobronium Bobronium merged commit f2a5ec3 into develop Sep 4, 2024
33 checks passed
@bsekachev bsekachev deleted the ba/annotations-memory-optimizations branch September 12, 2024 09:51
bschultz96 pushed a commit to bschultz96/cvat that referenced this pull request Sep 12, 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
By using tuple as a container for points when dealing with import from
datumaro, we can achieve 2 things:
- Reduce memory needed for copying shapes and tracks during import
(running `deepcopy` on `tuple[int]` will return the same object, as
opposed to `list[int]`)
- Guarantee type safety during later stages of data pipeline and skip
additional conversion added in cvat-ai#1898

Same thing arguable should be done for CVAT format as well.

Benchmarks:
[memray_reports.zip](https://github.com/user-attachments/files/16849509/memray_reports.zip)


### 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 handling of shape points during the import process for
enhanced data accuracy.
- Centralized conversion of shape points to floats, optimizing memory
usage and performance.

- **Refactor**
- Enhanced code readability and maintainability by restructuring the
point conversion logic.

<!-- 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