Skip to content

Commit aeb82dc

Browse files
author
cerlane
committed
improve readability and grammer of some sentences
1 parent c173c49 commit aeb82dc

File tree

3 files changed

+8
-62
lines changed

3 files changed

+8
-62
lines changed

.github/actions/spelling/allow.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ Piz
9393
Plesset
9494
Podladchikov
9595
Pulay
96-
Pypi
96+
PyPi
9797
RCCL
9898
RDMA
9999
ROCm

docs/software/gssr/containers.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,9 @@ RUN pip install gssr
3030
# Install your application and dependencies as required
3131
...
3232
```
33-
As you can see from the above example, gssr can easily be installed with a `RUN pip install gssr` command. Your application and dependencies should be written where the `...` is.
33+
As you can see from the above example, gssr can easily be installed with a `RUN pip install gssr` command.
3434

35-
Once your `ContainerFile` is ready, you can build it on any Alps platform with the following commands to create a container with label `mycontainer`.
35+
Once your `ContainerFile` is ready, you can build it on any Alps platforms with the following commands to create a container with label `mycontainer`.
3636

3737
```bash
3838
srun -A {groupID} --pty bash
@@ -47,7 +47,7 @@ Now you should have a sqsh file of your container. Please note that you should r
4747

4848
## Create CSCS configuration for Container
4949

50-
Now you only need 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.
50+
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
```
@@ -95,11 +95,11 @@ Now you are ready to submit your sbatch file to slurm with `sbatch` command.
9595

9696
## Analyze the output
9797

98-
Once your job successfully concluded. You should find a folder named `profile_out_{slurm_jobid}` where `gssr` json output is in. To generate output for analysis.
98+
Once your job successfully concluded, you should find a folder named `profile_out_{slurm_jobid}` where `gssr` json outputs are in.
9999

100-
To do so, you can do so interactively within your container where `gssr` is installed.
100+
To analyze the outputs, you can do so interactively within any containers where `gssr` is installed, e.g., `mycontainer` we have in this guide.
101101

102-
To get an interactive session of our container
102+
To get an interactive session of this container:
103103

104104
```
105105
srun -A groupname --environment=mycontainer --pty bash

docs/software/gssr/quickstart.md

Lines changed: 1 addition & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -1,55 +1 @@
1-
[](){#ref-gssr-quickstart}
2-
# gssr - Quickstart Guide
3-
4-
## Installation
5-
6-
### From Pypi
7-
8-
`gssr` can be easily installed as follows.:
9-
10-
pip install gssr
11-
12-
### From GitHub Source
13-
14-
To install directly from the source:
15-
16-
pip install git+https://github.com/eth-cscs/GPU-saturation-scorer.git
17-
18-
To install from a specific branch, e.g. the development branch, from the source:
19-
20-
pip install git+https://github.com/eth-cscs/GPU-saturation-scorer.git@dev
21-
22-
To install a specific release tag, e.g. gssr-v0.3, from the source:
23-
24-
pip install git+https://github.com/eth-cscs/[email protected]
25-
26-
## Profile
27-
28-
### Example
29-
30-
If you are submitting a batch job and the command you are executing is:
31-
32-
srun python test.py
33-
34-
The corresponding srun command should be modified as follows.:
35-
36-
srun gssr profile -wrap="python abc.py"
37-
38-
* The `gssr` option to run is `profile`
39-
* The `"--wrap"` flag will wrap the command that you would like to run
40-
* The default output directory is `profile_out_{slurm_job_id}`
41-
* A label to the output data can be set with the `-l` flag
42-
43-
## Analyze
44-
45-
### Metric Output
46-
The profiled output can be analysed as follows.:
47-
48-
gssr analyze -i ./profile_out
49-
50-
### PDF File Output with Plots
51-
52-
gssr analyze -i ./profile_out --report
53-
54-
A/Multiple PDF report(s) will be generated.
55-
1+
### From PyPi

0 commit comments

Comments
 (0)