Skip to content
This repository was archived by the owner on Jul 24, 2025. It is now read-only.

Commit 8391084

Browse files
committed
Update API Documentation Comments for DecoupleScaling.
Signed-off-by: Jun Duan <[email protected]>
1 parent 403e983 commit 8391084

File tree

4 files changed

+13
-13
lines changed

4 files changed

+13
-13
lines changed

api/v1alpha1/modelservice_types.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,10 @@ type ModelServiceSpec struct {
4141
//
4242
// +required
4343
ModelArtifacts ModelArtifacts `json:"modelArtifacts"`
44-
// DecoupleScaling determines who owns the replica fields is the deployment objects
45-
// Set this to true if the intent is to autoscale with HPA, other autoscalers
44+
// DecoupleScaling determines who owns the replica fields of the deployment objects.
45+
// Set this to true if the intent is to autoscale with HPA or other autoscalers.
4646
// Setting this to false will force the controller to manage deployment replicas based on
47-
// replica fields in this model service
47+
// replica fields in this model service.
4848
//
4949
// +optional
5050
DecoupleScaling bool `json:"decoupleScaling,omitempty"`

config/crd/bases/llm-d.ai_modelservices.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -759,10 +759,10 @@ spec:
759759
type: object
760760
decoupleScaling:
761761
description: |-
762-
DecoupleScaling determines who owns the replica fields is the deployment objects
763-
Set this to true if the intent is to autoscale with HPA, other autoscalers
762+
DecoupleScaling determines who owns the replica fields of the deployment objects.
763+
Set this to true if the intent is to autoscale with HPA or other autoscalers.
764764
Setting this to false will force the controller to manage deployment replicas based on
765-
replica fields in this model service
765+
replica fields in this model service.
766766
type: boolean
767767
endpointPicker:
768768
description: EndpointPicker is the endpoint picker (epp) portion of

docs/api_reference/out.asciidoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -242,10 +242,10 @@ ModelServiceSpec defines the desired state of ModelService
242242
| *`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 + | |
243243
| *`modelArtifacts`* __xref:{anchor_prefix}-github-com-llm-d-llm-d-model-service-api-v1alpha1-modelartifacts[$$ModelArtifacts$$]__ | modelArtifacts provides information needed to download artifacts +
244244
needed to serve a model + | |
245-
| *`decoupleScaling`* __boolean__ | DecoupleScaling determines who owns the replica fields is the deployment objects +
246-
Set this to true if the intent is to autoscale with HPA, other autoscalers +
245+
| *`decoupleScaling`* __boolean__ | DecoupleScaling determines who owns the replica fields of the deployment objects. +
246+
Set this to true if the intent is to autoscale with HPA or other autoscalers. +
247247
Setting this to false will force the controller to manage deployment replicas based on +
248-
replica fields in this model service + | |
248+
replica fields in this model service. + | |
249249
| *`decode`* __xref:{anchor_prefix}-github-com-llm-d-llm-d-model-service-api-v1alpha1-pdspec[$$PDSpec$$]__ | Decode is the decode portion of the spec + | |
250250
| *`prefill`* __xref:{anchor_prefix}-github-com-llm-d-llm-d-model-service-api-v1alpha1-pdspec[$$PDSpec$$]__ | Prefill is the prefill portion of the spec + | |
251251
| *`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 + | |

docs/api_reference/out.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1084,10 +1084,10 @@ <h4 id="k8s-api-github-com-llm-d-llm-d-model-service-api-v1alpha1-modelservicesp
10841084
<p><strong><code>decoupleScaling</code></strong> <em>boolean</em></p>
10851085
</div></div></td>
10861086
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
1087-
<p>DecoupleScaling determines who owns the replica fields is the deployment objects<br>
1088-
Set this to true if the intent is to autoscale with HPA, other autoscalers<br>
1087+
<p>DecoupleScaling determines who owns the replica fields of the deployment objects.<br>
1088+
Set this to true if the intent is to autoscale with HPA or other autoscalers.<br>
10891089
Setting this to false will force the controller to manage deployment replicas based on<br>
1090-
replica fields in this model service<br></p>
1090+
replica fields in this model service.<br></p>
10911091
</div></div></td>
10921092
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
10931093
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
@@ -1753,7 +1753,7 @@ <h4 id="k8s-api-github-com-llm-d-llm-d-model-service-api-v1alpha1-routing">Routi
17531753
</div>
17541754
<div id="footer">
17551755
<div id="footer-text">
1756-
Last updated 2025-05-30 12:54:31 -0700
1756+
Last updated 2025-07-15 22:40:59 -0400
17571757
</div>
17581758
</div>
17591759
</body>

0 commit comments

Comments
 (0)