[Docs] Add better docs for using mlflow models serve
#1495
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
|
cc @stbof |
ghost
reviewed
Jun 24, 2019
| @@ -35,6 +35,19 @@ def serve(model_uri, port, host, workers, no_conda=False, install_mlflow=False): | |||
| Serve a model saved with MLflow by launching a webserver on the specified host and port. For | |||
| information about the input data formats accepted by the webserver, see the following | |||
| documentation: https://www.mlflow.org/docs/latest/models.html#model-deployment. | |||
|
|
|||
| Requests may be made to ``POST /invocations`` in Pandas split- or record-oriented formats. | |||
|
|
|||
There was a problem hiding this comment.
Prefer active to passive voice, can instead of may, and the correct spelling of pandas according to https://pandas.pydata.org/. Thus:
You can make requests to POST /invocations in pandas split- or record-oriented formats.
ghost
reviewed
Jun 24, 2019
docs/source/models.rst
Outdated
| @@ -490,7 +490,7 @@ be used to safely deploy the model to various environments such as Kubernetes. | |||
| You deploy MLflow model locally or generate a Docker image using the CLI interface to the | |||
| :py:mod:`mlflow.models` module. | |||
|
|
|||
| The REST API server accepts the following data formats as inputs: | |||
| The REST API server accepts the following data formats as inputs as a POST to the ``/invocations`` path: | |||
There was a problem hiding this comment.
The REST API server accepts the following data formats as POST input to the /invocations path:
avflor
pushed a commit
to avflor/mlflow
that referenced
this pull request
Aug 22, 2020
* [Docs] Add better docs for using `mlflow models serve` * Address comments
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.
What changes are proposed in this pull request?
Was playing around with
mlflow models serve, and it was surprisingly hard to figure out how to make a request against the spawned server -- had to dig through the mlflow code. This PR improves the docs to provide examples both in the CLI and the model deployment documentation.Release Notes
Is this a user-facing change?
What component(s) does this PR affect?
How should the PR be classified in the release notes? Choose one:
rn/breaking-change- The PR will be mentioned in the "Breaking Changes" sectionrn/none- No description will be included. The PR will be mentioned only by the PR number in the "Small Bugfixes and Documentation Updates" sectionrn/feature- A new user-facing feature worth mentioning in the release notesrn/bug-fix- A user-facing bug fix worth mentioning in the release notesrn/documentation- A user-facing documentation change worth mentioning in the release notes