Skip to content
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

docs(api): Add additional docs to describe behaviour of model redeployment #478

Merged
merged 2 commits into from
Oct 25, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/images/redeploy_model_unsuccessful.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 16 additions & 0 deletions docs/user-guide/model_deployment_serving.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,19 @@ There are two types of Model Version deployment, standard and python function (P
Model serving is the next step of model deployment. After we have a running Model Version Endpoint, we can start serving the HTTP traffic by routing the Model Endpoint to it.

![Model Deployment and Serving](../diagrams/model_deployment_serving.drawio.svg)

# Model Versions and Deployments
Each model version can deployed with a different set of deployment configurations, such as the number of
replicas, CPU/memory requests, autoscaling policy, environment variables, etc. Each set of these configurations that are
used to deploy a model version are called a *deployment*.

While each model can have up to **2** model versions deployed at any point of time, each model version can only be
deployed using **1** deployment at any point of time.

Whenever a running model version is redeployed, a new *deployment* is created and the Merlin API server attempts to
deadlycoconuts marked this conversation as resolved.
Show resolved Hide resolved
deploy it, all while keep the existing deployment running.

If the deployment of the new configuration fails, **the old deployment stays deployed** and remains as the current
*deployment* of the model version. The new configuration will then show a 'Failed' status.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm thinking of adding some screenshots of the UI here to show the new deployment history panel but I don't think it's absolutely necessary here because the rest of the docs don't really show screenshots of the UI. We can still do this for a start and add UI screenshots for the rest of the docs subsequently too. What do you all think?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think one ss here here will do

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, I'll see what I can find and add one here.


![Unsuccessful redeployment](../images/redeploy_model_unsuccessful.png)
Loading