Skip to content

Commit e37e59e

Browse files
author
cerlane
committed
update to resolve comments from Andreas and Ben
1 parent d589771 commit e37e59e

File tree

6 files changed

+13
-13
lines changed

6 files changed

+13
-13
lines changed

.github/actions/spelling/allow.txt

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -246,7 +246,6 @@ kubeconfig
246246
ceph
247247
rwx
248248
rwo
249-
sqsh
250249
subdomain
251250
tls
252251
kured

docs/software/gssr/containers.md renamed to docs/software/devtools/gssr/containers.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
[](){#ref-gssr-containers}
22
# gssr - Containers Guide
33

4-
CSCS highly recommends that all users leverage on container solutions on our Alps platforms so as to flexibly configure any required user environments of their choice within the containers. Users thus have maximum flexibility as they are not tied to any specific operating systems and/or software stacks.
5-
64
The following guide will explain how to install and use `gssr` within a container.
75

86
Most CSCS users leverage on the base containers with pre-installed CUDA from Nvidia. As such, in the following documentation, we will use a PyTorch base container as an example.
@@ -36,22 +34,24 @@ Once your `ContainerFile` is ready, you can build it on any Alps platforms with
3634

3735
```bash
3836
srun -A {groupID} --pty bash
39-
# Once you have an interactive session, use podman command to build your container
37+
# Once you have an interactive session, use podman command to build the
38+
# container
4039
# -v is to mount the fast storage on Alps into the container.
4140
podman build -v $SCRATCH:$SCRATCH -t mycontainer:0.1 .
42-
# Export the container from the podman's cache to a local sqshfs file with enroot
41+
# Export the container from the podman's cache to a local squashFS file with
42+
# enroot
4343
enroot import -x mount -o mycontainer.sqsh podman://local:mycontainer:0.1
4444
```
4545

46-
Now you should have a sqsh file of your container. Please note that you should replace `mycontainer` label to any other label of your choice. The version `0.1` can also be omitted or replaced with another version as required.
46+
Now you should have a squashFS file of your container. Please note that you should replace `mycontainer` label to any other label of your choice. The version `0.1` can also be omitted or replaced with another version as required.
4747

4848
## Create CSCS configuration for Container
4949

5050
The next step is to tell CSCS container engine solution where your container is and how you would like to run it. To do so, you will have to create a`{label}.toml` file in your `$HOME/.edf` directory.
5151

5252
### Example of a `mycontainer.toml` file
5353
```
54-
image = "/capstor/scratch/cscs/username/directoryWhereYourContainerIs/mycontainer.sqsh"
54+
image = "/capstor/scratch/cscs/username/{yourDir}/mycontainer.sqsh"
5555
mounts = ["/capstor/scratch/cscs/username:/capstor/scratch/cscs/username"]
5656
workdir = "/capstor/scratch/cscs/username"
5757
writable = true

docs/software/gssr/index.md renamed to docs/software/devtools/gssr/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,5 @@ The following documentations will be available.:
1010

1111
This tool will produce time-series and heatmaps of the profiled metric values. Here is an example of one set of plots generated by the tool from the application Megatron-LLM from EPFL.
1212

13-
![gssr timeseries](../../images/gssr/timeseries_eg.png)
14-
![gssr heatmap](../../images/gssr/heatmap_eg.png)
13+
![gssr timeseries](../../../images/gssr/timeseries_eg.png)
14+
![gssr heatmap](../../../images/gssr/heatmap_eg.png)
File renamed without changes.

docs/software/devtools/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,3 +31,4 @@ In this section we introduce the various performance analysis solutions availabl
3131
* [NVIDIA Nsight Developer Tools][ref-devtools-nsight]
3232
* [Linaro Forge MAP][ref-devtools-map]
3333
* [VI-HPS Tools][ref-devtools-vihps]
34+
* [gssr][ref-gssr-overview]

mkdocs.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -82,10 +82,6 @@ nav:
8282
- 'Building uenv': software/uenv/build.md
8383
- 'Deploying uenv': software/uenv/deploy.md
8484
- 'Release notes': software/uenv/release-notes.md
85-
- 'gssr':
86-
- software/gssr/index.md
87-
- 'Quickstart Guide': software/gssr/quickstart.md
88-
- 'Container Guide': software/gssr/containers.md
8985
- 'Debugging and Performance Analysis':
9086
- software/devtools/index.md
9187
- 'Using NVIDIA Nsight': software/devtools/nvidia-nsight.md
@@ -94,6 +90,10 @@ nav:
9490
- 'Linaro performance analysis tool': software/devtools/linaro-map.md
9591
- 'Linaro debugger': software/devtools/linaro-ddt.md
9692
- 'Using Score-P/Scalasca': software/devtools/vihps.md
93+
- 'GPU Saturation Scorer (gssr)':
94+
- software/devtools/gssr/index.md
95+
- 'Quickstart Guide': software/devtools/gssr/quickstart.md
96+
- 'Container Guide': software/devtools/gssr/containers.md
9797
- 'Container Engine':
9898
- software/container-engine/index.md
9999
- 'Using container engine': software/container-engine/run.md

0 commit comments

Comments
 (0)