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

Update serverless-tutorial.md #8852

Closed
wants to merge 1 commit into from

Conversation

prateekshukla1108
Copy link

@prateekshukla1108 prateekshukla1108 commented Dec 20, 2024

Removed Mask RCNN

Motivation and context

Masked RCNN was removed so its mentions should not be

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

    • Expanded instructions for deploying the YOLO-v3 model with command-line examples.
    • Introduction of a section on integrating custom models using Detectron2.
    • New guidance on optimizing functions for GPU usage.
    • Added steps for debugging serverless functions.
    • Troubleshooting section with commands for checking function health.
  • Bug Fixes

    • Removed outdated reference to the "Mask RCNN" model from the built-in serverless functions list.

Copy link
Contributor

coderabbitai bot commented Dec 20, 2024

Walkthrough

The serverless tutorial for CVAT has been updated to provide more comprehensive guidance on implementing and managing serverless functions. The changes focus on refining the documentation by removing the Mask RCNN model, expanding instructions for YOLO-v3 deployment, and introducing new sections about custom model integration, GPU optimization, debugging, and troubleshooting. The tutorial now offers more detailed steps for developers looking to work with serverless functions in the Computer Vision Annotation Tool.

Changes

File Change Summary
site/content/en/docs/manual/advanced/serverless-tutorial.md - Removed Mask RCNN from built-in serverless functions list
- Added "Adding your own DL models" section with Detectron2 integration
- Expanded YOLO-v3 deployment instructions
- Added sections on GPU optimization, debugging, and troubleshooting

Poem

🐰 In CVAT's serverless domain,
Models dance, functions train,
Nuclio whispers, GPU gleams bright,
Custom models take their flight!
A rabbit's code, precise and lean 🚀


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.

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

🧹 Nitpick comments (1)
site/content/en/docs/manual/advanced/serverless-tutorial.md (1)

Line range hint 590-590: Consider adding a note about port conflict resolution

The troubleshooting section could benefit from a brief note explaining that port conflicts can be resolved by either:

  1. Removing conflicting containers
  2. Explicitly specifying different ports in the function configuration

Add this note after the existing port troubleshooting example:

+ > Note: To avoid port conflicts between different functions, you can explicitly specify different ports in the function configuration using the `port` attribute in the triggers section:
+ > ```yaml
+ > triggers:
+ >   myHttpTrigger:
+ >     attributes:
+ >       port: 32001  # Unique port for this function
+ > ```
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 54534e8 and 4282ad5.

📒 Files selected for processing (1)
  • site/content/en/docs/manual/advanced/serverless-tutorial.md (1 hunks)
🔇 Additional comments (1)
site/content/en/docs/manual/advanced/serverless-tutorial.md (1)

27-27: Built-in functions list updated correctly

The list of built-in functions has been properly updated to remove the Mask RCNN reference while maintaining other important models.

@prateekshukla1108 prateekshukla1108 deleted the patch-2 branch December 20, 2024 12:15
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.

1 participant