Update MLI docstrings part 1 #692
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## mli-feature #692 +/- ##
==============================================
Coverage ? 69.50%
==============================================
Files ? 103
Lines ? 8750
Branches ? 0
==============================================
Hits ? 6082
Misses ? 2668
Partials ? 0
|
mellis13
approved these changes
Sep 9, 2024
| :param key: the key of the model to check for existence | ||
| :returns: whether the model is available on the device | ||
| :param key: The key of the model to check for existence | ||
| :returns: Whether the model is available on the device | ||
| """ | ||
| return key in self._models | ||
|
|
There was a problem hiding this comment.
Oops! Fixed. (Definitely check this one.)
| @@ -109,9 +114,9 @@ def _load_model_on_device( | |||
|
|
|||
There was a problem hiding this comment.
I think the previous line would be more correct as:
```Load the model needed to execute a batch on the managed device.``
|
|
||
| the model needed to run the batch of requests is | ||
| guaranteed to be available on the model | ||
| The model needed to run the batch of requests is |
There was a problem hiding this comment.
should on the model be on the device?
There was a problem hiding this comment.
I think so! Fixed.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I added and updated the MLI docstrings so that everything renders correctly and they are more consistent. This means I needed to make some decisions on what "consistent" means, because there were many different combinations going on. Feel free to push back on these! I just went with what looked like the best/what we were doing the most.
:param:,:returns:, etc do not use punctuation to end their description line UNLESS the line needs multiple sentences, in which case, use punctuation. (I think this happens once or twice).example: