Skip to content

Commit 7d84318

Browse files
committed
Fix more spelling, add more words to whitelist
1 parent 7fc845c commit 7d84318

File tree

8 files changed

+30
-15
lines changed

8 files changed

+30
-15
lines changed

.github/actions/spelling/allow.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,28 +109,33 @@ cuda
109109
customised
110110
dcomex
111111
diagonalisation
112+
dimms
112113
dockerhub
113114
dotenv
114115
eiger
115116
epyc
116117
filesystems
117118
fontawesome
119+
gdrcopy
118120
gitlab
119121
gpu
120122
groundstate
121123
ijulia
122124
inodes
123125
iopsstor
124126
jfrog
127+
jupyter
125128
lexer
126129
libfabric
127130
miniconda
128131
mpi
129132
mps
130133
multitenancy
134+
nanotron
131135
netrc
132136
nsight
133137
numa
138+
nvdashboard
134139
nvidia
135140
octicons
136141
oom

.github/actions/spelling/block-delimiters.list

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,7 @@
55
# ignore code blocks
66
```
77
```
8+
9+
# ignore indented code blocks
10+
```
11+
```
Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,25 @@
1-
# Recognized as "Firec" and "REST" with the regular rules, so in patterns.txt
2-
# instead of allow.txt
1+
# Recognized as separate words (e.g. "Firec" and "REST") with the regular rules,
2+
# so in patterns.txt instead of allow.txt
33
FirecREST
44
RESTful
5+
IPyParallel
56

67
# markdown figure
7-
^!\[.*\]\(.*\)$
8+
^!\[.*\]\(.*\)$
89

910
# Most obvious URLs
1011
https?:\/\/(www\.)?[-a-zA-Z0-9@:%._\+~#=]{1,256}\.[a-zA-Z0-9()]{1,6}\b([-a-zA-Z0-9()@:%_\+.~#?&//=]*)
1112

12-
# Markdown references (definition and use)
13+
# Markdown references and URLs (definition and use)
1314
^\[\]\(\){#[a-z-]+}$
14-
\]\(#[a-z-]+\)
15+
\]\([^\s]+\)
1516
\]\[[a-z-]+\]
1617

18+
# Markdown URLs
19+
1720
# Inline code
1821
\`[^\`]+\`
22+
23+
# kebab-case and snake_case words
24+
[a-z]+-[a-z-]+
25+
[a-z]+_[a-z_]+

docs/clusters/eiger.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Eiger is an Alps cluster that provides compute nodes and file systems designed t
3737
Eiger consists of multicore [AMD Epyc Rome][ref-alps-zen2-node] compute nodes: please note that the total number of available compute nodes on the system might vary over time.
3838
See the [Slurm documentation][ref-slurm-partitions-nodecount] for information on how to check the number of nodes.
3939

40-
Additionally, there are four login nodes with hostnames `eiger-ln00[1-4]`.
40+
Additionally, there are four login nodes with host names `eiger-ln00[1-4]`.
4141

4242
### Storage and file systems
4343

docs/guides/storage.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -124,12 +124,12 @@ Its performance is roughly the same on [Capstor][ref-alps-capstor] and [Iopsstor
124124
This data is globally synchronized, which means Lustre is not well suited to handling many small files, see the discussion on [how to handle many small files][ref-guides-storage-small-files].
125125

126126
The data itself is subdivided in blocks of size `<blocksize>` and is stored by Object Storage Servers (OSS) in one or more Object Storage Targets (OST).
127-
The blocksize and number of OSTs to use is defined by the striping settings, which are applied to a path, with new files and directories ihneriting them from their parent directory.
127+
The block size and number of OSTs to use is defined by the striping settings, which are applied to a path, with new files and directories ihneriting them from their parent directory.
128128
The `lfs getstripe <path>` command can be used to get information on the stripe settings of a path.
129129
For directories and empty files `lfs setstripe --stripe-count <count> --stripe-size <size> <directory/file>` can be used to set the layout.
130130
The simplest way to have the correct layout is to copy to a directory with the correct layout
131131

132-
!!! tip "A blocksize of 4MB gives good throughput, without being overly big..."
132+
!!! tip "A block size of 4MB gives good throughput, without being overly big..."
133133
... so it is a good choice when reading a file sequentially or in large chunks, but if one reads shorter chunks in random order it might be better to reduce the size, the performance will be smaller, but the performance of your application might actually increase.
134134
See the [Lustre documentation](https://doc.lustre.org/lustre_manual.xhtml#managingstripingfreespace) for more information.
135135

@@ -149,7 +149,7 @@ With it it is possible to create a Progressive file layout switching `--stripe-c
149149
### Iopsstor vs Capstor
150150

