cvat icon indicating copy to clipboard operation
cvat copied to clipboard

Quality control page

Open klakhov opened this issue 1 year ago β€’ 3 comments

Motivation and context

Depends on #8323 - Removing quality control tab from analytics #8321 - New quality settings (Server) #8347 - New quality settings (UI)

How has this been tested?

Checklist

  • [x] I submit my changes into the develop branch
  • [x] 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)~~
  • [x] I have increased versions of npm packages if it is necessary (cvat-canvas, cvat-core, cvat-data and cvat-ui)

License

  • [x] 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 a dedicated Quality Control page for improved access to quality management tasks.
    • Added functionality to enable or disable ground truth (GT) frames on the Quality Control page.
    • Enhanced task creation with a Quality Configuration Form for setting validation methods and parameters.
    • Integrated a new action for Quality Control in the Actions Menu.
    • Added a Paid Feature Placeholder to highlight premium features.
  • Bug Fixes

    • Improved error handling for frame deletion and restoration processes.
  • Documentation

    • Updated configuration files to include details about the new Quality Control feature.
  • Style

    • Updated styles for new components and adjusted layout for improved user experience.
  • Refactor

    • Streamlined job management functions to focus on delete, export, and import actions.

klakhov avatar Aug 21 '24 13:08 klakhov

[!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 update encompasses significant enhancements to the CVAT application, focusing on quality control features. Key changes include the introduction of a dedicated quality control page, modifications to API functions for better metadata handling, and the addition of new quality settings and metrics. The UI has been updated to improve user interaction with job management and frame allocation, alongside the integration of new tools for managing quality metrics and settings.

Changes

File(s) Change Summary
changelog.d/20240826_093730_klakhov_support_quality_plugin.md Introduced a dedicated quality control page, removed quality report from community version, added functionality to enable/disable ground truth frames.
cvat-core/package.json Updated cvat-core version from 15.1.2 to 15.2.0.
cvat-core/src/api-implementation.ts Modified implementAPI function to conditionally fetch metadata based on type.
cvat-core/src/frames.ts Transitioned several functions to return Promise<void>, added reload parameter to getJobMeta, and updated return type for patchMeta.
cvat-core/src/quality-settings.ts Added TargetMetric enumeration and new properties for quality settings, enhancing the QualitySettings class functionality.
cvat-core/src/server-response-types.ts Introduced new optional properties in SerializedQualitySettingsData interface for better quality settings representation.
cvat-core/src/session-implementation.ts Enhanced error handling in deleteFrameWrapper and restoreFrameWrapper, improved return types in implementJob and implementTask methods.
cvat-core/src/session.ts Modified save method in Session class to return an array of FramesMetaData, added new validation properties in Task class.
cvat-ui/package.json Updated cvat-ui version from 1.65.0 to 1.66.0, added new dependencies for resizable components.
cvat-ui/src/actions/tasks-actions.ts Enhanced task description handling for quality validation methods, introducing conditional logic based on validation type.
cvat-ui/src/assets/index.d.ts Added module declaration for .png files, enhancing asset support.
cvat-ui/src/components/actions-menu/actions-menu.tsx Introduced QUALITY_CONTROL action to the Actions enum for better menu functionality.
cvat-ui/src/components/analytics-page/analytics-page.tsx Restructured JSX, removed unused imports, and simplified component logic.
cvat-ui/src/components/create-job-page/job-form.tsx Added new RANDOM_PER_JOB selection method to FrameSelectionMethod enum and refactored frame selection rendering.
cvat-ui/src/components/create-task-page/create-task-content.tsx Integrated QualityConfigurationForm for quality settings during task creation, updated state management for quality fields.
cvat-ui/src/components/quality-control/quality-control-page.tsx Introduced QualityControlPage for managing quality control tasks, featuring a tabbed interface for navigation.
cvat-ui/src/utils/quality.ts Introduced utility functions and enumerations for managing quality metrics, including color codes and sorting functions.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant QualityControlPage
    participant API
    participant JobManagement

    User->>QualityControlPage: Open Quality Control
    QualityControlPage->>API: Fetch Quality Settings
    API-->>QualityControlPage: Return Quality Settings
    QualityControlPage->>JobManagement: Display Job Details
    User->>JobManagement: Update Job Settings
    JobManagement->>API: Save Job Settings
    API-->>JobManagement: Confirm Save
    JobManagement-->>QualityControlPage: Update UI

πŸ‡ In a world of frames, where quality reigns,
A rabbit hops forth, with joy it explains,
"With settings so fine, and metrics to see,
Our tasks shine bright, as bright as can be!
So let’s dance and play, with quality in sight,
Together we’ll make our annotations just right!" πŸ‡


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.

coderabbitai[bot] avatar Aug 21 '24 13:08 coderabbitai[bot]

Codecov Report

Attention: Patch coverage is 84.00000% with 12 lines in your changes missing coverage. Please review.

Project coverage is 83.15%. Comparing base (2a07b6c) to head (489c216). Report is 1 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #8329      +/-   ##
===========================================
- Coverage    83.59%   83.15%   -0.45%     
===========================================
  Files          397      397              
  Lines        41902    41888      -14     
  Branches      3883     3879       -4     
===========================================
- Hits         35030    34830     -200     
- Misses        6872     7058     +186     
Components Coverage Ξ”
cvat-ui 78.60% <84.00%> (-0.97%) :arrow_down:
cvat-server 87.19% <ΓΈ> (+<0.01%) :arrow_up:

codecov-commenter avatar Aug 26 '24 11:08 codecov-commenter

There is still some refactoring I would like to do, but the patch is already big. I will send some more later.

bsekachev avatar Sep 11 '24 09:09 bsekachev