Skip to content

Commit

Permalink
Removed --mail-type=YOUR_USER_NAME (or similar) from documenation
Browse files Browse the repository at this point in the history
  • Loading branch information
yulgroper committed May 16, 2024
1 parent 32739d0 commit 4afaa34
Show file tree
Hide file tree
Showing 4 changed files with 1 addition and 7 deletions.
3 changes: 0 additions & 3 deletions doc/scheduler-directives.tex
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ \subsubsection{Directives}
\begin{verbatim}
#SBATCH --job-name=<jobname> ## or -J. Give the job a name
#SBATCH --mail-type=<type> ## Set type of email notifications
#SBATCH --mail-user=<YOUR_USERNAME>@encs.concordia.ca
#SBATCH --chdir=<directory> ## or -D, Set working directory where output files will go
#SBATCH --nodes=1 ## or -N, Node count required for the job
#SBATCH --ntasks=1 ## or -n, Number of tasks to be launched
Expand All @@ -38,7 +37,6 @@ \subsubsection{Directives}
Replace the following to adjust the job script for your project(s)
\begin{enumerate}
\item \verb+<jobname>+ with a job name for the job
\item \verb+<YOUR_USERNAME>+ with your GCS username
\item \verb+<directory>+ with the fullpath to your job's working directory, e.g., where your code,
source files and where the standard output files will be written to. By default, \verb+--chdir+
sets the current directory as the job's working directory
Expand All @@ -53,7 +51,6 @@ \subsubsection{Directives}
\begin{verbatim}
#SBATCH -J tmpdir ## Job's name set to 'tmpdir'
#SBATCH --mail-type=ALL ## Receive all email type notifications
#SBATCH [email protected]
#SBATCH -D ./ ## Use current directory as working directory
#SBATCH -N 1 ## Node count required for the job
#SBATCH -n 1 ## Number of tasks to be launched
Expand Down
4 changes: 1 addition & 3 deletions doc/scheduler-scripting.tex
Original file line number Diff line number Diff line change
Expand Up @@ -264,12 +264,10 @@ \subsection{Common Job Management Commands Summary}
\texttt{seff [job-ID]}: reports on the efficiency of a job's cpu and memory utilization.
Don't execute it on RUNNING jobs (only on completed/finished jobs), efficiency statistics may be misleading.

If you define the following directives in your batch script, you will receive seff output in your email when your job is finished.
If you define the following directive in your batch script, your ENCS email address will receive an email with seff output when your job is finished.
\small
\begin{verbatim}
#SBATCH --mail-type=ALL
#SBATCH [email protected]
## Replace USER_NAME with your encs username.
\end{verbatim}
\normalsize

Expand Down
Binary file modified doc/speed-manual.pdf
Binary file not shown.
1 change: 0 additions & 1 deletion doc/speed-manual.tex
Original file line number Diff line number Diff line change
Expand Up @@ -343,7 +343,6 @@ \section{Job Management}
Job instructions in a script start with \verb+#SBATCH+ prefix, for example:
\begin{verbatim}
#SBATCH --account=speed1 --mem=100M -t 600 -J job-name
#SBATCH --gpus=2 --mail-type=ALL -t 600 --mail-user=YOUR_USERNAME

This comment has been minimized.

Copy link
@smokhov

smokhov May 16, 2024

Member

@yulgroper -- here's removed a bit too much, more than just --mail-user

\end{verbatim}
%
We use \tool{srun} for every complex compute step inside the script.
Expand Down

0 comments on commit 4afaa34

Please sign in to comment.