docs: Indicate which model-runtime proto SPI rpcs are optional #50
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
Motivation In the model server gRPC service provider interface, implementation of the predictModelSize RPC is optional, and modelSize doesn't need to be implemented if sizes are always returned in the loadModel response. This is documented in the modelmesh docs but not in the comments of the service .proto file. Modifications Add appropriate wording to doc comments in the model-runtime.proto file to convey the fact these rpcs aren't required. Result Clearer docs Signed-off-by: Nick Hill <nickhill@us.ibm.com>
|
These should also be synced to the copy in the docs dir of the |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: chinhuang007, njhill The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
kserve-oss-bot
pushed a commit
to kserve/modelmesh-serving
that referenced
this pull request
Aug 2, 2022
#### Motivation The docs dir in this repo contains a copy of the `model-runtime.proto` service definition from the model-mesh repo. It was [recently updated](kserve/modelmesh#50) with clearer comments for a couple of the RPC methods. #### Modifications Sync the latest version to this repo. Signed-off-by: Nick Hill <nickhill@us.ibm.com> Signed-off-by: Nick Hill <nickhill@us.ibm.com>
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.
Motivation
In the model server gRPC service provider interface, implementation of the
predictModelSizeRPC is optional, andmodelSizedoesn't need to be implemented if sizes are always returned in theloadModelresponse.This is documented in the modelmesh docs but not in the comments of the service .proto file.
Modifications
Add appropriate wording to doc comments in the
model-runtime.protofile to convey the fact these rpcs aren't required.Result
Clearer docs
Signed-off-by: Nick Hill nickhill@us.ibm.com