Skip to content

Commit 60bbb7e

Browse files
committed
[Docs]: Describe image pull progress format
1 parent 2b6434b commit 60bbb7e

2 files changed

Lines changed: 25 additions & 0 deletions

File tree

mkdocs/docs/guides/protips.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -499,6 +499,30 @@ The `offer` command allows you to filter and group offers with various [advanced
499499

500500
`dstack` tracks essential metrics accessible via the CLI and UI. To access advanced metrics like DCGM, configure the server to export metrics to Prometheus. See [Metrics](../concepts/metrics.md) for details.
501501

502+
## Pull progress
503+
504+
When using a VM-based backend or an SSH instance, you can see the Docker image pull progress in the CLI while the job is in the `pulling` state.
505+
506+
<div class="termy">
507+
508+
```shell
509+
$ dstack apply -y
510+
511+
Launching orange-yak-1...
512+
NAME BACKEND STATUS SUBMITTED
513+
orange-yak-1 aws (eu-west-3) pulling 1.19/3.44/4.76GB 3 mins ago
514+
```
515+
516+
</div>
517+
518+
The three slash-separated indicators represent:
519+
520+
- Image data already extracted.
521+
- Image data already downloaded.
522+
- Total target image size.
523+
524+
The exact total size is not always known initially, in which case a lower estimate is displayed with the `≥` sign. All values exclude any image layers already cached on the host prior to the pull.
525+
502526
## Service quotas
503527

504528
If you're using your own AWS, GCP, Azure, or OCI accounts, before you can use GPUs or spot instances, you have to request the

src/dstack/_internal/cli/utils/run.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -339,6 +339,7 @@ def f(x: int) -> str:
339339
def f(x: int) -> str:
340340
return f"{x / 2**20:.0f}"
341341

342+
# NOTE: The format is documented in protips.md. Keep in sync.
342343
total_sign = "≥" if not progress.is_total_bytes_final else ""
343344
return f"{f(progress.extracted_bytes)}/{f(progress.downloaded_bytes)}/{total_sign}{f(progress.total_bytes)}{unit}"
344345

0 commit comments

Comments
 (0)