Skip to content

chore(trainer): clarify namespace binding and CustomTrainer inputs (KEP-936)#324

Open
sjiang83 wants to merge 1 commit intokubeflow:mainfrom
sjiang83:docs/kep936-trainer-namespace-scriptcode
Open

chore(trainer): clarify namespace binding and CustomTrainer inputs (KEP-936)#324
sjiang83 wants to merge 1 commit intokubeflow:mainfrom
sjiang83:docs/kep936-trainer-namespace-scriptcode

Conversation

@sjiang83
Copy link

This PR adds a short "Design Notes (KEP-936 alignment)" block to the first Trainer quickstart example in the README.

It clarifies:

  • SDK vs direct API: why an SDK wrapper helps (consistent config/auth surface + Pythonic orchestration).
  • Namespace handling: TrainerClient binds namespace via KubernetesBackendConfig(namespace=...) (not per-call).
    • MCP suggestion: expose namespace as an explicit tool parameter and create/cache a per-namespace client internally.
  • CustomTrainer inputs: recommend script_code: str over serializing Python callables (with a brief validation/security roadmap).
  • Tooling scope: start with orchestration + observability; gate fine-grained tools via persona filtering.

Docs-only; no behavior changes.

Copilot AI review requested due to automatic review settings February 25, 2026 06:41
@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 astefanutti 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

Adds a “Design notes (KEP-936 alignment)” block to the first Trainer quickstart in the root README to clarify intended SDK vs API usage, namespace binding behavior, and the intended scope of MCP-facing tooling guidance.

Changes:

  • Adds a KEP-936 design-notes block before the Trainer quickstart code sample.
  • Documents namespace binding as a TrainerClient/KubernetesBackendConfig concern rather than a per-call parameter.
  • Introduces guidance on CustomTrainer input format and an MVP tool-surface stance for MCP integrations.

@sjiang83 sjiang83 changed the title docs(trainer): clarify namespace binding and CustomTrainer inputs (KEP-936) chore(trainer): clarify namespace binding and CustomTrainer inputs (KEP-936) Feb 25, 2026
@sjiang83 sjiang83 force-pushed the docs/kep936-trainer-namespace-scriptcode branch from 62b243f to ce8438a Compare February 25, 2026 06:47
Signed-off-by: Shanhuizi Jiang <sjiang83@fordham.edu>
@sjiang83 sjiang83 force-pushed the docs/kep936-trainer-namespace-scriptcode branch from ce8438a to 7bb2984 Compare February 25, 2026 06:55
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.

2 participants