docs: add server Python API examples#5616
Open
GoparapukethaN wants to merge 1 commit into
Open
Conversation
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Closes #3828
Adds Python API examples for starting a local BentoML server and creating a client from code.
The client guide now shows the preferred
bentoml.serve()context-manager path, then documents the lower-levelHTTPServerandGrpcServerclasses for existing code that needs direct server-class access. I also added a small reference page for those server APIs and linked it from the BentoML reference index.I verified the server examples construct against an editable local BentoML install, checked the docs snippets are present, ran
git diff --check, and ran a Sphinx dummy build with a temp config that skips the local spelling extension because this machine does not have theenchantC library installed. The Sphinx build completed with existing docs warnings.