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

Remove the quality parameter from lambda function call endpoints #8683

Merged
merged 1 commit into from
Nov 13, 2024

Conversation

SpecLad
Copy link
Contributor

@SpecLad SpecLad commented Nov 11, 2024

Motivation and context

  1. In practice, it is never used by the UI.

  2. In theory, I don't think it should be provided either. I don't think it ever makes sense for a user to want to run a function on a reduced-quality image, unless it just doesn't work on the original one (e.g. if it is too big). And in this case, CVAT should just perform the recompression automatically instead of making the user do it.

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

    • The system now consistently uses original images for processing, eliminating the option for compressed images.
  • Bug Fixes

    • Removed the quality parameter from various functionalities, streamlining image processing operations.
  • Tests

    • Updated test cases to reflect the removal of the quality parameter, ensuring alignment with the new image handling process. Added tests for organizational permissions for invoking lambda functions.

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

This pull request implements a significant change in the handling of image quality within the system, specifically removing the ability to execute lambda functions on compressed images. The quality parameter has been entirely removed from various components, including serializers, views, and tests, leading to a consistent use of original images for processing. Consequently, the related functionality and tests have been updated to reflect this change, ensuring that the system operates without the now-removed quality distinctions.

Changes

File Path Change Summary
changelog.d/20241111_195229_roman_remove_lambda_quality.md Documentation of the removal of lambda function execution on compressed images, ensuring original images are used for processing.
cvat/apps/lambda_manager/serializers.py Removed quality field from FunctionCallRequestSerializer, which was a ChoiceField for image quality options.
cvat/apps/lambda_manager/tests/test_lambda.py Removed tests related to the quality parameter, including the test_api_v2_lambda_functions_create_quality method, and updated other tests to exclude the quality field from request data. Added tests for organizational permissions.
cvat/apps/lambda_manager/views.py Removed quality parameter from method signatures and internal logic in LambdaFunction, LambdaQueue, and LambdaJob classes, simplifying function calls and processing related to image handling.

Poem

In a world of images bright,
No more quality fights,
Original frames now take the stage,
Simplifying our coding page.
Hooray for clarity, hip-hip-hooray!
Let’s hop along this joyful way! 🐇✨


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.

1. In practice, it is never used by the UI.

2. In theory, I don't think it should be provided either. I don't think it
   ever makes sense for a user to want to run a function on a
   reduced-quality image, unless it just doesn't work on the original one
   (e.g. if it is too big). And in this case, CVAT should just perform the
   recompression automatically instead of making the user do it.
Copy link

sonarcloud bot commented Nov 11, 2024

@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 74.19%. Comparing base (1e7ff33) to head (3f73d51).

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #8683      +/-   ##
===========================================
- Coverage    74.20%   74.19%   -0.01%     
===========================================
  Files          401      401              
  Lines        43504    43496       -8     
  Branches      3950     3950              
===========================================
- Hits         32280    32273       -7     
+ Misses       11224    11223       -1     
Components Coverage Δ
cvat-ui 78.51% <ø> (+<0.01%) ⬆️
cvat-server 70.50% <100.00%> (-0.02%) ⬇️

@SpecLad SpecLad merged commit dab2cc4 into cvat-ai:develop Nov 13, 2024
34 checks passed
@SpecLad SpecLad deleted the remove-lambda-quality branch November 13, 2024 10:55
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.

2 participants