-
Notifications
You must be signed in to change notification settings - Fork 70
chore(trainer): add trainerclient and optimizerclient sections #190
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
base: main
Are you sure you want to change the base?
chore(trainer): add trainerclient and optimizerclient sections #190
Conversation
…backends, and training flow Signed-off-by: Aniket Patil <[email protected]>
|
[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 |
Pull Request Test Coverage Report for Build 21257997032Warning: This coverage report may be inaccurate.This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.
Details
💛 - Coveralls |
b1de17a to
c1ff5e7
Compare
Signed-off-by: Aniket Patil <[email protected]>
c1ff5e7 to
d4d13b2
Compare
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.
Pull request overview
This PR enhances the documentation for the Trainer component by restructuring the content into clearer, more organized sections. The changes improve readability and provide better navigation for developers working with training workflows.
Changes:
- Reorganized Trainer documentation with clearer section headers and structure
- Added dedicated sections for Client Entrypoints, Backends, Training Options, Typical Flow, and Integration Patterns
- Expanded Trainer Types descriptions with better formatting and more detailed attribute listings
- Added a Repository Map section to help developers navigate the codebase
| --- | ||
|
|
||
| **CustomTrainerContainer** (`kubeflow.trainer.types.CustomTrainerContainer`): | ||
| ## Components |
Copilot
AI
Jan 22, 2026
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 heading '## Components' is at the wrong level and is misleading. This section only describes the Trainer component, not multiple components. Since it follows 'Component: Trainer', this should either be removed or changed to '### Trainer Details' or similar to maintain proper hierarchy.
|
|
||
| **Trainer Types**: | ||
| - `TrainerClient` – Main entrypoint to submit and manage training jobs. | ||
| - `OptimizerClient` – Used to configure and manage optimization workflows such as hyperparameter tuning and performance optimization. |
Copilot
AI
Jan 22, 2026
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 description states OptimizerClient is for 'optimization workflows such as hyperparameter tuning and performance optimization' but doesn't clarify how this differs from TrainerClient or when to use each. Consider adding a brief note about when to use OptimizerClient vs TrainerClient.
Co-authored-by: Copilot <[email protected]> Signed-off-by: Aniket Patil <[email protected]>
Co-authored-by: Copilot <[email protected]> Signed-off-by: Aniket Patil <[email protected]>
| ``` | ||
|
|
||
| ## Component: Trainer | ||
| ### Client Entrypoints |
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.
I don't think we need to be too detailed here since agents can always read the code for additional context.
Similar to this PR, can you better improve the repository map which shows where to find TrainerClient APIs, OptimizerClient APIs, and ModelRegistry client API: kubeflow/trainer#3121
fixes Update AGENTS.md with OptimizerClient and new features #189