kubeflow/sdk

Enhance API Reference

Open

#260 opened on 2026年2月3日

GitHub で見る
 (5 comments) (4 reactions) (2 assignees)Python (196 forks)auto 404
area/docsgood first issuehelp wantedkind/feature

Repository metrics

Stars
 (124 stars)
PR merge metrics
 (PR metrics pending)

説明

What you would like to be added?

Expand the API reference documentation for all three clients TrainerClient, OptimizerClient, ModelRegistryClient to include complete method documentation with description, params, returns, return type, raises, example.

Why is this needed?

The current API docs are auto-generated from docstrings and only show method signatures with parameter descriptions. Users need to see how methods are actually used in practice. Complete API documentation is essential for developer experience.

Love this feature?

Give it a 👍 We prioritize the features with most 👍

コントリビューターガイド