Skip to content

Comments

​docs(sdk): update AGENTS.md for OptimizerClient#304

Open
khushiwayal wants to merge 1 commit intokubeflow:mainfrom
khushiwayal:docs/update-agents-md
Open

​docs(sdk): update AGENTS.md for OptimizerClient#304
khushiwayal wants to merge 1 commit intokubeflow:mainfrom
khushiwayal:docs/update-agents-md

Conversation

@khushiwayal
Copy link

Hi everyone! I'm a first-year student and this is my first contribution to the Kubeflow repo.

I saw Issue #189 and wanted to help out. I've updated the AGENTS.md file under the Context Awareness section to include the rules for the new OptimizerClient. I added the required import paths, the backend execution options, and the rules for defining the Search Space so AI agents will generate the correct hyperparameter tuning code.

Fixes #189

Please let me know if I need to adjust any of the formatting!

Copilot AI review requested due to automatic review settings February 18, 2026 13:28
@google-oss-prow
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign electronic-waste for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@github-actions
Copy link
Contributor

🎉 Welcome to the Kubeflow SDK! 🎉

Thanks for opening your first PR! We're happy to have you as part of our community 🚀

Here's what happens next:

  • If you haven't already, please check out our Contributing Guide for repo-specific guidelines and the Kubeflow Contributor Guide for general community standards
  • Our team will review your PR soon! cc @kubeflow/kubeflow-sdk-team

Join the community:

Feel free to ask questions in the comments if you need any help or clarification!
Thanks again for contributing to Kubeflow! 🙏

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates AGENTS.md to better guide AI agents/contributors when generating Kubeflow Optimizer hyperparameter tuning code, aligning agent guidance with the Optimizer SDK surface.

Changes:

  • Adds a new “OptimizerClient (Hyperparameter Tuning)” section under Context Awareness.
  • Documents recommended imports and how to define search spaces using Search.


**Key rules for OptimizerClient:**
- **Import path:** `from kubeflow.optimizer import OptimizerClient, Search, TrialConfig`
- **Execution:** It supports both local execution (`ContainerBackend`, `LocalProcessBackend`) and remote Kubernetes cluster execution (`KubernetesBackend`).
Copy link

Copilot AI Feb 18, 2026

Choose a reason for hiding this comment

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

The execution guidance is inaccurate: OptimizerClient currently only supports KubernetesBackend via KubernetesBackendConfig (no ContainerBackend/LocalProcessBackend backends exist under kubeflow/optimizer/backends).

Suggested change
- **Execution:** It supports both local execution (`ContainerBackend`, `LocalProcessBackend`) and remote Kubernetes cluster execution (`KubernetesBackend`).
- **Execution:** It currently supports only remote Kubernetes cluster execution via `KubernetesBackend` configured through `KubernetesBackendConfig` (local backends such as `ContainerBackend` and `LocalProcessBackend` are not available).

Copilot uses AI. Check for mistakes.
@@ -27,7 +27,13 @@ Before writing code, agents should:
- Read docstrings and existing test cases for pattern alignment
- Match import patterns from neighboring files
- Preserve existing logging and error-handling conventionso
Copy link

Copilot AI Feb 18, 2026

Choose a reason for hiding this comment

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

Typo: "conventionso" should be "conventions".

Suggested change
- Preserve existing logging and error-handling conventionso
- Preserve existing logging and error-handling conventions

Copilot uses AI. Check for mistakes.
@khushiwayal khushiwayal changed the title docs: add OptimizerClient context to AGENTS.md docs(optimizer): Add OptimizerClient context to AGENTS.md Feb 18, 2026
@khushiwayal khushiwayal changed the title docs(optimizer): Add OptimizerClient context to AGENTS.md ​docs(optimizer): Add OptimizerClient context to AGENTS.md Feb 20, 2026
@khushiwayal khushiwayal changed the title ​docs(optimizer): Add OptimizerClient context to AGENTS.md docs(optimizer): add OptimizerClient context to AGENTS.md Feb 20, 2026
@khushiwayal khushiwayal changed the title docs(optimizer): add OptimizerClient context to AGENTS.md docs: update AGENTS.md with OptimizerClient information Feb 20, 2026
@khushiwayal khushiwayal changed the title docs: update AGENTS.md with OptimizerClient information ​docs(sdk): update AGENTS.md for OptimizerClient Feb 20, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update AGENTS.md with OptimizerClient and new features

1 participant