Skip to content

Conversation

@szaher
Copy link
Member

@szaher szaher commented Sep 15, 2025

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:

  • Docs included if any changes are user facing

Signed-off-by: Saad Zaher <szaher@redhat.com>
@google-oss-prow
Copy link

[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 electronic-waste for approval. For more information see the Kubernetes Code Review Process.

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@szaher szaher changed the title add readme for localprocess feat(docs): add readme for localprocess Sep 15, 2025
Comment on lines +65 to +79

## 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
Copy link
Member

@andreyvelich andreyvelich Sep 15, 2025

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/

Copy link
Member

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.

Copy link
Contributor

@kramaranya kramaranya Oct 2, 2025

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

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.

3 participants