Updated `Serverless tutorial` documentation #8853

prateekshukla1108 · 2024-12-20T12:30:39Z

Removed mentions of Masked RCNN from the website and README
Updated detectors documentation screenshots, depends on #9011
Resolves #8851

Motivation and context

Mask RCNN was removed but the documentation and README wasn't modified

How has this been tested?

Just checked in the preview tab in github

Checklist

I submit my changes into the develop branch
~~[ ] I have created a changelog fragment Not needed~~
I have updated the documentation accordingly
~~[ ] I have added tests to cover my changes -> not needed~~
~~[ ] I have linked related issues -> Not needed~~

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
- Added sections on "Deep learning serverless functions for automatic labeling", "Supported annotation formats", and "Public datasets" in the documentation.
- Expanded details on CVAT versions and capabilities in the overview.
- Updated deployment instructions for "SiamMask", "YOLO v3", and "RetinaNet" in the serverless tutorial.
Bug Fixes
- Removed outdated content related to "Mask RCNN" and improved clarity in the AI tools documentation.
Documentation
- Enhanced structure and content across multiple documents for better readability and user engagement.

Removed Masked RCNN

Removed masked rcnn from overview

removed mentions of Mask RCNN

coderabbitai · 2024-12-20T12:30:46Z

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 pull request introduces comprehensive updates to CVAT's documentation across multiple files. The changes focus on enhancing user understanding by providing more detailed information about the tool's capabilities, annotation formats, AI tools, and serverless functions. The updates span README.md, overview documentation, AI tools guide, and serverless tutorial, with improvements in content clarity, model descriptions, and deployment instructions.

Changes

File	Change Summary
`README.md`	- Added "Deep learning serverless functions for automatic labeling" section - Expanded "Supported annotation formats" section - Updated "Public datasets" section - Minor formatting improvements
`site/content/en/docs/getting_started/overview.md`	- Refined introduction and version descriptions - Enhanced "Tools and formats" section - Added detailed annotation tools table - Updated automated labeling section
`site/content/en/docs/manual/advanced/ai-tools.md`	- Updated title and description - Expanded sections on interactors and OpenCV tools - Improved detectors and trackers model descriptions
`site/content/en/docs/manual/advanced/serverless-tutorial.md`	- Removed Mask RCNN references - Added SiamMask and YOLO v3 model deployment instructions - Added RetinaNet deployment details - Included serverless function debugging guidance

Sequence Diagram

sequenceDiagram
    participant User
    participant CVAT
    participant ServerlessFunction
    participant AIModel

    User->>CVAT: Select Annotation Task
    CVAT->>ServerlessFunction: Deploy Serverless Function
    ServerlessFunction->>AIModel: Load Pre-trained Model
    User->>CVAT: Upload Image/Video
    CVAT->>ServerlessFunction: Request Annotation
    ServerlessFunction->>AIModel: Process Image
    AIModel-->>ServerlessFunction: Return Annotations
    ServerlessFunction-->>CVAT: Provide Annotation Results
    CVAT-->>User: Display Annotated Data

Poem

🐰 Hop, hop, through CVAT's domain,
Where AI and vision sweetly reign,
Serverless functions dance with glee,
Annotations flow, now swift and free!
A rabbit's guide to learning's art, 🤖
Where machine and human smartly start! 🌟

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. (Beta)
@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.

klakhov

I’m not sure if removing all mentions of Mask R-CNN from the documentation is the right approach.

First, we still support the CPU version of it.
Second, it would be better to replace the Mask R-CNN section in the tutorial with another existing GPU detector, such as Faster R-CNN. Writing a new tutorial may not need to be part of this PR, but at the very least, we should retain the CPU section

site/content/en/docs/getting_started/overview.md

prateekshukla1108 · 2024-12-23T15:37:42Z

I’m not sure if removing all mentions of Mask R-CNN from the documentation is the right approach.

First, we still support the CPU version of it. Second, it would be better to replace the Mask R-CNN section in the tutorial with another existing GPU detector, such as Faster R-CNN. Writing a new tutorial may not need to be part of this PR, but at the very least, we should retain the CPU section

hi klakhov, thanks for the correction, I will correct it!

Added mask RCNN as CPU version is still supported

prateekshukla1108 · 2024-12-23T15:46:42Z

I corrected it! Thanks for the feedback and sorry for the bad PR.
Let me know if I can help in any other way!

klakhov

Hi @prateekshukla1108,

Could you please avoid deleting the GPU deployment section of the tutorial in the documentation? Instead, consider updating it to reference another available GPU function from the repository.

I believe removing the GPU tutorial entirely is bad idea, as having a slightly outdated tutorial is still better than having none at all.

site/content/en/docs/getting_started/overview.md

site/content/en/docs/manual/advanced/ai-tools.md

site/content/en/docs/manual/advanced/serverless-tutorial.md

prateekshukla1108 · 2024-12-28T12:58:02Z

@klakhov Thanks for your patience. I am new to this project so I just made the changes without giving it much thought
I would make the changes you mentioned

Made the required changes

sonarqubecloud · 2024-12-28T13:18:58Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

klakhov · 2025-01-14T11:25:51Z

@prateekshukla1108 well now it looks better.
But have you tried to deploy another gpu model for the tutorial? I still have one comment that we shouldnt delete the gpu tutorial completely

prateekshukla1108 · 2025-01-14T14:51:12Z

@prateekshukla1108 well now it looks better. But have you tried to deploy another gpu model for the tutorial? I still have one comment that we shouldnt delete the gpu tutorial completely

Still trying to understand the Codebase. Also I have exams so I get very little time to work on Open Source. but I'll try

klakhov · 2025-01-14T15:18:26Z

Great!
I suppose you can try to use yolov7 it supports gpu.
You can try to run:

serverless/deploy_gpu.sh /serverless/onnx/WongKinYiu/yolov7

I should work out of the box

prateekshukla1108 · 2025-01-14T19:14:56Z

Great! I suppose you can try to use yolov7 it supports gpu. You can try to run:
serverless/deploy_gpu.sh /serverless/onnx/WongKinYiu/yolov7
I should work out of the box

Actually I don't have access to GPU's. Most of my work is done in colab so its pretty difficult to test

codecov-commenter · 2025-01-30T12:54:41Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 73.38%. Comparing base (3b5202e) to head (cae7ec1).
Report is 1 commits behind head on develop.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #8853      +/-   ##
===========================================
- Coverage    73.39%   73.38%   -0.01%     
===========================================
  Files          416      416              
  Lines        44207    44207              
  Branches      3860     3860              
===========================================
- Hits         32446    32443       -3     
- Misses       11761    11764       +3

Components	Coverage Δ
cvat-ui	`77.36% <ø> (-0.02%)`	⬇️
cvat-server	`70.08% <ø> (ø)`

sonarqubecloud · 2025-01-31T07:12:45Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

prateekshukla1108 added 5 commits December 20, 2024 17:05

Updated README.md

8fb569e

Removed Masked RCNN

Update ai-tools.md

822a71d

Update ai-tools.md

b565d45

Update overview.md

1a4075e

Removed masked rcnn from overview

Update serverless-tutorial.md

72a4d55

removed mentions of Mask RCNN

prateekshukla1108 changed the title ~~Removed Mentions of CVAT~~ Removed Mentions of Mask RCNN Dec 20, 2024

prateekshukla1108 mentioned this pull request Dec 20, 2024

README & Docs needs to be updated about mask_rcnn(gpu) #8851

Closed

klakhov reviewed Dec 23, 2024

View reviewed changes

site/content/en/docs/getting_started/overview.md Outdated Show resolved Hide resolved

klakhov added the documentation Documentation should be updated label Dec 23, 2024

Merge branch 'cvat-ai:develop' into develop