151151
[Iopsstor][ref-alps-iopsstor] uses SSD as OST, thus random access is quick, and the performance of the single OST is high.
152-
[Capstor][ref-alps-capstor] on another hand uses harddisks, it has a larger capacity, and it also have many more OSS, thus the total bandwidth is larger.
152+
[Capstor][ref-alps-capstor] on another hand uses hard disks, it has a larger capacity, and it also have many more OSS, thus the total bandwidth is larger.
153153
See for example the [ML filesystem guide][ref-mlp-storage-suitability].
154154

155155
[](){#ref-guides-storage-small-files}

docs/services/cicd.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -994,7 +994,7 @@ The default is `none`, and you must explicitly set it to `fetch` or `clone` to
994994
##### `CSCS_CUDA_MPS`
995995
Optional variable, default is `NO`
996996

997-
Enable running with nvidia-mps-server, which allows multiple ranks sharing the same GPU.
997+
Enable running with `nvidia-mps-server`, which allows multiple ranks sharing the same GPU.
998998

999999
##### `USE_MPI`
10001000
Optional variable, default is `AUTO`
@@ -1202,7 +1202,7 @@ Loads the view of a uenv.
12021202
##### `CSCS_CUDA_MPS`
12031203
Optional variable, default is `NO`
12041204

1205-
Enable running with nvidia-mps-server, which allows multiple ranks sharing the same GPU.
1205+
Enable running with `nvidia-mps-server`, which allows multiple ranks sharing the same GPU.
12061206

12071207
#### Example jobs
12081208
```yaml
@@ -1405,8 +1405,7 @@ A couple of projects which use this CI setup.
14051405
Please have a look there for more advanced usage:
14061406

14071407
* [dcomex-framework](https://github.com/DComEX/dcomex-framework): entry point is `ci/prototype.yml`
1408-
* [mars](https://bitbucket.org/zulianp/mars/src/development/): two pipelines, with entry points `ci/gitlab/cscs/gpu/gitlab-
1409-
daint.yml` and `ci/gitlab/cscs/mc/gitlab-daint.yml`
1408+
* [mars](https://bitbucket.org/zulianp/mars/src/development/): two pipelines, with entry points `ci/gitlab/cscs/gpu/gitlab-daint.yml` and `ci/gitlab/cscs/mc/gitlab-daint.yml`
14101409
* [sparse_accumulation](https://github.com/lab-cosmo/sparse_accumulation): entry point is `ci/pipeline.yml`
14111410
* [gt4py](https://github.com/GridTools/gt4py): entry point is `ci/cscs-ci.yml`
14121411
* [SIRIUS](https://github.com/electronic-structure/SIRIUS): entry point is `ci/cscs-daint.yml`

docs/software/ml/pytorch.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -383,7 +383,7 @@ srun bash -c "
383383
6. Disable GPU support in MPICH, as it [can lead to deadlocks](https://docs.nvidia.com/deeplearning/nccl/user-guide/docs/mpi.html#inter-gpu-communication-with-cuda-aware-mpi) when using together with nccl.
384384
7. Avoid writing JITed binaries to the (distributed) file system, which could lead to performance issues.
385385
8. These variables should always be set for correctness and optimal performance when using NCCL, see [the detailed explanation][ref-communication-nccl].
386-
9. `RANK` and `LOCAL_RANK` are set per-process by the Slurmjob launcher.
386+
9. `RANK` and `LOCAL_RANK` are set per-process by the Slurm job launcher.
387387
10. Activate the virtual environment created on top of the uenv (if any).
388388
Please follow the guidelines for [python virtual environments with uenv][ref-guides-storage-venv] to enhance scalability and reduce load times.
389389

docs/storage/filesystems.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ Please ensure that you move important data to a file system with backups, for ex
124124
## Store
125125

126126
Store is a large, medium-performance, storage on the [Capstor][ref-alps-capstor] Lustre file system for sharing data within a project, and for medium term data storage.
127-
See the [Lustre guide][ref-guides-storage-lustre] for some hints on how to get the best preformance out of the filesystem.
127+
See the [Lustre guide][ref-guides-storage-lustre] for some hints on how to get the best performance out of the filesystem.
128128

129129
Space on Store is allocated per-project, with a path created for each project.
130130
To accomodate the different customers and projects on Alps, the project paths are organised as follows:

0 commit comments

Comments
 (0)