Enhance API Reference

[kramaranya]

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 👍

[kramaranya]

/remove-label lifecycle/needs-triage
/good-first-issue
/area docs

[google-oss-prow]

@kramaranya:
This request has been marked as suitable for new contributors.

Please ensure the request meets the requirements listed here.

If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-good-first-issue command.

Details

In response to this:

/remove-label lifecycle/needs-triage
/good-first-issue
/area docs

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[RavinduWeerakoon]

Hi, I would like to work on this issue
/assign