kubeflow/sdk

Document how to use `options` with TrainerClient

Closed

#388 opened on Mar 16, 2026

View on GitHubContributor guide
 (9 comments) (0 reactions) (1 assignee)Python (196 forks)auto 404
area/docsgood first issuehelp wanted

Repository metrics

Stars
 (124 stars)
PR merge metrics
 (PR metrics pending)

Description

We should update documentation to explain how to use options while creating TrainJob to configure RuntimePatch API.

https://sdk.kubeflow.org/en/latest/

cc @kubeflow/kubeflow-sdk-team @Fiona-Waters

/good-first-issue /area docs

Contributor guide

Research direction
Review the existing documentation for TrainerClient and the source code to understand how the `options` parameter is used in TrainJob. Look for examples of RuntimePatch configuration and document how to pass options to configure it.
Tech stack
python
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85