Skip to content

docs: add local development guide#261

Open
Raakshass wants to merge 3 commits intokubeflow:mainfrom
Raakshass:docs/local-development
Open

docs: add local development guide#261
Raakshass wants to merge 3 commits intokubeflow:mainfrom
Raakshass:docs/local-development

Conversation

@Raakshass
Copy link

@Raakshass Raakshass commented Feb 3, 2026

Closes #259

Summary

This PR adds a Local Development with SDK Backends guide to help users understand and switch between available training backends.

Content Covered

  • Backend comparison table (LocalProcess, Container, Kubernetes)
  • When to use each backend - quick prototyping vs distributed training vs production
  • Code examples for each backend configuration
  • Switching between backends - same trainer code works across all backends
  • Common operations (list jobs, view logs, wait, delete)
  • Troubleshooting tips for each backend

Changes Based on Feedback

Revised from contributor dev setup to user-facing backends guide per @Fiona-Waters feedback.

Checklist

  • Follows existing documentation style (RST format)
  • Aligned with kubeflow.org Trainer docs structure
  • Includes comparison table as requested in Document Local Development #259

@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 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

github-actions bot commented Feb 3, 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! 🙏

Updates the getting started index to include the new local development guide.

Signed-off-by: Siddhant Jain <[email protected]>
@Raakshass Raakshass force-pushed the docs/local-development branch from 4a0f42a to cf67ce0 Compare February 3, 2026 19:02
@Fiona-Waters
Copy link
Contributor

Fiona-Waters commented Feb 4, 2026

@Raakshass Thank you for your interest in contributing. The aim of this issue is to add a guide for customers that would like to use our local and container backends. We would like to show them how to easily switch between available backends, when to use each of them etc. Please re-read the issue description and let me know if you have any questions.

@Raakshass
Copy link
Author

Thanks @Fiona-Waters for the clarification! I misunderstood the scope - I'll revise my PR to focus on the user-facing local and container backends guide instead of contributor dev setup.

I'll update it to cover:

  • Backend comparison (LocalProcess vs Container vs Kubernetes)
  • When to use each backend
  • Code examples for switching between backends
  • Common operations and troubleshooting

Will push the updated content shortly!

@Raakshass Raakshass marked this pull request as draft February 4, 2026 18:21
@Raakshass Raakshass marked this pull request as ready for review February 4, 2026 18:23
@google-oss-prow google-oss-prow bot requested a review from kramaranya February 4, 2026 18:24
@Raakshass
Copy link
Author

@Fiona-Waters I updated the PR content described above. I'm unable to edit the PR title to "docs: add local development with SDK backends guide" - could you please update it? Thanks!

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.

Document Local Development

2 participants