Skip to content

Commit 2135175

Browse files
[Docs] Many docs improvements (#2171)
Co-authored-by: jvstme <36324149+jvstme@users.noreply.github.com>
1 parent 87fe51f commit 2135175

47 files changed

Lines changed: 2781 additions & 3232 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ for AI workloads both in the cloud and on-prem, speeding up the development, tra
4141
To use `dstack` with your own cloud accounts, create the `~/.dstack/server/config.yml` file and
4242
[configure backends](https://dstack.ai/docs/reference/server/config.yml). Alternatively, you can configure backends via the control plane UI after you start the server.
4343

44-
You can skip backends configuration if you intend to run containers only on your on-prem servers. Use [SSH fleets](https://dstack.ai/docs/concepts/fleets#ssh-fleets) for that.
44+
You can skip backends configuration if you intend to run containers only on your on-prem servers. Use [SSH fleets](https://dstack.ai/docs/concepts/fleets#ssh) for that.
4545

4646
### Start the server
4747

docker/server/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Configuration is updated at ~/.dstack/config.yml
3939
## Create SSH fleets
4040

4141
If you want the `dstack` server to run containers on your on-prem servers,
42-
use [fleets](https://dstack.ai/docs/concepts/fleets#ssh-fleets).
42+
use [fleets](https://dstack.ai/docs/concepts/fleets#ssh).
4343

4444
## More information
4545

docs/assets/stylesheets/extra.css

Lines changed: 32 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,11 @@
2323
font-size: 0.75rem;
2424
}
2525
}
26+
27+
[dir=ltr] .md-typeset :is(.admonition,details) pre, [dir=ltr] .md-typeset :is(.admonition,details) :is(.admonition,details) {
28+
margin-left: 32px;
29+
}
30+
2631
@media screen and (max-width: 76.1875em) {
2732
.md-header {
2833
background-color: rgb(255, 255, 255);
@@ -160,7 +165,7 @@
160165
background-color: var(--md-default-fg-color);
161166
}
162167

163-
[dir=ltr] .md-typeset :is(.admonition,details) {
168+
[dir=ltr] .md-typeset :is(details) {
164169
border-style: solid;
165170
/*border-width: 1px;*/
166171
border-width: 0;
@@ -170,6 +175,16 @@
170175
background: -webkit-linear-gradient(45deg, rgba(0, 42, 255, 0.1), rgb(0 114 255 / 1%), rgba(0, 42, 255, 0.05));
171176
}
172177

178+
[dir=ltr] .md-typeset :is(.admonition) {
179+
border-style: solid;
180+
border-color: rgba(0, 0, 0, 0.87);
181+
border-width: 1px;
182+
border-radius: 6px;
183+
box-shadow: none;
184+
padding: .6rem .8rem;
185+
/*background: -webkit-linear-gradient(45deg, rgba(0, 42, 255, 0.1), rgb(0 114 255 / 1%), rgba(0, 42, 255, 0.05));*/
186+
}
187+
173188
.md-typeset iframe {
174189
border-radius: 6px;
175190
}
@@ -178,7 +193,7 @@
178193
margin-left: 32px;
179194
}
180195

181-
[dir=ltr] .md-typeset :is(.admonition,details):not(blockquote) > :is(.highlight,.termy,.md-typeset__scrollwrap,p,h4,h3,.tabbed-set):not(.admonition-title) {
196+
[dir=ltr] .md-typeset :is(.admonition,details):not(blockquote) > :is(.md-typeset__scrollwrap,p,h4,h3,.tabbed-set):not(.admonition-title) {
182197
padding-left: 32px;
183198
}
184199

@@ -445,7 +460,7 @@
445460
color: rgba(0,0,0,0.87);
446461
}
447462

448-
.md-typeset :not(pre) :is(h1, h2, h3, h4) > code {
463+
.md-typeset :not(pre) :is(h1, h2, h3, h4, h5, h6) > code {
449464
color: inherit;
450465
background: inherit;
451466
padding: 0;
@@ -455,7 +470,7 @@ h4.doc-heading {
455470
font-size: inherit;
456471
}
457472

458-
.md-typeset :not(pre, h1, h2, h3, h4) > code {
473+
.md-typeset :not(pre, h1, h2, h3, h4, h5, h6) > code {
459474
background-color: rgba(163, 68, 215, 0.05);
460475
/*border: 1px solid #dce0e6;*/
461476
border-radius: 2px;
@@ -467,27 +482,27 @@ h4.doc-heading {
467482
margin: 0 4px;
468483
}
469484

470-
.md-typeset :is(h1, h2, h3, h4) > code {
485+
.md-typeset :is(h1, h2, h3, h4, h5, h6) > code {
471486
background-color: inherit;
472487
color: inherit;
473488
/*padding: 0;
474489
margin: 0;*/
475490
}
476-
.md-typeset :is(h1, h2, h3, h4) > a > code {
491+
.md-typeset :is(h1, h2, h3, h4, h5, h6) > a > code {
477492
font-size: inherit;
478493
color: inherit;
479494
}
480495

481496

482-
.md-typeset :is(table) :not(pre, h1, h2, h3, h4) > code {
497+
.md-typeset :is(table) :not(pre, h1, h2, h3, h4, h5, h6) > code {
483498
font-size: .85em;
484499
}
485500

486-
.md-typeset :not(pre, h1, h2, h3, h4) > code {
501+
.md-typeset :not(pre, h1, h2, h3, h4, h5, h6) > code {
487502
font-size: 0.65rem;
488503
}
489504

490-
.md-typeset :not(pre, h1, h2, h3, h4) > a code {
505+
.md-typeset :not(pre, h1, h2, h3, h4, h5, h6) > a code {
491506
color: #ce00ff;
492507
}
493508

@@ -639,7 +654,7 @@ code .md-code__nav:hover .md-code__button {
639654
/*letter-spacing: 0;*/
640655
}
641656

642-
.md-typeset h1, .md-typeset h2, .md-typeset h3, .md-typeset h4, .md-typeset h5 {
657+
.md-typeset h1, .md-typeset h2, .md-typeset h3, .md-typeset h4, .md-typeset h5, .md-typeset h6 {
643658
font-weight: 800;
644659
letter-spacing: -1px;
645660
color: rgb(0, 0, 0);
@@ -654,6 +669,10 @@ code .md-code__nav:hover .md-code__button {
654669
font-size: 17px;
655670
}
656671

672+
.md-typeset h6 {
673+
font-size: 15px;
674+
}
675+
657676
.md-typeset h3 {
658677
font-size: 21.5px;
659678
margin-block-end: 0;
@@ -1087,7 +1106,7 @@ html .md-footer-meta.md-typeset a:is(:focus,:hover) {
10871106
background: none;
10881107
z-index: 1;
10891108
padding: 5px;
1090-
border-radius: 12px;
1109+
border-radius: 6px;
10911110
border: 1px solid black;
10921111
bottom: -0.7px;
10931112
top: -0.7px;
@@ -1124,7 +1143,7 @@ html .md-footer-meta.md-typeset a:is(:focus,:hover) {
11241143
height: 100%;
11251144
background: -webkit-linear-gradient(45deg, rgba(0, 42, 255, 0.025), rgb(0 114 255 / 0.25%), rgba(0, 42, 255, 0.0125));
11261145
z-index: 1;
1127-
border-radius: 12px;
1146+
border-radius: 6px;
11281147
border: 0.5px solid rgba(0,0,0, 0.5);
11291148
overflow: unset;
11301149
}
@@ -1198,7 +1217,7 @@ html .md-footer-meta.md-typeset a:is(:focus,:hover) {
11981217
margin: 1em .8rem;
11991218
}
12001219

1201-
.md-typeset .tabbed-block :is(h1, h2, h3, h4, h5) {
1220+
.md-typeset .tabbed-block :is(h1, h2, h3, h4, h5, h6) {
12021221
margin-left: .8rem;
12031222
}
12041223

docs/blog/archive/say-goodbye-to-managed-notebooks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,4 +98,4 @@ You can securely access the cloud development environment with the desktop IDE o
9898
![](../../assets/images/dstack-vscode-jupyter.png){ width=800 }
9999

100100
!!! info "Learn more"
101-
Check out our [guide](../../docs/dev-environments.md) for running dev environments in your cloud.
101+
Check out our [guide](../../docs/concepts/dev-environments.md) for running dev environments in your cloud.

docs/blog/posts/amd-mi300x-inference-benchmark.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ categories:
1111

1212
# Benchmarking Llama 3.1 405B on 8x AMD MI300X GPUs
1313

14-
At `dstack`, we've been adding support for AMD GPUs with [SSH fleets](../../docs/concepts/fleets.md#ssh-fleets),
14+
At `dstack`, we've been adding support for AMD GPUs with [SSH fleets](../../docs/concepts/fleets.md#ssh),
1515
so we saw this as a great chance to test our integration by benchmarking AMD GPUs. Our friends at
1616
[Hot Aisle :material-arrow-top-right-thin:{ .external }](https://hotaisle.xyz/){:target="_blank"}, who build top-tier
1717
bare metal compute for AMD GPUs, kindly provided the hardware for the benchmark.
@@ -35,7 +35,7 @@ Here is the spec of the bare metal machine we got:
3535
??? info "Set up an SSH fleet"
3636

3737
Hot Aisle provided us with SSH access to the machine. To make it accessible via `dstack`,
38-
we created an [SSH fleet](../../docs/concepts/fleets.md#ssh-fleets) using the following configuration:
38+
we created an [SSH fleet](../../docs/concepts/fleets.md#ssh) using the following configuration:
3939

4040
<div editor-title="hotaisle.dstack.yml">
4141

@@ -216,7 +216,7 @@ If you have questions, feedback, or want to help improve the benchmark, please r
216216
is the primary sponsor of this benchmark, and we are sincerely grateful for their hardware and support.
217217

218218
If you'd like to use top-tier bare metal compute with AMD GPUs, we recommend going
219-
with Hot Aisle. Once you gain access to a cluster, it can be easily accessed via `dstack`'s [SSH fleet](../../docs/concepts/fleets.md#ssh-fleets) easily.
219+
with Hot Aisle. Once you gain access to a cluster, it can be easily accessed via `dstack`'s [SSH fleet](../../docs/concepts/fleets.md#ssh) easily.
220220

221221
### RunPod
222222
If you’d like to use on-demand compute with AMD GPUs at affordable prices, you can configure `dstack` to

docs/blog/posts/amd-on-runpod.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ you can now specify an AMD GPU under `resources`. Below are a few examples.
3939
## Configuration
4040

4141
=== "Service"
42-
Here's an example of a [service](../../docs/services.md) that deploys
42+
Here's an example of a [service](../../docs/concepts/services.md) that deploys
4343
Llama 3.1 70B in FP16 using [TGI :material-arrow-top-right-thin:{ .external }](https://huggingface.co/docs/text-generation-inference/en/installation_amd){:target="_blank"}.
4444

4545
<div editor-title="examples/deployment/tgi/amd/service.dstack.yml">
@@ -71,7 +71,7 @@ you can now specify an AMD GPU under `resources`. Below are a few examples.
7171
</div>
7272

7373
=== "Dev environment"
74-
Here's an example of a [dev environment](../../docs/dev-environments.md) using
74+
Here's an example of a [dev environment](../../docs/concepts/dev-environments.md) using
7575
[TGI :material-arrow-top-right-thin:{ .external }](https://huggingface.co/docs/text-generation-inference/en/installation_amd){:target="_blank"}'s
7676
Docker image:
7777

docs/blog/posts/dstack-sky.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,8 +73,8 @@ Continue? [y/n]:
7373
You can use both on-demand and spot instances without needing to manage quotas, as they are automatically handled
7474
for you.
7575

76-
With `dstack Sky` you can use all of `dstack`'s features, incl. [dev environments](../../docs/dev-environments.md),
77-
[tasks](../../docs/tasks.md), [services](../../docs/services.md), and
76+
With `dstack Sky` you can use all of `dstack`'s features, incl. [dev environments](../../docs/concepts/dev-environments.md),
77+
[tasks](../../docs/concepts/tasks.md), [services](../../docs/concepts/services.md), and
7878
[fleets](../../docs/concepts/fleets.md).
7979

8080
To publish services, the open-source version requires setting up a gateway with your own domain.

docs/blog/posts/tpu-on-gcp.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -211,8 +211,8 @@ Note, `v5litepod` is optimized for fine-tuning transformer-based models. Each co
211211
1. Browse [Optimum TPU :material-arrow-top-right-thin:{ .external }](https://github.com/huggingface/optimum-tpu){:target="_blank"},
212212
[Optimum TPU TGI :material-arrow-top-right-thin:{ .external }](https://github.com/huggingface/optimum-tpu/tree/main/text-generation-inference){:target="_blank"} and
213213
[vLLM :material-arrow-top-right-thin:{ .external }](https://docs.vllm.ai/en/latest/getting_started/tpu-installation.html){:target="_blank"}.
214-
2. Check [dev environments](../../docs/dev-environments.md), [tasks](https://dstack.ai/docs/tasks),
215-
[services](../../docs/services.md), and [fleets](../../docs/concepts/fleets.md).
214+
2. Check [dev environments](../../docs/concepts/dev-environments.md), [tasks](https://dstack.ai/docs/tasks),
215+
[services](../../docs/concepts/services.md), and [fleets](../../docs/concepts/fleets.md).
216216

217217
!!! info "Multi-host TPUs"
218218
If you’d like to use `dstack` with more than eight TPU cores, upvote the corresponding

docs/blog/posts/volumes-on-runpod.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ deploying a model on RunPod.
1818

1919
<!-- more -->
2020

21-
Suppose you want to deploy Llama 3.1 on RunPod as a [service](../../docs/services.md):
21+
Suppose you want to deploy Llama 3.1 on RunPod as a [service](../../docs/concepts/services.md):
2222

2323
<div editor-title="examples/llms/llama31/tgi/service.dstack.yml">
2424

@@ -115,7 +115,7 @@ env:
115115
commands:
116116
- text-generation-launcher
117117
port: 80
118-
# Register the mdoel
118+
# Register the model
119119
model: meta-llama/Meta-Llama-3.1-8B-Instruct
120120
121121
# Uncomment to leverage spot instances
@@ -131,9 +131,9 @@ In this case, `dstack` attaches the specified volume to each new replica. This e
131131
once, reducing cold start time in proportion to the model size.
132132

133133
A notable feature of RunPod is that volumes can be attached to multiple containers simultaneously. This capability is
134-
particularly useful for autoscalable services or distributed tasks.
134+
particularly useful for auto-scalable services or distributed tasks.
135135

136136
Using [volumes](../../docs/concepts/volumes.md) not only optimizes inference cold start times but also enhances the
137137
efficiency of data and model checkpoint loading during training and fine-tuning.
138-
Whether you're running [tasks](../../docs/tasks.md) or [dev environments](../../docs/dev-environments.md), leveraging
138+
Whether you're running [tasks](../../docs/concepts/tasks.md) or [dev environments](../../docs/concepts/dev-environments.md), leveraging
139139
volumes can significantly streamline your workflow and improve overall performance.

0 commit comments

Comments
 (0)