kubeflow/sdk

Enhance API Reference

Open

#260 geöffnet am 3. Feb. 2026

Auf GitHub ansehen
 (5 Kommentare) (4 Reaktionen) (2 zugewiesene Personen)Python (196 Forks)auto 404
area/docsgood first issuehelp wantedkind/feature

Repository-Metriken

Stars
 (124 Stars)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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 👍

Contributor Guide

Research-Richtung
Tech Stack
Domain
Issue Type
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Voraussetzungen
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.