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

ViT-B classifier added with first 30 labels #7842

Open
wants to merge 6 commits into
base: develop
Choose a base branch
from

Conversation

omerferhatt
Copy link
Contributor

@omerferhatt omerferhatt commented May 2, 2024

Motivation and context

Since there is no classifier model in the repo, I added it to make it easier for general use and to be used as a draft. I think this can be useful for testing too.

#3896 (comment)

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

    • Implemented a serverless function using a Vision Transformer (ViT-B) model for inferring labels from images.
    • Added necessary imports and declarations for processing images and running inference.
  • Enhancements

    • Enhanced model deployment specifications, runtime environment, and dependencies.
    • Introduced restart policies and storage mount settings for improved resource management.
  • Functionality

    • Developed a serverless function to process input images, run inference using the ViT-B model, and return results in JSON format.

Copy link
Contributor

coderabbitai bot commented May 2, 2024

Walkthrough

The recent updates introduce a serverless deployment of a PyTorch-based Vision Transformer (ViT-B) model using Nuclio. The changes encompass enhanced configurations, new function definitions, and a class for model handling, streamlining the process for image classification tasks in a cloud environment.

Changes

File Path Change Summary
.../function-gpu.yaml Configuration for GPU-based deployment, including metadata, runtime, resources, and HTTP trigger.
.../function.yaml Similar to function-gpu.yaml but tailored for standard deployment. Includes similar metadata, runtime, and HTTP trigger settings.
.../main.py Implementation of serverless function for image processing and inference.
.../model_handler.py Introduction of ModelHandler class for initializing and running the ViT model.

🐰✨
In the land of code and cloud,
A rabbit hopped, feeling proud.
For the models now deploy with ease,
Amongst the servers, a gentle breeze.
"Hop, skip, a serverless feat,
With PyTorch and Nuclio, none can compete!"


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.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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: 3

Out of diff range and nitpick comments (1)
serverless/pytorch/omerferhatt/vit-b/nuclio/function-gpu.yaml (1)

1-88: Ensure GPU resource allocation is optimized.

The configuration specifies the allocation of one GPU. It is important to monitor the utilization of GPU resources to ensure they are being used efficiently. Over-provisioning can lead to unnecessary costs, while under-provisioning can affect performance. Consider implementing monitoring tools to track GPU usage and adjust the allocation based on actual usage patterns.

@omerferhatt omerferhatt changed the title [WiP] ViT-B classifier added with first 30 labels ViT-B classifier added with first 30 labels May 2, 2024
@bsekachev
Copy link
Member

Hello,

I am not sure we may use models from torchvision.
As this specific model was trained on ImageNet, but ImageNet is non-commercial dataset.

image
image

Sources:

@omerferhatt
Copy link
Contributor Author

@bsekachev I can update the model without weights, and it will be used as a template for classifier serverless models since there are none.

Regarding the torchvision usage, I don't think there will be a problem since all the architectures published under torchvision are open-source. But things can be different for weights, as you say.



class ModelHandler:
weights = tv.models.ViT_B_16_Weights.DEFAULT
Copy link
Member

Choose a reason for hiding this comment

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

Let's explicitly specify what model will be used: IMAGENET1K_V1

@@ -0,0 +1,88 @@
metadata:
Copy link
Member

Choose a reason for hiding this comment

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

Path should be serverless/pytorch/torchvision/vit-b/nuclio as this model is a part of torchvision

context.logger.info("Init context...100%")

def handler(context, event):
context.logger.info("Run ViT-B model")
Copy link
Member

Choose a reason for hiding this comment

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

I do not think we need these logs on production

"confidence": str(score),
"label": context.user_data.labels[class_id],
"type": "tag",
"objectType": "tag",
Copy link
Member

Choose a reason for hiding this comment

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

Not necessary field, as discussed in another pull request

class_id = prediction.argmax().item()
score = prediction[class_id].item()
category_name = self.weights.meta["categories"][class_id]
return (class_id, category_name, score)
Copy link
Member

Choose a reason for hiding this comment

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

Please, put return inside the context manager

@bsekachev
Copy link
Member

@omerferhatt

  • We may put this code to our repository, but we will need to add a license file to this serverless function, mentioning its license.
  • Unfortunately, it will not be possible to deploy it on app.cvat.ai, as it is non-commercial, but it would be a good example on how to write serverless classifiers. And, maybe it will be useful for someone in research purposes.

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.

None yet

2 participants