From 839108473da677c07d37d06f4a549f2969526fb7 Mon Sep 17 00:00:00 2001 From: Jun Duan Date: Tue, 15 Jul 2025 22:44:27 -0400 Subject: [PATCH] Update API Documentation Comments for DecoupleScaling. Signed-off-by: Jun Duan --- api/v1alpha1/modelservice_types.go | 6 +++--- config/crd/bases/llm-d.ai_modelservices.yaml | 6 +++--- docs/api_reference/out.asciidoc | 6 +++--- docs/api_reference/out.html | 8 ++++---- 4 files changed, 13 insertions(+), 13 deletions(-) diff --git a/api/v1alpha1/modelservice_types.go b/api/v1alpha1/modelservice_types.go index 3cd7c73..e8b42a0 100644 --- a/api/v1alpha1/modelservice_types.go +++ b/api/v1alpha1/modelservice_types.go @@ -41,10 +41,10 @@ type ModelServiceSpec struct { // // +required ModelArtifacts ModelArtifacts `json:"modelArtifacts"` - // DecoupleScaling determines who owns the replica fields is the deployment objects - // Set this to true if the intent is to autoscale with HPA, other autoscalers + // DecoupleScaling determines who owns the replica fields of the deployment objects. + // Set this to true if the intent is to autoscale with HPA or other autoscalers. // Setting this to false will force the controller to manage deployment replicas based on - // replica fields in this model service + // replica fields in this model service. // // +optional DecoupleScaling bool `json:"decoupleScaling,omitempty"` diff --git a/config/crd/bases/llm-d.ai_modelservices.yaml b/config/crd/bases/llm-d.ai_modelservices.yaml index b97ed3b..012174a 100644 --- a/config/crd/bases/llm-d.ai_modelservices.yaml +++ b/config/crd/bases/llm-d.ai_modelservices.yaml @@ -759,10 +759,10 @@ spec: type: object decoupleScaling: description: |- - DecoupleScaling determines who owns the replica fields is the deployment objects - Set this to true if the intent is to autoscale with HPA, other autoscalers + DecoupleScaling determines who owns the replica fields of the deployment objects. + Set this to true if the intent is to autoscale with HPA or other autoscalers. Setting this to false will force the controller to manage deployment replicas based on - replica fields in this model service + replica fields in this model service. type: boolean endpointPicker: description: EndpointPicker is the endpoint picker (epp) portion of diff --git a/docs/api_reference/out.asciidoc b/docs/api_reference/out.asciidoc index 39677d6..e95ff7d 100644 --- a/docs/api_reference/out.asciidoc +++ b/docs/api_reference/out.asciidoc @@ -242,10 +242,10 @@ ModelServiceSpec defines the desired state of ModelService | *`routing`* __xref:{anchor_prefix}-github-com-llm-d-llm-d-model-service-api-v1alpha1-routing[$$Routing$$]__ | Routing provides information needed to create configuration for routing + | | | *`modelArtifacts`* __xref:{anchor_prefix}-github-com-llm-d-llm-d-model-service-api-v1alpha1-modelartifacts[$$ModelArtifacts$$]__ | modelArtifacts provides information needed to download artifacts + needed to serve a model + | | -| *`decoupleScaling`* __boolean__ | DecoupleScaling determines who owns the replica fields is the deployment objects + -Set this to true if the intent is to autoscale with HPA, other autoscalers + +| *`decoupleScaling`* __boolean__ | DecoupleScaling determines who owns the replica fields of the deployment objects. + +Set this to true if the intent is to autoscale with HPA or other autoscalers. + Setting this to false will force the controller to manage deployment replicas based on + -replica fields in this model service + | | +replica fields in this model service. + | | | *`decode`* __xref:{anchor_prefix}-github-com-llm-d-llm-d-model-service-api-v1alpha1-pdspec[$$PDSpec$$]__ | Decode is the decode portion of the spec + | | | *`prefill`* __xref:{anchor_prefix}-github-com-llm-d-llm-d-model-service-api-v1alpha1-pdspec[$$PDSpec$$]__ | Prefill is the prefill portion of the spec + | | | *`endpointPicker`* __xref:{anchor_prefix}-github-com-llm-d-llm-d-model-service-api-v1alpha1-modelservicepodspec[$$ModelServicePodSpec$$]__ | EndpointPicker is the endpoint picker (epp) portion of the spec + | | diff --git a/docs/api_reference/out.html b/docs/api_reference/out.html index a69a1eb..28c1f7a 100644 --- a/docs/api_reference/out.html +++ b/docs/api_reference/out.html @@ -1084,10 +1084,10 @@

-

DecoupleScaling determines who owns the replica fields is the deployment objects
-Set this to true if the intent is to autoscale with HPA, other autoscalers
+

DecoupleScaling determines who owns the replica fields of the deployment objects.
+Set this to true if the intent is to autoscale with HPA or other autoscalers.
Setting this to false will force the controller to manage deployment replicas based on
-replica fields in this model service

+replica fields in this model service.

@@ -1753,7 +1753,7 @@

Routi