nv-morpheus / Morpheus

Morpheus SDK
Apache License 2.0
310 stars 119 forks source link

[FEA]: Add function return documentation for `LLMService` #1720

Closed mdemoret-nv closed 1 month ago

mdemoret-nv commented 1 month ago

Is this a new feature, an improvement, or a change to existing functionality?

Improvement

How would you describe the priority of this feature request

Low (would be nice)

Please provide a clear description of problem this feature solves

All of the docstrings in the LLMService and derived classes do not document the return types.

Describe your ideal solution

Add return types for classes derived from LLMService and LLMClient. Return type annotations should be in the numpydoc format. i.e.

        Returns
        -------
        str
            _description_

Additional context

No response

Code of Conduct