e915680

Update README.md

03b4d0d

Added mask RCNN as CPU version is still supported

klakhov reviewed Dec 28, 2024

View reviewed changes

prateekshukla1108 added 5 commits December 28, 2024 18:29

Merge branch 'cvat-ai:develop' into develop

0049ae5

Update overview.md

f5416ab

Update ai-tools.md

9085a9c

Update serverless-tutorial.md

05b160b

Made the required changes

Delete site/content/en/images/mask_rcnn_results.jpg

5ef4b4f

klakhov added 4 commits January 28, 2025 15:40

Merge branch 'develop' into kl/remove-mask-rcnn

e948466

added UI element

dc817ed

added changelog

110a556

Merge branch 'develop' into kl/add-detector-threshold

c65220b

klakhov added 4 commits January 30, 2025 10:37

updated implementation so default value is null

7249697

Merge branch 'develop' into kl/remove-mask-rcnn

a7f93ef

Merge branch 'kl/add-detector-threshold' into kl/remove-mask-rcnn

6908fd9

updated documentation

7bd171d

klakhov requested review from bsekachev and nmanovic as code owners January 30, 2025 08:58

updated link

96f8ea1

klakhov changed the title ~~Removed Mentions of Mask RCNN~~ Updated Serverless tutorial documentation Jan 30, 2025

klakhov and others added 3 commits January 30, 2025 14:32

update running automatic annotation

1400a71

Merge branch 'develop' into develop

588c7ac

fix linter

cae7ec1

klakhov mentioned this pull request Jan 31, 2025

Added threshold parameter to detector runner #9011

Merged

5 tasks

Merge branch 'develop' into kl/remove-mask-rcnn

9175869

klakhov merged commit 5e787eb into cvat-ai:develop Jan 31, 2025
15 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Updated `Serverless tutorial` documentation #8853

Updated `Serverless tutorial` documentation #8853

prateekshukla1108 commented Dec 20, 2024 •

edited by klakhov

Loading

coderabbitai bot commented Dec 20, 2024 •

edited

Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

klakhov left a comment

prateekshukla1108 commented Dec 23, 2024

prateekshukla1108 commented Dec 23, 2024

klakhov left a comment

prateekshukla1108 commented Dec 28, 2024

sonarqubecloud bot commented Dec 28, 2024

klakhov commented Jan 14, 2025

prateekshukla1108 commented Jan 14, 2025

klakhov commented Jan 14, 2025

prateekshukla1108 commented Jan 14, 2025

codecov-commenter commented Jan 30, 2025

sonarqubecloud bot commented Jan 31, 2025

Updated Serverless tutorial documentation #8853

Updated Serverless tutorial documentation #8853

Conversation

prateekshukla1108 commented Dec 20, 2024 • edited by klakhov Loading

Motivation and context

How has this been tested?

Checklist

License

Summary by CodeRabbit

coderabbitai bot commented Dec 20, 2024 • edited Loading

Review skipped

Walkthrough

Changes

Sequence Diagram

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

klakhov left a comment

Choose a reason for hiding this comment

prateekshukla1108 commented Dec 23, 2024

prateekshukla1108 commented Dec 23, 2024

klakhov left a comment

Choose a reason for hiding this comment

prateekshukla1108 commented Dec 28, 2024

sonarqubecloud bot commented Dec 28, 2024

Quality Gate passed

klakhov commented Jan 14, 2025

prateekshukla1108 commented Jan 14, 2025

klakhov commented Jan 14, 2025

prateekshukla1108 commented Jan 14, 2025

codecov-commenter commented Jan 30, 2025

Codecov Report

sonarqubecloud bot commented Jan 31, 2025

Quality Gate passed

Updated `Serverless tutorial` documentation #8853

Updated `Serverless tutorial` documentation #8853

prateekshukla1108 commented Dec 20, 2024 •

edited by klakhov

Loading

coderabbitai bot commented Dec 20, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)