-
Notifications
You must be signed in to change notification settings - Fork 501
[Bug]: fix annotation in deployment webhook #1527
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Summary of Changes
Hello @googs1025, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request addresses a bug by standardizing the reference to the 'aibrix.io/engine' annotation within the deployment webhook. The change ensures that the annotation key is consistently referenced via a defined constant, which enhances code maintainability and reduces the risk of errors associated with hardcoded strings.
Highlights
- Annotation Key Fix: Replaced the hardcoded annotation key "aibrix.io/engine" with the
constants.ModelLabelEngineconstant in the deployment webhook, improving consistency and maintainability. - Dependency Update: Added an import for the
github.com/vllm-project/aibrix/pkg/constantspackage to support the use of the new constant.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
d061df5 to
ecd3144
Compare
| // Get engine type from deployment template annotations, if specified | ||
| var engineType string | ||
| if annotations := deployment.GetAnnotations(); annotations != nil { | ||
| if engine, exists := annotations["aibrix.io/engine"]; exists && engine != "" { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
just fix typo for ModelLabelEngine annotation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request fixes a bug in the deployment webhook by using the correct annotation key model.aibrix.ai/engine from the constants package, instead of the incorrect hardcoded value aibrix.io/engine. The change is correct and improves both the correctness and maintainability of the code. I have one suggestion for a minor code simplification to improve readability.
| if engine, exists := annotations[constants.ModelLabelEngine]; exists && engine != "" { | ||
| engineType = engine | ||
| } |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The check for exists is redundant here. When accessing a map with a key that doesn't exist, Go returns the zero value for the value type. For a string, this is "". Therefore, checking engine != "" is sufficient to cover both cases: when the key doesn't exist, or when its value is an empty string.
| if engine, exists := annotations[constants.ModelLabelEngine]; exists && engine != "" { | |
| engineType = engine | |
| } | |
| if engine := annotations[constants.ModelLabelEngine]; engine != "" { | |
| engineType = engine | |
| } |
|
I found that our ENV needs to be compatible with Lines 31 to 42 in 2d08022
for now: Env: []corev1.EnvVar{
{
Name: "INFERENCE_ENGINE",
Value: engineType,
},
{
Name: "INFERENCE_ENGINE_ENDPOINT",
Value: DefaultEngineEndpoint, // DefaultEngineEndpoint = "http://localhost:8000"
},
}, |
Signed-off-by: googs1025 <[email protected]>
ecd3144 to
9aa6b12
Compare
Pull Request Description
[Please provide a clear and concise description of your changes here]
Related Issues
Resolves: #[Insert issue number(s)]
Important: Before submitting, please complete the description above and review the checklist below.
Contribution Guidelines (Expand for Details)
We appreciate your contribution to aibrix! To ensure a smooth review process and maintain high code quality, please adhere to the following guidelines:
Pull Request Title Format
Your PR title should start with one of these prefixes to indicate the nature of the change:
[Bug]: Corrections to existing functionality[CI]: Changes to build process or CI pipeline[Docs]: Updates or additions to documentation[API]: Modifications to aibrix's API or interface[CLI]: Changes or additions to the Command Line Interface[Misc]: For changes not covered above (use sparingly)Note: For changes spanning multiple categories, use multiple prefixes in order of importance.
Submission Checklist
By submitting this PR, you confirm that you've read these guidelines and your changes align with the project's contribution standards.