area/docsgood first issuehelp wantedkind/feature
仓库指标
- Star
- (124 star)
- PR 合并指标
- (PR 指标待抓取)
描述
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 👍