docs(sdk): update AGENTS.md for OptimizerClient#304
docs(sdk): update AGENTS.md for OptimizerClient#304khushiwayal wants to merge 1 commit intokubeflow:mainfrom
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
|
🎉 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:
Join the community:
Feel free to ask questions in the comments if you need any help or clarification! |
There was a problem hiding this comment.
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`). |
There was a problem hiding this comment.
The execution guidance is inaccurate: OptimizerClient currently only supports KubernetesBackend via KubernetesBackendConfig (no ContainerBackend/LocalProcessBackend backends exist under kubeflow/optimizer/backends).
| - **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). |
| @@ -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 | |||
There was a problem hiding this comment.
Typo: "conventionso" should be "conventions".
| - Preserve existing logging and error-handling conventionso | |
| - Preserve existing logging and error-handling conventions |
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!