-
Notifications
You must be signed in to change notification settings - Fork 45
feat(docs): add readme for localprocess #95
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Signed-off-by: Saad Zaher <szaher@redhat.com>
|
[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.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
|
||
| ## Supported Runtimes | ||
|
|
||
| Currently supported runtimes: | ||
|
|
||
| | Runtime | Framework | Description | Packages | | ||
| |---------|-----------|-------------|----------| | ||
| | `torch-distributed` | PyTorch | Distributed PyTorch training | `torch` | | ||
|
|
||
| ## Usage | ||
|
|
||
| ### Basic Setup | ||
|
|
||
| ```python | ||
| from kubeflow.trainer.backends.localprocess.backend import LocalProcessBackend |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would better move this user instruction to the KF Trainer user guides for now: https://www.kubeflow.org/docs/components/trainer/user-guides/
Similar to KFP, we can have this guide Execute TrainJobs Locally: https://www.kubeflow.org/docs/components/pipelines/user-guides/core-functions/execute-kfp-pipelines-locally/
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If you want to add architecture details, we can add Reference section at the bottom of this doc.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
+1, I think having an example on trainer repo and dedicated page on kubeflow website is sufficient for now
cc @briangallagher
What this PR does / why we need it:
add a readme to explain how to use the local-process backend.
Which issue(s) this PR fixes (optional, in
Fixes #<issue number>, #<issue number>, ...format, will close the issue(s) when PR gets merged):Fixes #
Checklist: