Skip to content

Commit

Permalink
[Docs] Many docs improvements #2170
Browse files Browse the repository at this point in the history
  • Loading branch information
peterschmidt85 committed Dec 31, 2024
1 parent 416e27f commit 49519ad
Show file tree
Hide file tree
Showing 35 changed files with 1,614 additions and 1,536 deletions.
22 changes: 13 additions & 9 deletions docs/assets/stylesheets/extra.css
Original file line number Diff line number Diff line change
Expand Up @@ -445,7 +445,7 @@
color: rgba(0,0,0,0.87);
}

.md-typeset :not(pre) :is(h1, h2, h3, h4) > code {
.md-typeset :not(pre) :is(h1, h2, h3, h4, h5, h6) > code {
color: inherit;
background: inherit;
padding: 0;
Expand All @@ -455,7 +455,7 @@ h4.doc-heading {
font-size: inherit;
}

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

.md-typeset :is(h1, h2, h3, h4) > code {
.md-typeset :is(h1, h2, h3, h4, h5, h6) > code {
background-color: inherit;
color: inherit;
/*padding: 0;
margin: 0;*/
}
.md-typeset :is(h1, h2, h3, h4) > a > code {
.md-typeset :is(h1, h2, h3, h4, h5, h6) > a > code {
font-size: inherit;
color: inherit;
}


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

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

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

Expand Down Expand Up @@ -639,7 +639,7 @@ code .md-code__nav:hover .md-code__button {
/*letter-spacing: 0;*/
}

.md-typeset h1, .md-typeset h2, .md-typeset h3, .md-typeset h4, .md-typeset h5 {
.md-typeset h1, .md-typeset h2, .md-typeset h3, .md-typeset h4, .md-typeset h5, .md-typeset h6 {
font-weight: 800;
letter-spacing: -1px;
color: rgb(0, 0, 0);
Expand All @@ -654,6 +654,10 @@ code .md-code__nav:hover .md-code__button {
font-size: 17px;
}

.md-typeset h6 {
font-size: 15px;
}

.md-typeset h3 {
font-size: 21.5px;
margin-block-end: 0;
Expand Down Expand Up @@ -1198,7 +1202,7 @@ html .md-footer-meta.md-typeset a:is(:focus,:hover) {
margin: 1em .8rem;
}

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

Expand Down
2 changes: 1 addition & 1 deletion docs/blog/archive/say-goodbye-to-managed-notebooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,4 +98,4 @@ You can securely access the cloud development environment with the desktop IDE o
![](../../assets/images/dstack-vscode-jupyter.png){ width=800 }

!!! info "Learn more"
Check out our [guide](../../docs/dev-environments.md) for running dev environments in your cloud.
Check out our [guide](../../docs/concepts/dev-environments.md) for running dev environments in your cloud.
4 changes: 2 additions & 2 deletions docs/blog/posts/amd-on-runpod.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ you can now specify an AMD GPU under `resources`. Below are a few examples.
## Configuration

=== "Service"
Here's an example of a [service](../../docs/services.md) that deploys
Here's an example of a [service](../../docs/concepts/services.md) that deploys
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"}.

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

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

Expand Down
4 changes: 2 additions & 2 deletions docs/blog/posts/dstack-sky.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,8 +73,8 @@ Continue? [y/n]:
You can use both on-demand and spot instances without needing to manage quotas, as they are automatically handled
for you.

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

To publish services, the open-source version requires setting up a gateway with your own domain.
Expand Down
4 changes: 2 additions & 2 deletions docs/blog/posts/tpu-on-gcp.md
Original file line number Diff line number Diff line change
Expand Up @@ -211,8 +211,8 @@ Note, `v5litepod` is optimized for fine-tuning transformer-based models. Each co
1. Browse [Optimum TPU :material-arrow-top-right-thin:{ .external }](https://github.com/huggingface/optimum-tpu){:target="_blank"},
[Optimum TPU TGI :material-arrow-top-right-thin:{ .external }](https://github.com/huggingface/optimum-tpu/tree/main/text-generation-inference){:target="_blank"} and
[vLLM :material-arrow-top-right-thin:{ .external }](https://docs.vllm.ai/en/latest/getting_started/tpu-installation.html){:target="_blank"}.
2. Check [dev environments](../../docs/dev-environments.md), [tasks](https://dstack.ai/docs/tasks),
[services](../../docs/services.md), and [fleets](../../docs/concepts/fleets.md).
2. Check [dev environments](../../docs/concepts/dev-environments.md), [tasks](https://dstack.ai/docs/tasks),
[services](../../docs/concepts/services.md), and [fleets](../../docs/concepts/fleets.md).

!!! info "Multi-host TPUs"
If you’d like to use `dstack` with more than eight TPU cores, upvote the corresponding
Expand Down
8 changes: 4 additions & 4 deletions docs/blog/posts/volumes-on-runpod.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ deploying a model on RunPod.

<!-- more -->

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

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

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

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

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

0 comments on commit 49519ad

Please sign in to comment.