Skip to content

Commit af91616

Browse files
committed
minor edits
1 parent 77edcf4 commit af91616

3 files changed

Lines changed: 15 additions & 14 deletions

File tree

docs/hpc/01_getting_started/01_intro.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Welcome to the Torch HPC documentation! If you do not have an HPC account, please proceed to the next section that explains how you may be able to get one.
44

55
:::note
6-
Please be aware that a requirement of the Torch cluster is that you also have an associated Slurm Account with resources allocated to it. You can learn more about this in the section on [Slurm Accounts](./03_Slurm_Accounts/01_intro_slurm_accounts.mdx)
6+
Please be aware that a requirement to submit jobs on the Torch cluster is having a `SLURM` account (which is given to you once you are part of an active allocation associated a project within the HPC project management portal) as explained in the section on [Slurm Accounts](./03_Slurm_Accounts/01_intro_slurm_accounts.mdx)
77
:::
88

99
If you are an active user, you can proceed to one of the categories on the left.

docs/hpc/01_getting_started/03_Slurm_Accounts/02_hpc_project_management_portal.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,5 +39,6 @@ How do I:
3939
- [Request an allocation?](04_requesting_an_allocation.mdx)
4040
- [Approve an allocation request?](05_approving_an_allocation_request.mdx)
4141
- [View resources that are available to me?](04_requesting_an_allocation.mdx)
42+
- [Add publications and grants for your project](06_adding_publications_grants.mdx)
4243

4344
An active allocation in the HPC projects portal is needed to perform any work on Torch. The next sections describe the project and allocation request process in detail.

docs/hpc/06_tools_and_software/08_utils.mdx

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
Torch has several utility applications that can give you information related to your account and jobs on the cluster:
44

5-
## myquota
5+
## `myquota`
66

7-
Users can check their current utilization of quota using the myquota command. The myquota command provides a report of the current quota limits on mounted file systems, the user's quota utilization, as well as the percentage of quota utilization.
7+
Users can check their current utilization of quota using the `myquota` command. The `myquota` command provides a report of the current quota limits on mounted file sys tems, the user's quota utilization, as well as the percentage of quota utilization.
88

9-
In the following example the user who executes the myquota command is out of inodes in their home directory. The user inode quota limit on the `/home` file system **30.0K inodes** and the user has **33000 inodes**, thus **110%** of the inode quota limit.
9+
In the following example the user who executes the `myquota` command is out of inodes in their home directory. The user inode quota limit on the `/home` file system **30.0K inodes** and the user has **33000 inodes**, thus **110%** of the inode quota limit.
1010
```sh
1111
$ myquota
1212
Quota Information for NetID
@@ -27,9 +27,9 @@ echo -e "${RED}The following 5 folders are impacting this quota the most.${NC}"
2727
find $HOME -xdev | cut -d "/" -f 1-4 | sort | uniq -c | sort -nr | head -n 5
2828
```
2929
:::
30-
## my_slurm_accounts
30+
## `my_slurm_accounts`
3131

32-
my_slurm_accounts returns a list of slurm accounts associated with your HPC account:
32+
`my_slurm_accounts` returns a list of `SLURM` accounts associated with your HPC account:
3333
```bash
3434
[NetID@torch-login-b-1 ~]$ my_slurm_accounts
3535
Account Descr
@@ -42,7 +42,7 @@ You will need to specify the account on the command line like:
4242
srun --account=torch_pr_XXX_XXXXX --pty bash
4343
sbatch -c4 -t2:00:00 --mem=4G --account=torch_pr_XXX_XXXXX my_script.sh
4444
```
45-
or in your sbatch file you'll need to add a line like:
45+
or in your `sbatch` file you'll need to add a line like:
4646
```
4747
#SBATCH --account=torch_pr_XXX_XXXXX
4848
```
@@ -52,8 +52,8 @@ Please see [Slurm: Command reference](http://localhost:3000/docs/hpc/submitting_
5252

5353
For more information about slurm accounts please see [Slurm Accounts](../01_getting_started/03_Slurm_Accounts/01_intro_slurm_accounts.mdx).
5454

55-
## nvidia-smi
56-
nvidia-smi (NVIDIA System Management Interface) is a command-line utility, based on the NVIDIA Management Library (NVML), used to monitor and manage NVIDIA GPU devices
55+
## `nvidia-smi`
56+
`nvidia-smi` (NVIDIA System Management Interface) is a command-line utility, based on the NVIDIA Management Library (NVML), used to monitor and manage NVIDIA GPU devices
5757

5858
It will provide detailed information like:
5959
- GPU utilization
@@ -76,9 +76,9 @@ You can get very detailed information about the GPU with:
7676
```
7777
:::
7878

79-
## seff
79+
## `seff`
8080

81-
The seff script can be used to display status information about a user’s historical or running jobs.
81+
The `seff` script can be used to display status information about a user’s historical or running jobs.
8282

8383
Here's example output for a job:
8484
```bash
@@ -95,13 +95,13 @@ Memory Utilized: 50.54 MB
9595
Memory Efficiency: 4.94% of 1.00 GB
9696

9797
```
98-
As you can see above, seff gives information about CPU and memory efficiency to help you more efficiently use our cluster resources.
98+
As you can see above, `seff` gives information about CPU and memory efficiency to help you more efficiently use our cluster resources.
9999
:::tip
100100
Requesting the minimum resources needed for your job can help it spend less time in the queue.
101101
:::
102102

103103
{/* coming soon
104-
## rpsquota
104+
## `rpsquota`
105105
106-
rpsquota returns detailed information about how much of your Research Project Space quota you're using (if you have RPS space). To use it just type `rpsquota` in the base RPS directory or give the base RPS path as an input argument like `rpsquota /path/to/rps/space`.
106+
`rpsquota` returns detailed information about how much of your Research Project Space quota you're using (if you have RPS space). To use it just type `rpsquota` in the base RPS directory or give the base RPS path as an input argument like `rpsquota /path/to/rps/space`.
107107
*/}

0 commit comments

Comments
 (0)