Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
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 focuses on documentation cleanup and minor configuration updates. It removes outdated information related to a training sidecar agent and several PlantUML diagrams, while also updating default image tags and adding a new configuration option in the Helm chart's README.
Highlights
- OME-Agent Documentation Cleanup: Removed the 'Training Sidecar Agent' section and its associated environment variables from
cmd/ome-agent/README.md, streamlining the agent's documented capabilities. - Outdated Diagram Removal: Deleted several PlantUML diagrams (
benchmark_job.plantuml,inference_service.plantuml,model.plantuml,runtime.plantuml) and their corresponding SVG rendering (model.svg) from thesite/assetsdirectory, likely removing outdated architectural visualizations. - Helm Chart Values Update: Updated default image tags for
modelAgent,ome.controller,ome.omeAgent, andome.versionfromv0.1.0tov0.1.2incharts/ome-resources/README.md. - New Helm Chart Configuration: Added a new
global.imagePullSecretsentry to thecharts/ome-resources/README.mdvalues table.
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
-
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. ↩
There was a problem hiding this comment.
Code Review
This PR cleans up documentation by removing obsolete sections and files, and reformatting a configuration table. My review includes suggestions to further improve the documentation by adding missing parameter descriptions and fixing a minor formatting issue in a markdown table.
| | Key | Type | Default | Description | | ||
| |-----|------|---------|-------------| | ||
| | global.imagePullSecrets | list | `[]` | | | ||
| | modelAgent.health.port | int | `8080` | | | ||
| | modelAgent.hostPath | string | `"/mnt/data/models"` | | | ||
| | modelAgent.image.pullPolicy | string | `"Always"` | | | ||
| | modelAgent.image.repository | string | `"ghcr.io/moirai-internal/model-agent"` | | | ||
| | modelAgent.image.tag | string | `"v0.1.2"` | | | ||
| | modelAgent.nodeSelector | object | `{}` | | | ||
| | modelAgent.priorityClassName | string | `"system-node-critical"` | | | ||
| | modelAgent.resources.limits.cpu | string | `"10"` | | | ||
| | modelAgent.resources.limits.memory | string | `"100Gi"` | | | ||
| | modelAgent.resources.requests.cpu | string | `"10"` | | | ||
| | modelAgent.resources.requests.memory | string | `"100Gi"` | | | ||
| | modelAgent.serviceAccountName | string | `"ome-model-agent"` | | | ||
| | ome.benchmarkJob.cpuLimit | string | `"2"` | | | ||
| | ome.benchmarkJob.cpuRequest | string | `"2"` | | | ||
| | ome.benchmarkJob.image | string | `"ghcr.io/moirai-internal/genai-bench"` | | | ||
| | ome.benchmarkJob.memoryLimit | string | `"2Gi"` | | | ||
| | ome.benchmarkJob.memoryRequest | string | `"2Gi"` | | | ||
| | ome.benchmarkJob.tag | string | `"0.1.113"` | | | ||
| | ome.controller.affinity | object | `{}` | | | ||
| | ome.controller.deploymentMode | string | `"RawDeployment"` | | | ||
| | ome.controller.image | string | `"ghcr.io/moirai-internal/ome-manager"` | | | ||
| | ome.controller.ingressGateway.additionalIngressDomains | string | `nil` | | | ||
| | ome.controller.ingressGateway.disableIngressCreation | bool | `false` | | | ||
| | ome.controller.ingressGateway.disableIstioVirtualHost | bool | `false` | | | ||
| | ome.controller.ingressGateway.domain | string | `"svc.cluster.local"` | | | ||
| | ome.controller.ingressGateway.domainTemplate | string | `"{{ .Name }}.{{ .Namespace }}.{{ .IngressDomain }}"` | | | ||
| | ome.controller.ingressGateway.enableGatewayAPI | bool | `false` | | | ||
| | ome.controller.ingressGateway.ingressGateway.className | string | `"istio"` | | | ||
| | ome.controller.ingressGateway.ingressGateway.gateway | string | `"knative-serving/knative-ingress-gateway"` | | | ||
| | ome.controller.ingressGateway.ingressGateway.gatewayService | string | `"istio-ingressgateway.istio-system.svc.cluster.local"` | | | ||
| | ome.controller.ingressGateway.localGateway.gateway | string | `"knative-serving/knative-local-gateway"` | | | ||
| | ome.controller.ingressGateway.localGateway.gatewayService | string | `"knative-local-gateway.istio-system.svc.cluster.local"` | | | ||
| | ome.controller.ingressGateway.omeIngressGateway | string | `""` | | | ||
| | ome.controller.ingressGateway.pathTemplate | string | `""` | | | ||
| | ome.controller.ingressGateway.urlScheme | string | `"http"` | | | ||
| | ome.controller.nodeSelector | object | `{}` | | | ||
| | ome.controller.replicaCount | int | `3` | | | ||
| | ome.controller.resources.limits.cpu | int | `2` | | | ||
| | ome.controller.resources.limits.memory | string | `"4Gi"` | | | ||
| | ome.controller.resources.requests.cpu | int | `2` | | | ||
| | ome.controller.resources.requests.memory | string | `"4Gi"` | | | ||
| | ome.controller.tag | string | `"v0.1.2"` | | | ||
| | ome.controller.tolerations | list | `[]` | | | ||
| | ome.controller.topologySpreadConstraints | list | `[]` | | | ||
| | ome.kedaConfig.customPromQuery | string | `""` | | | ||
| | ome.kedaConfig.enableKeda | bool | `true` | | | ||
| | ome.kedaConfig.promServerAddress | string | `"http://prometheus-operated.monitoring.svc.cluster.local:9090"` | | | ||
| | ome.kedaConfig.scalingOperator | string | `"GreaterThanOrEqual"` | | | ||
| | ome.kedaConfig.scalingThreshold | string | `"10"` | | | ||
| | ome.metricsaggregator.enableMetricAggregation | string | `"false"` | | | ||
| | ome.metricsaggregator.enablePrometheusScraping | string | `"false"` | | | ||
| | ome.multinodeProber.cpuLimit | string | `"100m"` | | | ||
| | ome.multinodeProber.cpuRequest | string | `"100m"` | | | ||
| | ome.multinodeProber.image | string | `"ghcr.io/moirai-internal/multinode-prober"` | | | ||
| | ome.multinodeProber.memoryLimit | string | `"100Mi"` | | | ||
| | ome.multinodeProber.memoryRequest | string | `"100Mi"` | | | ||
| | ome.multinodeProber.startupFailureThreshold | int | `150` | | | ||
| | ome.multinodeProber.startupInitialDelaySeconds | int | `120` | | | ||
| | ome.multinodeProber.startupPeriodSeconds | int | `30` | | | ||
| | ome.multinodeProber.startupTimeoutSeconds | int | `60` | | | ||
| | ome.multinodeProber.tag | string | `"v0.1"` | | | ||
| | ome.multinodeProber.unavailableThresholdSeconds | int | `600` | | | ||
| | ome.omeAgent.authType | string | `"InstancePrincipal"` | | | ||
| | ome.omeAgent.compartmentId | string | `"ocid1.compartment.oc1..dummy-compartment"` | | | ||
| | ome.omeAgent.fineTunedAdapter.cpuLimit | int | `15` | | | ||
| | ome.omeAgent.fineTunedAdapter.cpuRequest | int | `15` | | | ||
| | ome.omeAgent.fineTunedAdapter.memoryLimit | string | `"320Gi"` | | | ||
| | ome.omeAgent.fineTunedAdapter.memoryRequest | string | `"300Gi"` | | | ||
| | ome.omeAgent.image | string | `"ghcr.io/moirai-internal/ome-agent"` | | | ||
| | ome.omeAgent.modelInit.cpuLimit | int | `15` | | | ||
| | ome.omeAgent.modelInit.cpuRequest | int | `15` | | | ||
| | ome.omeAgent.modelInit.memoryLimit | string | `"180Gi"` | | | ||
| | ome.omeAgent.modelInit.memoryRequest | string | `"150Gi"` | | | ||
| | ome.omeAgent.region | string | `"ap-osaka-1"` | | | ||
| | ome.omeAgent.tag | string | `"v0.1.2"` | | | ||
| | ome.omeAgent.vaultId | string | `"ocid1.vault.oc1.ap-osaka-1.dummy.dummy-vault"` | | | ||
| | ome.version | string | `"v0.1.2"` | | | ||
|
|
There was a problem hiding this comment.
While the new table formatting is a great improvement for readability, I noticed that the Description column is empty for all parameters. Since this pull request is focused on documentation cleanup, it would be a great opportunity to add descriptions for these values. This would make the Helm chart much easier to understand and use for new developers.
For example, for global.imagePullSecrets, you could add a description like "Image pull secrets for all containers in the chart".
This can likely be achieved by adding comments to the values.yaml file and regenerating this README with helm-docs.
| | `model.bucket_name` | `OME_AGENT_MODEL_BUCKET_NAME` | fine-tuned-model-weights | no | | ||
| | `model.namespace` | `OME_AGENT_MODEL_NAMESPACE` | | yes | | ||
| | `model.object_name` | `OME_AGENT_MODEL_OBJECT_NAME` | equals to `training_name` | no | | ||
| | |
There was a problem hiding this comment.
This looks like an extra empty row was added to the table. This should be removed for cleaner formatting.
1 participant
No description provided.