docs: Update Custom Runtime Docs #277
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
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: rafvasq The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Signed-off-by: Rafael Vasquez <[email protected]>
rafvasq
force-pushed
the
custom-runtime-fix
branch
from
77ea4ba to
0fd5db1
Compare
chinhuang007
approved these changes
Nov 14, 2022
|
/lgtm |
|
/lgtm |
njhill
approved these changes
Nov 16, 2022
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
While creating a Python-based custom runtime, I found that some of the documentation and templates could be a bit more helpful with naming conventions, hints, and formatting to match the MLServer built-in runtime for ease of comparison.
Modifications
Copy-edited docs while adding help and clarification to templates.
Result
Friendlier documentation for building and deploying custom runtimes.