Skip to content

Conversation

@aniketpati1121
Copy link
Contributor

@aniketpati1121 aniketpati1121 commented Dec 8, 2025

  • Added Client Entrypoints section for TrainerClient and OptimizerClient
  • Updated Trainer Types: CustomTrainer, CustomTrainerContainer, BuiltinTrainer
  • Added Backends, Training Options, Typical Flow, and Integration Patterns
  • Updated Repository Map for clarity
    fixes Update AGENTS.md with OptimizerClient and new features #189

…backends, and training flow

Signed-off-by: Aniket Patil <[email protected]>
@google-oss-prow
Copy link

[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 andreyvelich 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

@aniketpati1121 aniketpati1121 changed the title docs(trainer): update AGENTS.md with new Trainer and Optimizer details docs: update AGENTS.md with Trainer component and client entrypoints Dec 8, 2025
@coveralls
Copy link

coveralls commented Dec 8, 2025

Pull Request Test Coverage Report for Build 21257997032

Warning: 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

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 243 unchanged lines in 11 files lost coverage.
  • Overall coverage increased (+0.9%) to 67.52%

Files with Coverage Reduction New Missed Lines %
kubeflow/optimizer/backends/base.py 2 0.0%
kubeflow/trainer/backends/base.py 3 71.43%
kubeflow/optimizer/api/optimizer_client.py 5 0.0%
kubeflow/trainer/types/types.py 7 96.17%
kubeflow/trainer/backends/kubernetes/backend_test.py 10 96.12%
kubeflow/trainer/api/trainer_client.py 12 69.05%
kubeflow/trainer/backends/localprocess/backend.py 25 73.17%
kubeflow/trainer/backends/kubernetes/backend.py 30 79.78%
kubeflow/trainer/backends/container/backend.py 31 78.5%
kubeflow/trainer/backends/kubernetes/utils.py 45 77.35%
Totals Coverage Status
Change from base Build 19937262845: 0.9%
Covered Lines: 2769
Relevant Lines: 4101

💛 - Coveralls

@aniketpati1121 aniketpati1121 changed the title docs: update AGENTS.md with Trainer component and client entrypoints docs(agents): update Trainer component and client entrypoints Dec 8, 2025
@aniketpati1121 aniketpati1121 changed the title docs(agents): update Trainer component and client entrypoints docs(trainer): update AGENTS.md with client entrypoints and types Dec 8, 2025
@aniketpati1121 aniketpati1121 changed the title docs(trainer): update AGENTS.md with client entrypoints and types docs(trainer): update AGENTS.md with TrainerClient and OptimizerClient Dec 8, 2025
@aniketpati1121 aniketpati1121 changed the title docs(trainer): update AGENTS.md with TrainerClient and OptimizerClient docs(trainer): update AGENTS.md with TrainerClient and OptimizerClient" Dec 8, 2025
@aniketpati1121 aniketpati1121 force-pushed the docs/update-agents-trainer-section branch from b1de17a to c1ff5e7 Compare December 8, 2025 03:29
@aniketpati1121 aniketpati1121 changed the title docs(trainer): update AGENTS.md with TrainerClient and OptimizerClient" docs(trainer): update AGENTS.md with TrainerClient and OptimizerClient Dec 8, 2025
@aniketpati1121 aniketpati1121 changed the title docs(trainer): update AGENTS.md with TrainerClient and OptimizerClient docs(trainer): add trainerclient and optimizerclient sections to agents.md Dec 8, 2025
@aniketpati1121 aniketpati1121 changed the title docs(trainer): add trainerclient and optimizerclient sections to agents.md docs(trainer): update agents.md with trainerclient and optimizerclient Dec 8, 2025
@aniketpati1121 aniketpati1121 changed the title docs(trainer): update agents.md with trainerclient and optimizerclient docs(trainer): add trainerclient and optimizerclient sections Dec 8, 2025
@aniketpati1121 aniketpati1121 force-pushed the docs/update-agents-trainer-section branch from c1ff5e7 to d4d13b2 Compare December 8, 2025 03:37
@aniketpati1121 aniketpati1121 changed the title docs(trainer): add trainerclient and optimizerclient sections docs(agents): add TrainerClient and OptimizerClient sections Dec 8, 2025
@aniketpati1121 aniketpati1121 changed the title docs(agents): add TrainerClient and OptimizerClient sections docs(agents): add trainerclient and optimizerclient sections Dec 8, 2025
@aniketpati1121 aniketpati1121 changed the title docs(agents): add trainerclient and optimizerclient sections docs(agents): add trainerclient and optimizerclient Dec 8, 2025
@aniketpati1121 aniketpati1121 changed the title docs(agents): add trainerclient and optimizerclient docs: update agents documentation Dec 8, 2025
@aniketpati1121 aniketpati1121 changed the title docs: update agents documentation docs(sdk): update agents documentation Dec 8, 2025
@aniketpati1121 aniketpati1121 changed the title docs(sdk): update agents documentation docs(trainer): add trainerclient and optimizerclient Dec 8, 2025
@aniketpati1121 aniketpati1121 changed the title docs(trainer): add trainerclient and optimizerclient docs: update agents documentation Dec 8, 2025
@aniketpati1121 aniketpati1121 changed the title docs: update agents documentation docs(trainer): add trainerclient and optimizerclient sections Dec 8, 2025
@aniketpati1121 aniketpati1121 changed the title docs(trainer): add trainerclient and optimizerclient sections chore(trainer): add trainerclient and optimizerclient sections Dec 8, 2025
@andreyvelich andreyvelich requested a review from Copilot January 22, 2026 16:58
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

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
Copy link

Copilot AI Jan 22, 2026

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.

Copilot uses AI. Check for mistakes.

**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.
Copy link

Copilot AI Jan 22, 2026

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.

Copilot uses AI. Check for mistakes.
aniketpati1121 and others added 2 commits January 22, 2026 22:49
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
Copy link
Member

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

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

3 participants