Skip to content

Commit c98e48c

Browse files
[Docs] Updated README.md; plus minor edits
1 parent f6babf0 commit c98e48c

File tree

2 files changed

+45
-35
lines changed

2 files changed

+45
-35
lines changed

README.md

Lines changed: 35 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -19,24 +19,30 @@ orchestration for ML teams across top clouds and on-prem clusters.
1919

2020
#### Accelerators
2121

22-
`dstack` supports `NVIDIA`, `AMD`, `Google TPU`, and `Intel Gaudi` accelerators out of the box.
22+
`dstack` supports `NVIDIA`, `AMD`, `Google TPU`, `Intel Gaudi`, and `Tenstorrent` accelerators out of the box.
2323

24-
## Major news ✨
24+
## Latest news ✨
2525

26-
- [2025/02] [dstack 0.18.41: GPU blocks, Proxy jump, inactivity duration, and more](https://github.com/dstackai/dstack/releases/tag/0.18.41)
27-
- [2025/01] [dstack 0.18.38: Intel Gaudi](https://github.com/dstackai/dstack/releases/tag/0.18.38)
28-
- [2025/01] [dstack 0.18.35: Vultr](https://github.com/dstackai/dstack/releases/tag/0.18.35)
29-
- [2024/12] [dstack 0.18.30: AWS Capacity Reservations and Capacity Blocks](https://github.com/dstackai/dstack/releases/tag/0.18.30)
30-
- [2024/10] [dstack 0.18.21: Instance volumes](https://github.com/dstackai/dstack/releases/tag/0.18.21)
31-
- [2024/10] [dstack 0.18.18: Hardware metrics monitoring](https://github.com/dstackai/dstack/releases/tag/0.18.18)
26+
- [2025/05] [dstack 0.19.8: Nebius clusters, GH200 on Lambda](https://github.com/dstackai/dstack/releases/tag/0.19.8)
27+
- [2025/04] [dstack 0.19.6: Tenstorrent, Plugins](https://github.com/dstackai/dstack/releases/tag/0.19.6)
28+
- [2025/04] [dstack 0.19.5: GCP A3 High clusters](https://github.com/dstackai/dstack/releases/tag/0.19.5)
29+
- [2025/04] [dstack 0.19.3: GCP A3 Mega clusters](https://github.com/dstackai/dstack/releases/tag/0.19.3)
30+
- [2025/03] [dstack 0.19.0: Prometheus](https://github.com/dstackai/dstack/releases/tag/0.19.0)
3231

33-
## Installation
32+
## How does it work?
33+
34+
<picture>
35+
<source media="(prefers-color-scheme: dark)" srcset="https://dstack.ai/static-assets/static-assets/images/dstack-architecture-diagram-v8-dark.svg"/>
36+
<img src="https://dstack.ai/static-assets/static-assets/images/dstack-architecture-diagram-v8.svg" width="750" />
37+
</picture>
38+
39+
### Installation
3440

3541
> Before using `dstack` through CLI or API, set up a `dstack` server. If you already have a running `dstack` server, you only need to [set up the CLI](#set-up-the-cli).
3642
37-
### Set up the server
43+
#### Set up the server
3844

39-
#### (Optional) Configure backends
45+
##### (Optional) Configure backends
4046

4147
To use `dstack` with cloud providers, configure backends
4248
via the `~/.dstack/server/config.yml` file.
@@ -46,21 +52,21 @@ For more details on how to configure backends, check [Backends](https://dstack.a
4652
> For using `dstack` with on-prem servers, create [SSH fleets](https://dstack.ai/docs/concepts/fleets#ssh)
4753
> once the server is up.
4854
49-
#### Start the server
55+
##### Start the server
5056

5157
You can install the server on Linux, macOS, and Windows (via WSL 2). It requires Git and
5258
OpenSSH.
5359

54-
##### pip
60+
##### uv
5561

5662
```shell
57-
$ pip install "dstack[all]" -U
63+
$ uv tool install "dstack[all]" -U
5864
```
5965

60-
##### uv
66+
##### pip
6167

6268
```shell
63-
$ uv tool install "dstack[all]" -U
69+
$ pip install "dstack[all]" -U
6470
```
6571

6672
Once it's installed, go ahead and start the server.
@@ -73,25 +79,28 @@ The admin token is "bbae0f28-d3dd-4820-bf61-8f4bb40815da"
7379
The server is running at http://127.0.0.1:3000/
7480
```
7581

76-
For more details on server configuration options, see the
82+
> For more details on server configuration options, see the
7783
[Server deployment](https://dstack.ai/docs/guides/server-deployment) guide.
7884

79-
### Set up the CLI
85+
86+
<details><summary>Set up the CLI</summary>
87+
88+
#### Set up the CLI
8089

8190
Once the server is up, you can access it via the `dstack` CLI.
8291

8392
The CLI can be installed on Linux, macOS, and Windows. It requires Git and OpenSSH.
8493

85-
##### pip
94+
##### uv
8695

8796
```shell
88-
$ pip install dstack -U
97+
$ uv tool install dstack -U
8998
```
9099

91-
##### uv
100+
##### pip
92101

93102
```shell
94-
$ uv tool install dstack -U
103+
$ pip install dstack -U
95104
```
96105

97106
To point the CLI to the `dstack` server, configure it
@@ -106,9 +115,9 @@ $ dstack config \
106115
Configuration is updated at ~/.dstack/config.yml
107116
```
108117

109-
## How does it work?
118+
</details>
110119

111-
### 1. Define configurations
120+
### Define configurations
112121

113122
`dstack` supports the following configurations:
114123

@@ -121,7 +130,7 @@ Configuration is updated at ~/.dstack/config.yml
121130

122131
Configuration can be defined as YAML files within your repo.
123132

124-
### 2. Apply configurations
133+
### Apply configurations
125134

126135
Apply the configuration either via the `dstack apply` CLI command or through a programmatic API.
127136

@@ -133,6 +142,7 @@ out-of-capacity errors, port-forwarding, and more &mdash; across clouds and on-p
133142
For additional information, see the following links:
134143

135144
* [Docs](https://dstack.ai/docs)
145+
* [Examples](https://dstack.ai/examples)
136146
* [Discord](https://discord.gg/u8SmfwPpMd)
137147

138148
## Contributing

docs/docs/installation/index.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -25,15 +25,15 @@ For more details on how to configure backends, check [Backends](../concepts/back
2525

2626
The server can run on your laptop or any environment with access to the cloud and on-prem clusters you plan to use.
2727

28-
=== "pip"
28+
=== "uv"
2929

30-
> The server can be set up via `pip` on Linux, macOS, and Windows (via WSL 2).
30+
> The server can be set up via `uv` on Linux, macOS, and Windows (via WSL 2).
3131
> It requires Git and OpenSSH.
3232

3333
<div class="termy">
3434

3535
```shell
36-
$ pip install "dstack[all]" -U
36+
$ uv tool install "dstack[all]" -U
3737
$ dstack server
3838

3939
Applying ~/.dstack/server/config.yml...
@@ -44,15 +44,15 @@ The server can run on your laptop or any environment with access to the cloud an
4444

4545
</div>
4646

47-
=== "uv"
47+
=== "pip"
4848

49-
> The server can be set up via `uv` on Linux, macOS, and Windows (via WSL 2).
49+
> The server can be set up via `pip` on Linux, macOS, and Windows (via WSL 2).
5050
> It requires Git and OpenSSH.
5151

5252
<div class="termy">
5353

5454
```shell
55-
$ uv tool install "dstack[all]" -U
55+
$ pip install "dstack[all]" -U
5656
$ dstack server
5757

5858
Applying ~/.dstack/server/config.yml...
@@ -92,22 +92,22 @@ Once the server is up, you can access it via the `dstack` CLI.
9292

9393
> The CLI can be set up via `pip` or `uv` on Linux, macOS, and Windows. It requires Git and OpenSSH.
9494
95-
=== "pip"
95+
=== "uv"
9696

9797
<div class="termy">
9898

9999
```shell
100-
$ pip install dstack -U
100+
$ uv tool install dstack -U
101101
```
102102

103103
</div>
104104

105-
=== "uv"
105+
=== "pip"
106106

107107
<div class="termy">
108108

109109
```shell
110-
$ uv tool install dstack -U
110+
$ pip install dstack -U
111111
```
112112

113113
</div>

0 commit comments

Comments
 (0)