Skip to content

Conversation

@NarayanaSabari
Copy link

@NarayanaSabari NarayanaSabari commented Oct 28, 2025

What this PR does / why we need it:

  1. Implements automated documentation generation for Kubeflow SDK
  2. Adds comprehensive guide for using KatibClient outside Kubernetes clusters with Service Account tokens
  3. Covers real-world use cases: EC2, CI/CD pipelines, and development machines

Which issue(s) this PR fixes:

Fixes #50

Related issues:

Relates to kubeflow/katib#2046

Special notes for your reviewer:

  • Auto-docs generation workflow ready for SDK components
  • KatibClient examples verified against actual Katib SDK implementation (v1beta1)
  • Includes both TrainerClient and KatibClient configuration patterns
  • SSL certificate handling for self-signed certificates
  • Practical troubleshooting for common errors (401/403, SSL, connection issues)

Checklist:

  • Auto-docs generation implementation
  • Documentation follows restructuredText format
  • Code examples tested against Katib codebase
  • Includes troubleshooting guidance
  • References related GitHub issues

Here is the deployed link: https://kf-sdk.readthedocs.io/en/latest/

@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

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.

[SDK] Generate Docs for Kubeflow SDK

1 participant