Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] Many docs improvements #2171

Merged
merged 14 commits into from
Jan 8, 2025
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ for AI workloads both in the cloud and on-prem, speeding up the development, tra
To use `dstack` with your own cloud accounts, create the `~/.dstack/server/config.yml` file and
[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.

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.
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.

### Start the server

Expand Down
2 changes: 1 addition & 1 deletion docker/server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Configuration is updated at ~/.dstack/config.yml
## Create SSH fleets

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

## More information

Expand Down
23 changes: 19 additions & 4 deletions docs/assets/stylesheets/extra.css
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,11 @@
font-size: 0.75rem;
}
}

[dir=ltr] .md-typeset :is(.admonition,details) pre, [dir=ltr] .md-typeset :is(.admonition,details) :is(.admonition,details) {
margin-left: 32px;
}

@media screen and (max-width: 76.1875em) {
.md-header {
background-color: rgb(255, 255, 255);
Expand Down Expand Up @@ -160,7 +165,7 @@
background-color: var(--md-default-fg-color);
}

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

[dir=ltr] .md-typeset :is(.admonition) {
border-style: solid;
border-color: rgba(0, 0, 0, 0.87);
border-width: 1px;
border-radius: 6px;
box-shadow: none;
padding: .6rem .8rem;
/*background: -webkit-linear-gradient(45deg, rgba(0, 42, 255, 0.1), rgb(0 114 255 / 1%), rgba(0, 42, 255, 0.05));*/
}

.md-typeset iframe {
border-radius: 6px;
}
Expand All @@ -178,7 +193,7 @@
margin-left: 32px;
}

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

Expand Down Expand Up @@ -1091,7 +1106,7 @@ html .md-footer-meta.md-typeset a:is(:focus,:hover) {
background: none;
z-index: 1;
padding: 5px;
border-radius: 12px;
border-radius: 6px;
border: 1px solid black;
bottom: -0.7px;
top: -0.7px;
Expand Down Expand Up @@ -1128,7 +1143,7 @@ html .md-footer-meta.md-typeset a:is(:focus,:hover) {
height: 100%;
background: -webkit-linear-gradient(45deg, rgba(0, 42, 255, 0.025), rgb(0 114 255 / 0.25%), rgba(0, 42, 255, 0.0125));
z-index: 1;
border-radius: 12px;
border-radius: 6px;
border: 0.5px solid rgba(0,0,0, 0.5);
overflow: unset;
}
Expand Down
6 changes: 3 additions & 3 deletions docs/blog/posts/amd-mi300x-inference-benchmark.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ categories:

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

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

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

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

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

If you'd like to use top-tier bare metal compute with AMD GPUs, we recommend going
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.
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.

### RunPod
If you’d like to use on-demand compute with AMD GPUs at affordable prices, you can configure `dstack` to
Expand Down
19 changes: 12 additions & 7 deletions docs/docs/concepts/backends.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
# Backends

`dstack` can provision and manage compute across a variety of providers.
To use `dstack` with cloud providers, configure [backends](../concepts/backends.md)
peterschmidt85 marked this conversation as resolved.
Show resolved Hide resolved
via the `~/.dstack/server/config.yml` file.
The server loads this file on startup.

To use `dstack` with specific providers, configure backends in the
`~/.dstack/server/config.yml` file before starting the server.
Alternatively, you can configure them via the control plane UI once the server is up.
Alternatively, you can configure backends on the [project settings page](../guides/administration.md#backends) via UI.

Below are examples of how to configure backends for each provider.
> For using `dstack` with on-prem servers, no backend configuration is required.
> Use [SSH fleets](../concepts/fleets.md#ssh) instead.

Below are examples of how to configure backends via `~/.dstack/server/config.yml`.

## Cloud providers

Expand Down Expand Up @@ -747,7 +750,7 @@ projects:
### SSH fleets

> For using `dstack` with on-prem servers, no backend configuration is required.
> See [SSH fleets](fleets.md#ssh-fleets) for more details.
> See [SSH fleets](fleets.md#ssh) for more details.

### Kubernetes

Expand Down Expand Up @@ -844,4 +847,6 @@ In case of a self-managed cluster, also specify the IP address of any node in th
If you're using [dstack Sky :material-arrow-top-right-thin:{ .external }](https://sky.dstack.ai){:target="_blank"},
backends are pre-configured to use compute from `dstack`'s marketplace.

You can reconfigure backends via the UI, to use your own cloud accounts instead.
You can reconfigure backends via the UI, to use your own cloud accounts instead.

[//]: # (TODO: Add link to the server config reference page)
Loading
Loading