Repository navigation
fix(docs): fix two Trainer snippets that fail when copied - #941
Open
prabindersinghh wants to merge 1 commit into
Open
prabindersinghh wants to merge 1 commit into
prabindersinghh wants to merge 1 commit into
Conversation
The local backend example in the quickstart imports LocalProcessBackendConfig from kubeflow.trainer.backends.localprocess, which does not export it. Import it from kubeflow.trainer instead. The custom container example in runtimes passes command= to CustomTrainerContainer, which has no such field and raises TypeError. Set the command with the TrainerCommand option, which is the supported way to override it. Assisted-by: Claude Signed-off-by: Prabinder Singh <prabindersinghh@gmail.com>
Contributor
|
[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 |
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What this PR does / why we need it:
Two Trainer doc snippets raise as soon as they are run:
getting-started/quickstart.rst: the local backend example importsLocalProcessBackendConfigfromkubeflow.trainer.backends.localprocess, which does not export it (ImportError). It now imports it fromkubeflow.trainer.train/runtimes.rst: the custom container example passescommand=toCustomTrainerContainer, which has no such field (TypeError). It now sets the command with theTrainerCommandoption, which is the supported way to override it.Note on #876: it fixes the
kubeflow.trainer.typesimport on the line just above the runtimes example. I changed that line to exactly what #876 uses, so whichever of the two merges second only needs a trivial rebase.Validation:
TrainerCommandwrites the command to.spec.trainer.commandWhich issue(s) this PR fixes (optional, in
Fixes #<issue number>, #<issue number>, ...format, will close the issue(s) when PR gets merged):Fixes #939
Checklist:
AI usage:
Claude was used to help find and fix the two snippets. I reviewed the changes and checked both snippets against main myself.