Skip to content

Slin/doc fix 2#92

Merged
slin1237 merged 2 commits into
mainfrom
slin/doc-fix-2
Jun 30, 2025
Merged

Slin/doc fix 2#92
slin1237 merged 2 commits into
mainfrom
slin/doc-fix-2

Conversation

@slin1237
Copy link
Copy Markdown
Collaborator

What type of PR is this?

/kind documentation
/kind bug

What this PR does / why we need it:

  • fix readme about ome component
  • add pr labeler action

Which issue(s) this PR fixes:

n/a

Fixes #

Special notes for your reviewer:

Does this PR introduce a user-facing change?


@github-actions github-actions Bot added kind/documentation Documentation only change kind/bug Bug fix labels Jun 30, 2025
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a 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 @slin1237, 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 primarily focuses on improving the project's documentation. It updates the README.md to accurately reflect the components of the OME architecture, ensuring that users have a complete understanding of the system's capabilities.

Highlights

  • Documentation Update: The README.md file has been updated to include BenchmarkJob as a core OME component, clarifying its purpose in measuring model performance under different workloads.
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 is currently in preview and 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 to provide feedback.

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

  1. 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.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a 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 updates the README.md to include the BenchmarkJob component in the list of OME's core components. The change is a good addition to the documentation. I've provided one suggestion to make the description of BenchmarkJob more specific and aligned with the detailed documentation, which would improve clarity for new users.

Comment thread README.md
- **BaseModel/ClusterBaseModel:** Define model sources and metadata
- **ServingRuntime/ClusterServingRuntime:** Define how models are served
- **InferenceService:** Connects models to runtimes for deployment
- **BenchmarkJob:** Measures model performance under different workloads
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

The current description for BenchmarkJob is a bit generic. While not incorrect, it could be more descriptive of the component's function. A more specific description that highlights its role in automating benchmarking for inference services would provide more clarity for users at a glance and align better with the detailed documentation.

Suggested change
- **BenchmarkJob:** Measures model performance under different workloads
- **BenchmarkJob:** Automates performance benchmarking of inference services

@slin1237 slin1237 removed kind/documentation Documentation only change kind/bug Bug fix labels Jun 30, 2025
@slin1237 slin1237 merged commit 75d42fb into main Jun 30, 2025
15 checks passed
@slin1237 slin1237 deleted the slin/doc-fix-2 branch June 30, 2025 15:37
slin1237 added a commit that referenced this pull request Dec 22, 2025
* [doc] add missing benchmark in readme

* [misc] add pr labeler
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