Improve the server/config.yml reference documentation (#1077)

dstackai · Apr 2, 2024 · d1c3a71 · d1c3a71
1 parent fbc737c
commit d1c3a71
Show file tree

Hide file tree

Showing 21 changed files with 545 additions and 145 deletions.
diff --git a/docs/assets/stylesheets/extra.css b/docs/assets/stylesheets/extra.css
@@ -391,7 +391,7 @@ h4.doc-heading {
 }
 
 .md-typeset :is(h1, h2, h3, h4) > code {
-    /*background-color: inherit;*/
+    background-color: inherit;
     color: inherit;
     /*padding: 0;
     margin: 0;*/

diff --git a/docs/docs/installation/index.md b/docs/docs/installation/index.md
@@ -322,9 +322,9 @@ projects:
 !!! info "NOTE:"
     The `tensordock` backend supports on-demand instances only. Spot instance support coming soon.
 
-### Vast AI
+### Vast.ai
 
-Log into your [Vast AI](https://cloud.vast.ai/) account, click Account in the sidebar, and copy your
+Log into your [Vast.ai](https://cloud.vast.ai/) account, click Account in the sidebar, and copy your
 API Key.
 
 Then, go ahead and configure the backend:

diff --git a/docs/docs/reference/dstack.yml/dev-environment.md b/docs/docs/reference/dstack.yml/dev-environment.md
@@ -60,7 +60,7 @@ ide: vscode
     ide: vscode
     ```
 
-#### Required resources
+#### Resources { #_resources }
 
 If you specify memory size, you can either specify an explicit size (e.g. `24GB`) or a 
 range (e.g. `24GB..`, or `24GB..80GB`, or `..80GB`).
@@ -128,39 +128,40 @@ For instance, you can define environment variables in a `.env` file and utilize
 [//]: # ()
 [//]: # (</div>)
 
-### Properties reference
+### Root reference
 
 #SCHEMA# dstack._internal.core.models.configurations.DevEnvironmentConfiguration
     overrides:
       show_root_heading: false
       type:
         required: true
 
-### resources
+### `resources`
 
 #SCHEMA# dstack._internal.core.models.resources.ResourcesSpecSchema
     overrides:
       show_root_heading: false
       type:
         required: true
+      item_id_prefix: resources-
 
-### gpu
+### `resources.gpu` { #resources-gpu data-toc-label="resources.gpu" }
 
 #SCHEMA# dstack._internal.core.models.resources.GPUSpecSchema
     overrides:
       show_root_heading: false
       type:
         required: true
 
-### disk
+### `resources.disk` { #resources-disk data-toc-label="resources.disk" }
 
 #SCHEMA# dstack._internal.core.models.resources.DiskSpecSchema
     overrides:
       show_root_heading: false
       type:
         required: true
 
-### registry_auth
+### `registry_auth`
 
 #SCHEMA# dstack._internal.core.models.configurations.RegistryAuth
     overrides:

diff --git a/docs/docs/reference/dstack.yml/service.md b/docs/docs/reference/dstack.yml/service.md
@@ -144,7 +144,7 @@ scaling:
 
 If you specify the minimum number of replicas as `0`, the service will scale down to zero when there are no requests.
 
-#### Required resources
+#### Resources { #_resources }
 
 If you specify memory size, you can either specify an explicit size (e.g. `24GB`) or a 
 range (e.g. `24GB..`, or `24GB..80GB`, or `..80GB`).
@@ -207,55 +207,56 @@ auth: false
 
 </div>
 
-### Properties reference
+### Root reference
 
 #SCHEMA# dstack._internal.core.models.configurations.ServiceConfiguration
     overrides:
       show_root_heading: false
       type:
         required: true
 
-### model
+### `model`
 
 #SCHEMA# dstack._internal.core.models.gateways.BaseChatModel
     overrides:
       show_root_heading: false
       type:
         required: true
 
-### scaling
+### `scaling`
 
 #SCHEMA# dstack._internal.core.models.configurations.ScalingSpec
     overrides:
       show_root_heading: false
       type:
         required: true
 
-### resources
+### `resources`
 
 #SCHEMA# dstack._internal.core.models.resources.ResourcesSpecSchema
     overrides:
       show_root_heading: false
       type:
         required: true
+      item_id_prefix: resources-
 
-### gpu
+### `resouces.gpu` { #resources-gpu data-toc-label="resources.gpu" } 
 
 #SCHEMA# dstack._internal.core.models.resources.GPUSpecSchema
     overrides:
       show_root_heading: false
       type:
         required: true
 
-### disk
+### `resouces.disk` { #resources-disk data-toc-label="resources.disk" }
 
 #SCHEMA# dstack._internal.core.models.resources.DiskSpecSchema
     overrides:
       show_root_heading: false
       type:
         required: true
 
-### registry_auth
+### `registry_auth`
 
 #SCHEMA# dstack._internal.core.models.configurations.RegistryAuth
     overrides:

diff --git a/docs/docs/reference/dstack.yml/task.md b/docs/docs/reference/dstack.yml/task.md
@@ -91,7 +91,7 @@ commands:
       - python fine-tuning/qlora/train.py
     ```
 
-#### Required resources
+#### Resources { #_resources }
 
 If you specify memory size, you can either specify an explicit size (e.g. `24GB`) or a 
 range (e.g. `24GB..`, or `24GB..80GB`, or `..80GB`).
@@ -192,39 +192,40 @@ ports:
 
 </div>
 
-### Properties reference
+### Root reference
 
 #SCHEMA# dstack._internal.core.models.configurations.TaskConfiguration
     overrides:
       show_root_heading: false
       type:
         required: true
 
-### resources
+### `resources`
 
 #SCHEMA# dstack._internal.core.models.resources.ResourcesSpecSchema
     overrides:
       show_root_heading: false
       type:
         required: true
+      item_id_prefix: resources-
 
-### gpu
+### `resouces.gpu` { #resources-gpu data-toc-label="resources.gpu" }
 
 #SCHEMA# dstack._internal.core.models.resources.GPUSpecSchema
     overrides:
       show_root_heading: false
       type:
         required: true
 
-### disk
+### `resouces.disk` { #resources-disk data-toc-label="resources.disk" }
 
 #SCHEMA# dstack._internal.core.models.resources.DiskSpecSchema
     overrides:
       show_root_heading: false
       type:
         required: true
 
-### registry_auth
+### `registry_auth`
 
 #SCHEMA# dstack._internal.core.models.configurations.RegistryAuth
     overrides: