Skip to content

Commit 3cfa83a

Browse files
[Docs] Extracted Distributed training examples into a separate section; plus minor refactoring (#2614)
1 parent d7d41f4 commit 3cfa83a

File tree

22 files changed

+106
-96
lines changed

22 files changed

+106
-96
lines changed

docs/assets/stylesheets/extra.css

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -546,7 +546,7 @@ h4.doc-heading {
546546
background-color: transparent;
547547
border-radius: 3px;
548548
border: 0.5px solid rgba(0, 0, 0, 0.87);
549-
height: 1.95rem;
549+
/* height: 1.95rem; */
550550
}
551551

552552
[data-md-color-primary=white] .md-search__form:hover {
@@ -813,13 +813,13 @@ body {
813813
z-index: 101;
814814
}
815815

816-
.md-search__form::before {
816+
/* .md-search__form::before {
817817
content: "⌘";
818818
color: white;
819819
font-weight: 600;
820820
position: absolute;
821821
padding: 7px;
822-
margin: 4.5px;
822+
margin: 3.5px;
823823
font-size: .65rem;
824824
background-color: rgba(0,0,0,.87);
825825
border-radius: 5px;
@@ -835,7 +835,7 @@ body {
835835
font-weight: 600;
836836
position: absolute;
837837
padding: 7px;
838-
margin: 4.5px;
838+
margin: 3.5px;
839839
font-size: .65rem;
840840
background-color: rgba(0,0,0,.87);
841841
border-radius: 5px;
@@ -844,7 +844,7 @@ body {
844844
/*z-index: 1;*/
845845
width: 30px;
846846
text-align: center;
847-
}
847+
} */
848848

849849
.md-nav--lifted > .md-nav__list > .md-nav__item > [for] {
850850
display: none;

docs/blog/posts/mpi.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ cluster usage—we’ve added support for it.
3131

3232
Below is an example of a task that runs AllReduce test on 2 nodes, each with 4 GPUs (8 processes in total).
3333

34-
<div editor-title="examples/misc/nccl-tests/.dstack.yml">
34+
<div editor-title="examples/distributed-training/nccl-tests/.dstack.yml">
3535

3636
```yaml
3737
type: task
@@ -101,5 +101,5 @@ as well as use MPI for other tasks.
101101
102102
!!! info "What's next?"
103103
1. Learn more about [dev environments](../../docs/concepts/dev-environments.md), [tasks](../../docs/concepts/tasks.md), [services](../../docs/concepts/services.md), and [fleets](../../docs/concepts/fleets.md)
104-
2. Check the [NCCL tests](../../examples/misc/nccl-tests/index.md) example
104+
2. Check the [NCCL tests](../../examples/distributed-training/nccl-tests/index.md) example
105105
2. Join [Discord :material-arrow-top-right-thin:{ .external }](https://discord.gg/u8SmfwPpMd){:target="_blank"}

docs/docs/guides/protips.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,8 @@ To change the default idle duration, set
3030
[`idle_duration`](../reference/dstack.yml/fleet.md#idle_duration) in the run configuration (e.g., `0s`, `1m`, or `off` for
3131
unlimited).
3232

33-
!!! info "Fleets"
34-
For greater control over fleet provisioning, configuration, and lifecycle management, it is recommended to use
35-
[fleets](../concepts/fleets.md) directly.
33+
> For greater control over fleet provisioning, configuration, and lifecycle management, it is recommended to use
34+
> [fleets](../concepts/fleets.md) directly.
3635
3736
## Volumes
3837

docs/docs/quickstart.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -207,5 +207,5 @@ Something not working? See the [troubleshooting](guides/troubleshooting.md) guid
207207

208208
!!! info "What's next?"
209209
1. Read about [backends](concepts/backends.md), [dev environments](concepts/dev-environments.md), [tasks](concepts/tasks.md), and [services](concepts/services.md)
210-
2. Join [Discord :material-arrow-top-right-thin:{ .external }](https://discord.gg/u8SmfwPpMd)
211-
3. Browse [examples](https://dstack.ai/examples)
210+
2. Browse [examples](../examples.md)
211+
3. Join [Discord :material-arrow-top-right-thin:{ .external }](https://discord.gg/u8SmfwPpMd)

docs/examples.md

Lines changed: 72 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,79 @@ hide:
1212
}
1313
</style>
1414

15+
## Fine-tuning
16+
17+
<div class="tx-landing__highlights_grid">
18+
<a href="/examples/fine-tuning/axolotl"
19+
class="feature-cell">
20+
<h3>
21+
Axolotl
22+
</h3>
23+
24+
<p>
25+
Fine-tune Llama 4 on a custom dataset using Axolotl.
26+
</p>
27+
</a>
28+
29+
<a href="/examples/fine-tuning/trl"
30+
class="feature-cell">
31+
<h3>
32+
TRL
33+
</h3>
34+
35+
<p>
36+
Fine-tune Llama 3.1 8B on a custom dataset using TRL.
37+
</p>
38+
</a>
39+
</div>
40+
41+
## Distributed training
42+
43+
<div class="tx-landing__highlights_grid">
44+
<a href="/examples/distributed-training/nccl-tests"
45+
class="feature-cell sky">
46+
<h3>
47+
NCCL tests
48+
</h3>
49+
50+
<p>
51+
Run multi-node NCCL tests with MPI
52+
</p>
53+
</a>
54+
<a href="/examples/distributed-training/rccl-tests"
55+
class="feature-cell sky">
56+
<h3>
57+
RCCL tests
58+
</h3>
59+
60+
<p>
61+
Run multi-node RCCL tests with MPI
62+
</p>
63+
</a>
64+
<a href="/examples/distributed-training/a3mega-clusters"
65+
class="feature-cell sky">
66+
<h3>
67+
A3 Mega
68+
</h3>
69+
70+
<p>
71+
Set up GCP A3 Mega clusters with optimized networking
72+
</p>
73+
</a>
74+
<a href="/examples/distributed-training/a3high-clusters"
75+
class="feature-cell sky">
76+
<h3>
77+
A3 High
78+
</h3>
79+
80+
<p>
81+
Set up GCP A3 High clusters with optimized networking
82+
</p>
83+
</a>
84+
</div>
85+
1586
## Deployment
87+
1688
<div class="tx-landing__highlights_grid">
1789
<a href="/examples/deployment/sglang"
1890
class="feature-cell">
@@ -61,32 +133,6 @@ hide:
61133
</a>
62134
</div>
63135

64-
## Fine-tuning
65-
66-
<div class="tx-landing__highlights_grid">
67-
<a href="/examples/fine-tuning/axolotl"
68-
class="feature-cell">
69-
<h3>
70-
Axolotl
71-
</h3>
72-
73-
<p>
74-
Fine-tune Llama 4 on a custom dataset using Axolotl.
75-
</p>
76-
</a>
77-
78-
<a href="/examples/fine-tuning/trl"
79-
class="feature-cell">
80-
<h3>
81-
TRL
82-
</h3>
83-
84-
<p>
85-
Fine-tune Llama 3.1 8B on a custom dataset using TRL.
86-
</p>
87-
</a>
88-
</div>
89-
90136
## Accelerators
91137

92138
<div class="tx-landing__highlights_grid">
@@ -173,44 +219,4 @@ hide:
173219
Use Docker and Docker Compose inside runs
174220
</p>
175221
</a>
176-
<a href="/examples/misc/nccl-tests"
177-
class="feature-cell sky">
178-
<h3>
179-
NCCL tests
180-
</h3>
181-
182-
<p>
183-
Run multi-node NCCL tests with MPI
184-
</p>
185-
</a>
186-
<a href="/examples/misc/rccl-tests"
187-
class="feature-cell sky">
188-
<h3>
189-
RCCL tests
190-
</h3>
191-
192-
<p>
193-
Run multi-node RCCL tests with MPI
194-
</p>
195-
</a>
196-
<a href="/examples/misc/a3mega-clusters"
197-
class="feature-cell sky">
198-
<h3>
199-
A3 Mega
200-
</h3>
201-
202-
<p>
203-
Set up GCP A3 Mega clusters with optimized networking
204-
</p>
205-
</a>
206-
<a href="/examples/misc/a3high-clusters"
207-
class="feature-cell sky">
208-
<h3>
209-
A3 High
210-
</h3>
211-
212-
<p>
213-
Set up GCP A3 High clusters with optimized networking
214-
</p>
215-
</a>
216222
</div>
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/overrides/header-2.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,8 @@
6161
{% endif %}-->
6262

6363
<div class="md-header__buttons">
64-
<a href="https://github.com/dstackai/dstack" target="_blank" class="md-button md-button--primary github">GitHub</a>
65-
<!--<a href="https://discord.gg/u8SmfwPpMd" target="_blank" class="md-button md-button-secondary discord">Discord</a>-->
64+
<a href="https://github.com/dstackai/dstack" target="_blank" class="md-button md-button-secondary github external">GitHub</a>
65+
<a href="https://discord.gg/u8SmfwPpMd" target="_blank" class="md-button md-button-secondary discord external">Discord</a>
6666
</div>
6767
</nav>
6868
{% if "navigation.tabs.sticky" in features %}

0 commit comments

Comments
 (0)