Skip to content

Comments

chore(trainer): Align list_runtimes docstring with namespace-scoped TrainingRuntime behavior#305

Open
shaikmoeed wants to merge 2 commits intokubeflow:mainfrom
shaikmoeed:doc/update-list-runtimes
Open

chore(trainer): Align list_runtimes docstring with namespace-scoped TrainingRuntime behavior#305
shaikmoeed wants to merge 2 commits intokubeflow:mainfrom
shaikmoeed:doc/update-list-runtimes

Conversation

@shaikmoeed
Copy link
Contributor

@shaikmoeed shaikmoeed commented Feb 18, 2026 •
edited
Loading

What this PR does / why we need it:
Update the client-facing list_runtimes API docstring to reflect current behavior i.e., including support for namespace-scoped TrainingRuntime resources.

Fixes #88 #130

Checklist:

  • Docs included if any changes are user facing

@shaikmoeed
Align docstring with current behavior
f08d545 
Signed-off-by: Moeed Shaik <shaikmoeed@gmail.com>
Copilot AI review requested due to automatic review settings February 18, 2026 15:06
@google-oss-prow
Copy link
Contributor

google-oss-prow bot commented Feb 18, 2026

[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

@github-actions
Copy link
Contributor

github-actions bot commented Feb 18, 2026

🎉 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! 🙏

@shaikmoeed shaikmoeed changed the title Align list_runtimes docstring with namespace-scoped TrainingRuntime behavior docs(trainer): Align list_runtimes docstring with namespace-scoped TrainingRuntime behavior Feb 18, 2026
@shaikmoeed
Copy link
Contributor Author

shaikmoeed commented Feb 18, 2026

@andreyvelich, can you please review this following up PR?

@coveralls
Copy link

coveralls commented Feb 18, 2026 •
edited
Loading

Pull Request Test Coverage Report for Build 22145544685

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 76.574%
Totals Coverage Status
Change from base Build 22144252595: 0.0%
Covered Lines: 4331
Relevant Lines: 5656
💛 - Coveralls

andreyvelich
andreyvelich reviewed Feb 18, 2026
View reviewed changes
@shaikmoeed shaikmoeed changed the title docs(trainer): Align list_runtimes docstring with namespace-scoped TrainingRuntime behavior chore(trainer): Align list_runtimes docstring with namespace-scoped TrainingRuntime behavior Feb 18, 2026
@shaikmoeed
updated for get_runtime
18cc0c3 
Signed-off-by: Moeed Shaik <shaikmoeed@gmail.com>
@google-oss-prow google-oss-prow bot added size/S and removed size/XS labels Feb 18, 2026
Copilot AI reviewed Feb 18, 2026
View reviewed changes
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 the SDK’s TrainerClient.list_runtimes() docstring to reflect support for namespace-scoped TrainingRuntime resources (in addition to cluster-scoped runtimes) and the “prefer namespaced on name collisions” behavior.

Changes:

  • Revise list_runtimes docstring to mention namespace-scoped + cluster-scoped runtime listing.
  • Document duplicate-name resolution preference for namespace-scoped runtimes.

kubeflow/trainer/api/trainer_client.py
Comment on lines +66 to +72
"""List of the available runtimes, preferring namespaced over cluster-scoped for duplicates.

Returns:
A list of available training runtimes. If no runtimes exist, an empty list is returned.
A list of training runtimes from both namespace-scoped and
cluster-scoped resources. If duplicates exist, the
namespace-scoped runtime is preferred. Returns an empty list
if no runtimes are found.
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 updated list_runtimes docstring describes Kubernetes-specific behavior (namespace-scoped vs cluster-scoped runtime resources and duplicate resolution), but TrainerClient also supports LocalProcess and Container backends whose list_runtimes() implementations do not have this notion; please qualify the docstring (e.g., "When using the Kubernetes backend...") or reword it to be backend-agnostic so it remains accurate for all backends.

Copilot uses AI. Check for mistakes.
@shaikmoeed
Copy link
Contributor Author

shaikmoeed commented Feb 18, 2026

@andreyvelich CI failures are mostly due to timeouts. Possible to re-run them, or is it a whitespace change?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@kramaranya kramaranya Awaiting requested review from kramaranya

@szaher szaher Awaiting requested review from szaher

@andreyvelich andreyvelich Awaiting requested review from andreyvelich

Assignees

No one assigned

Labels

size/S

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Support namespaced TrainingRuntime in the SDK

3 participants

@shaikmoeed @coveralls @andreyvelich