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

Disable auto quality updates #8790

Merged
merged 6 commits into from
Dec 11, 2024
Merged

Conversation

zhiltsov-max
Copy link
Contributor

@zhiltsov-max zhiltsov-max commented Dec 7, 2024

Motivation and context

  • Removed functionality to run quality report updates automatically after task changes

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

Release Notes

  • New Features

    • Enhanced documentation for automated quality assurance (QA) processes, including clearer instructions for managing Ground Truth jobs and validation modes.
  • Bug Fixes

    • Removed automatic quality report updates, streamlining the quality management process.
  • Documentation

    • Updated the document on automated QA to improve clarity and functionality, including expanded sections on quality estimation and management.
  • Chores

    • Removed deprecated settings related to quality check job delays in various configuration files.

Copy link
Contributor

coderabbitai bot commented Dec 7, 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 this pull request involve the removal of automatic quality report updates and related functionalities across multiple files in the CVAT application. Key modifications include the deletion of specific methods and settings associated with automatic quality checks, as well as the removal of signal receivers that previously updated quality metrics. Additionally, the development and testing configurations have been updated, including changes to the handling of quality check delays. Documentation has also been revised to clarify the automated quality assurance process.

Changes

File Path Change Summary
changelog.d/20241207_024832_mzhiltso_disable_auto_quality_updates.md Removed automatic quality report updates in tasks.
cvat/apps/analytics_report/report/create.py Removed _get_last_report_time method from AnalyticsReportUpdateManager.
cvat/apps/quality_control/apps.py Removed code block in QualityControlConfig.ready method that imported and set default settings.
cvat/apps/quality_control/default_settings.py Removed default_settings.py file containing QUALITY_CHECK_JOB_DELAY.
cvat/apps/quality_control/quality_reports.py Removed several methods related to automatic quality report updates from QualityReportUpdateManager.
cvat/apps/quality_control/signals.py Removed signal receivers for quality metrics updates and the __save_job__update_quality_metrics method.
cvat/settings/development.py Updated INSTALLED_APPS, modified ALLOWED_HOSTS, defined CORS settings, and removed QUALITY_CHECK_JOB_DELAY.
cvat/settings/testing_rest.py Removed QUALITY_CHECK_JOB_DELAY setting.
site/content/en/docs/manual/advanced/analytics-and-monitoring/auto-qa.md Updated document to clarify automated QA process and improve readability.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Task
    participant QualityControl
    participant QualityReportUpdateManager

    User->>Task: Create Task
    Task->>QualityControl: Initialize Quality Settings
    QualityControl->>QualityReportUpdateManager: Schedule Custom Quality Check Job
    QualityReportUpdateManager-->>QualityControl: Confirm Scheduling
Loading

🐇 "In the fields where we hop and play,
Quality checks have found a new way.
No more auto, just manual delight,
We’ll schedule our jobs, oh what a sight!
With clarity now, our tasks will gleam,
In the world of QA, we’ll reign supreme!" 🐇


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 generate docstrings to generate docstrings for this PR. (Experiment)
  • @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 (2)
cvat/apps/quality_control/signals.py (1)

Line range hint 17-19: Replace assert False with a more informative exception

Using assert False may not provide a helpful error message and can be omitted in optimized code. Consider raising an explicit exception with a descriptive message to handle unexpected instance types.

Apply this diff to improve error handling:

     else:
-        assert False
+        raise ValueError(f"Unexpected instance type: {type(instance)}")
site/content/en/docs/manual/advanced/analytics-and-monitoring/auto-qa.md (1)

501-501: Add missing preposition 'of' in the sentence

The sentence is missing the preposition 'of' after 'update'. It should read: 'If you want to request an update of quality metrics in a task...'

Apply this change to correct the sentence:

-If you want to request an update quality metrics in a task (e.g. after the settings were changed),
+If you want to request an update of quality metrics in a task (e.g. after the settings were changed),
🧰 Tools
🪛 LanguageTool

[uncategorized] ~501-~501: Possible missing preposition found.
Context: ...tton. If you want to request an update quality metrics in a task (e.g. after the setti...

(AI_HYDRA_LEO_MISSING_OF)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 12eec54 and bca9050.

📒 Files selected for processing (9)
  • changelog.d/20241207_024832_mzhiltso_disable_auto_quality_updates.md (1 hunks)
  • cvat/apps/analytics_report/report/create.py (0 hunks)
  • cvat/apps/quality_control/apps.py (0 hunks)
  • cvat/apps/quality_control/default_settings.py (0 hunks)
  • cvat/apps/quality_control/quality_reports.py (0 hunks)
  • cvat/apps/quality_control/signals.py (1 hunks)
  • cvat/settings/development.py (0 hunks)
  • cvat/settings/testing_rest.py (0 hunks)
  • site/content/en/docs/manual/advanced/analytics-and-monitoring/auto-qa.md (1 hunks)
💤 Files with no reviewable changes (6)
  • cvat/apps/quality_control/default_settings.py
  • cvat/settings/testing_rest.py
  • cvat/apps/analytics_report/report/create.py
  • cvat/apps/quality_control/apps.py
  • cvat/settings/development.py
  • cvat/apps/quality_control/quality_reports.py
✅ Files skipped from review due to trivial changes (1)
  • changelog.d/20241207_024832_mzhiltso_disable_auto_quality_updates.md
🧰 Additional context used
🪛 LanguageTool
site/content/en/docs/manual/advanced/analytics-and-monitoring/auto-qa.md

[uncategorized] ~501-~501: Possible missing preposition found.
Context: ...tton. If you want to request an update quality metrics in a task (e.g. after the setti...

(AI_HYDRA_LEO_MISSING_OF)

@codecov-commenter
Copy link

codecov-commenter commented Dec 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 73.91%. Comparing base (f098ee5) to head (6932ed5).
Report is 20 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #8790      +/-   ##
===========================================
- Coverage    73.96%   73.91%   -0.05%     
===========================================
  Files          409      408       -1     
  Lines        43942    43884      -58     
  Branches      3985     3986       +1     
===========================================
- Hits         32500    32436      -64     
- Misses       11442    11448       +6     
Components Coverage Δ
cvat-ui 78.37% <ø> (+0.02%) ⬆️
cvat-server 70.08% <100.00%> (-0.13%) ⬇️

@bsekachev bsekachev requested review from bsekachev and removed request for nmanovic and Marishka17 December 10, 2024 15:24
Copy link
Member

@bsekachev bsekachev left a comment

Choose a reason for hiding this comment

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

Code LGTM

Co-authored-by: Boris Sekachev <boris.sekachev@yandex.ru>
@zhiltsov-max zhiltsov-max merged commit 2b53691 into develop Dec 11, 2024
35 checks passed
@zhiltsov-max zhiltsov-max deleted the zm/disable-auto-quality-updates branch December 11, 2024 11:51
@cvat-bot cvat-bot bot mentioned this pull request Dec 20, 2024
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