-
Notifications
You must be signed in to change notification settings - Fork 234
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.
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
Fix docstring for sphinx autodoc #443
Conversation
@@ -42,5 +43,6 @@ def __call__(self, request): | |||
---------- | |||
request : Request | |||
The request object. | |||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: extra space
Leaving a bulk comment here because I cannot leave comments on unchaged lines: Should return fields like this also be decorated? # Original
InferResult
"The object holding the result of the inference."
# Suggestion
InferResult
"A :py:class:`InferResult` object holding the result of the inference." =====================================================================
===================================================================== # Name
grep -r --include='*.py' -nF '{OBJ_NAME}' |
@@ -32,6 +32,7 @@ | |||
from tritonclient.utils import * | |||
|
|||
from .._plugin import InferenceServerClientPlugin | |||
from .._request import Request |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
do we need to import this? Is this redundant?
@fpetrini15 The decoration is for cross-referencing. For the case that you described, we have link within the return type itself. Hence, adding more cross-reference seems redundant exercise. I will double-check if I missed something crucial. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM at a glance. @tanmayv25 can you share link to rendered version for a quick visual look?
__all__ = [ | ||
"InferenceServerClientPlugin", | ||
"Request", | ||
"InferenceServerClient", | ||
"InferInput", | ||
"InferRequestedOutput", | ||
"InferResult", | ||
"KeepAliveOptions", | ||
"InferenceServerException", | ||
] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this may have broken usage of MAX_GRPC_MESSAGE_SIZE
inside aio client as it's not an undefined variable
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This affects the output of from tritonclient.grpc import *
because now it is only importing these symbols defined by __all__
when called in aio here.
No description provided.