Skip to content

Commit ab9c986

Browse files
authored
RHOAIENG-28400 - Document on-off toggle for stop/start models (#881)
1 parent 5dbad50 commit ab9c986

File tree

3 files changed

+24
-2
lines changed

3 files changed

+24
-2
lines changed

assemblies/serving-large-models.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ include::modules/enabling-the-single-model-serving-platform.adoc[leveloffset=+2]
1919
include::modules/adding-a-custom-model-serving-runtime-for-the-single-model-serving-platform.adoc[leveloffset=+2]
2020
include::modules/adding-a-tested-and-verified-runtime-for-the-single-model-serving-platform.adoc[leveloffset=+2]
2121
include::modules/deploying-models-on-the-single-model-serving-platform.adoc[leveloffset=+2]
22+
include::modules/stopping-starting-model.adoc[leveloffset=+2]
2223
include::modules/deploying-models-using-multiple-gpu-nodes.adoc[leveloffset=+2]
2324
include::modules/setting-timeout-for-kserve.adoc[leveloffset=+2]
2425
include::modules/customizing-parameters-serving-runtime.adoc[leveloffset=+2]

modules/customizing-parameters-serving-runtime.adoc

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,17 @@ NOTE: Customizing the parameters of a runtime only affects the selected model de
1616
. From the {productname-short} dashboard, click *Models* -> *Model deployments*.
1717
+
1818
The *Model deployments* page opens.
19-
. Click the action menu (⋮) next to the name of the model you want to customize and select *Edit*.
19+
. Click *Stop* next to the name of the model you want to customize.
20+
. Click the action menu (⋮) and select *Edit*.
2021
+
2122
The *Configuration parameters* section shows predefined serving runtime parameters, if any are available.
2223
. Customize the runtime parameters in the *Configuration parameters* section:
2324
.. Modify the values in *Additional serving runtime arguments* to define how the deployed model behaves.
2425
.. Modify the values in *Additional environment variables* to define variables in the model's environment.
2526
+
2627
NOTE: Do not modify the port or model serving runtime arguments, because they require specific values to be set. Overwriting these parameters can cause the deployment to fail.
27-
. After you are done customizing the runtime parameters, click *Redeploy* to save and deploy the model with your changes.
28+
. After you are done customizing the runtime parameters, click *Redeploy* to save.
29+
. Click *Start* to deploy the model with your changes.
2830

2931
.Verification
3032
* Confirm that the deployed model is shown on the *Models* tab for the project, and on the *Model deployments* page of the dashboard with a checkmark in the *Status* column.

modules/stopping-starting-model.adoc

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
:_module-type: PROCEDURE
2+
3+
[id="stopping-starting-model_{context}"]
4+
= Stopping and starting a deployed model
5+
6+
[role='_abstract']
7+
You can stop a deployed model to perform edits without consuming cluster resources or triggering a redeployment. When you stop a model, all associated objects are terminated, and the model is unavailable for inference requests. When you start the model again, any pending configuration changes are applied.
8+
9+
.Prerequisites
10+
* You have logged in to {productname-long}.
11+
* You have deployed a model in a data science project.
12+
13+
.Procedure
14+
15+
. From the {productname-short} dashboard, click *Models* > *Model deployments*.
16+
. Locate the model that you want to stop or start.
17+
. In the *Status* column for the model, click *Stop* or *Start*.
18+
+
19+
When you stop the model, the status changes to *Stopping* as the pods are terminated, and then changes to *Stopped*. When you start the model, the status changes to *Starting* as new pods are created, and then changes to *Running*.

0 commit comments

Comments
 (0)