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

not prefetching images when not needed #8676

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from
Open

Conversation

Eldies
Copy link
Contributor

@Eldies Eldies commented Nov 11, 2024

Motivation and context

While importing annotations to task, all jobs of the task are loaded from db to ram. Related data is prefetched, specifically all image models which belong to the task.
As a result, each job holds its own copy of all the image models.

If there are a lot of jobs and a lot of images in the task, a lot of memory can be occupied.
And images are not utilised on annotations import/delete. Hence - do not prefetch images in these cases.

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

    • Enhanced job retrieval process with improved error handling.
    • Introduced a mechanism for custom querysets in job initialization.
  • Bug Fixes

    • Improved robustness in job fetching to prevent failures when jobs are not found.
  • Refactor

    • Updated logic in the JobAnnotation class for clearer control flow and initialization.

Copy link
Contributor

coderabbitai bot commented Nov 11, 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 in the JobAnnotation class within the cvat/apps/dataset_manager/task.py file introduce a new variable, is_custom_queryset, to manage job retrieval based on the type of queryset provided. The control flow for job fetching is modified to handle different conditions, enhancing error handling with a try-except block for StopIteration. Additionally, the import_annotations method is updated to initialize job data with a new JobData instance, ensuring proper job annotation creation. The overall structure remains intact while improving robustness and clarity.

Changes

File Path Change Summary
cvat/apps/dataset_manager/task.py Introduced is_custom_queryset in JobAnnotation class; modified job fetching logic and error handling; updated import_annotations method to use JobData.

Poem

In the garden where jobs do play,
A custom path now lights the way.
With queries clear and errors caught,
Annotations bloom, as they ought.
So hop along, let changes ring,
For every job, a joyful spring! 🐇✨


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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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.

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

🧹 Outside diff range and nitpick comments (1)
cvat/apps/dataset_manager/task.py (1)

127-130: Enhance error handling with more specific exception message

The error handling for StopIteration is good, but the error message could be more descriptive.

Consider adding more context to the error message:

-                raise models.Job.DoesNotExist()
+                raise models.Job.DoesNotExist(f"Job with id {pk} does not exist")
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between d315485 and 3ca5a3f.

📒 Files selected for processing (1)
  • cvat/apps/dataset_manager/task.py (1 hunks)
🔇 Additional comments (2)
cvat/apps/dataset_manager/task.py (2)

116-124: LGTM: Improved queryset handling to prevent memory leaks

The introduction of is_custom_queryset flag and the modified control flow helps prevent unnecessary caching of querysets, which aligns with the PR's objective of addressing memory leaks.


116-130: Verify performance impact of queryset changes

While the changes address memory leaks, we should verify that they don't introduce performance regressions in frequently accessed jobs.

Let's analyze the queryset usage patterns:

✅ Verification successful

Based on the search results, I can now make an informed assessment about the queryset changes and their performance impact. Let me generate the final response:

Queryset changes are safe and follow established patterns

The changes to job queryset handling are consistent with existing patterns across the codebase. Key observations:

  • The modified code path in dataset_manager/task.py follows the same queryset optimization patterns used in other critical paths like engine/views.py and quality_control/quality_reports.py
  • The caching behavior (get_cached) is used selectively only when custom querysets are provided, which is the correct approach
  • The prefetch logic remains intact through add_prefetch_info() which is crucial for JobAnnotation performance
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for patterns of job queryset usage that might be affected by the caching changes

# Look for job queryset usage patterns
rg -A 5 "Job\.objects" cvat/apps/

# Look for potential performance-critical paths
rg -A 5 "JobAnnotation" cvat/apps/

Length of output: 39203

@Eldies Eldies changed the title not using queryset cache when not needed not prefetching images when not needed Nov 12, 2024
@codecov-commenter
Copy link

codecov-commenter commented Nov 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 74.20%. Comparing base (1e7ff33) to head (b205652).
Report is 3 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #8676   +/-   ##
========================================
  Coverage    74.20%   74.20%           
========================================
  Files          401      401           
  Lines        43504    43507    +3     
  Branches      3950     3950           
========================================
+ Hits         32280    32284    +4     
+ Misses       11224    11223    -1     
Components Coverage Δ
cvat-ui 78.51% <ø> (+<0.01%) ⬆️
cvat-server 70.51% <100.00%> (+<0.01%) ⬆️

Copy link

sonarcloud bot commented Nov 13, 2024

@Marishka17
Copy link
Contributor

@Eldies, Could you please provide the difference in memory usage and number of db queries (before/after the patch)?

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