Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Closed
2 tasks done
mdemoret-nv opened this issue May 24, 2024 · 0 comments · Fixed by #1721
Closed
2 tasks done

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

mdemoret-nv opened this issue May 24, 2024 · 0 comments · Fixed by #1721
Assignees
@acaklovic-nv
Labels
feature request New feature or request

Comments

@mdemoret-nv
Copy link
Contributor

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

  • I agree to follow this project's Code of Conduct
  • I have searched the open feature requests and have found no duplicates for this feature request
@mdemoret-nv mdemoret-nv added the feature request New feature or request label May 24, 2024
@acaklovic-nv acaklovic-nv mentioned this issue May 24, 2024
Merged
rapids-bot bot pushed a commit that referenced this issue May 28, 2024
@acaklovic-nv
Add function return documentation for LLMService (#1721)
3360602 
- Changes to add return types for classes derived from in LLMService and LLMClient (llm_service.py)

"fixes #1720 "

## By Submitting this PR I confirm:
- I am familiar with the [Contributing Guidelines](https://github.com/nv-morpheus/Morpheus/blob/main/docs/source/developer_guide/contributing.md).
- When the PR is ready for review, new or existing tests cover these changes.
- When the PR is ready for review, the documentation is up to date with these changes.

Authors:
  - https://github.com/acaklovic-nv

Approvers:
  - Michael Demoret (https://github.com/mdemoret-nv)

URL: #1721
@github-project-automation github-project-automation bot moved this from Todo to Done in Morpheus Boards May 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@acaklovic-nv acaklovic-nv

Labels
feature request New feature or request
Projects
Morpheus Boards
Status: Done
Milestone
No milestone
2 participants
@mdemoret-nv @acaklovic-nv