Submit Script ALELEON Supercomputer: Perbedaan antara revisi

Dari ALELEON by EFISON
(→‎Parameter Resources SBATCH Esensial: menambahkan bagian nodes dan ntasks)
(→‎Struktur Submit Script: menambah contoh script)
 
(47 revisi perantara oleh pengguna yang sama tidak ditampilkan)
Baris 1: Baris 1:
Salah satu seni dalam menggunakan superkomputer adalah '''user menentukan sendiri alokasi resources untuk menjalankan job''' seperti '''jumlah core CPU, RAM, GPU, walltime, file output, notifikasi email, threading CPU, dll'''. Analogikan seperti kita hendak pesan bungkus di warung makan nasi padang di mana kita menentukan sendiri berapa porsi yang mau dibungkus, jenis lauk, dan jumlahnya. 
Halaman ini menjelaskan panduan memahami, membuat, dan mengisi '''SLURM Submit Script''' (atau disingkat Submit Script) yang merupakan 'formulir' untuk menjalankan komputasi ke Compute Node menggunakan sistem manajemen SLURM. 
[[Berkas:Resourcesjob.png|nir|jmpl|700x700px|'''Memilih alokasi resources untuk menjalankan job di superkomputer ibarat kita memilih lauk dan jumlahnya untuk pesan bungkus nasi padang''']]


=='''Resources ALELEON Supercomputer'''==
=='''Struktur Submit Script'''==
Sebelum menentukan alokasi resource job, user harus mengetahui spesifikasi hardware dari ALELEON Supercomputer yang dijelaskan pada tabel dibawah ini.
Submit Script mempunyai 4 bagian utama:
{| class="wikitable"
 
|+Partisi Hardware dan Resources ALELEON Supercomputer
#Header '''#!/bin/bash''' (karena script ini ditulis dengan bahasa bash)
!Partisi
#'''Parameter SBATCH''' untuk mengalokasikan resources job seperti CPU, RAM, GPU, time, dll.
!Keterangan
#*''Pada penggunaan superkomputer, user menentukan sendiri jumlah alokasi komputasi (CPU, RAM, GPU, time limit) yang akan dipakai untuk menjalankan komputasi asalkan tidak melebihi kapasitas Compute Node ALELEON Supercomputer.''
!Jumlah Node
# Apabila membutuhkan, memuat modul software tertentu untuk menjalankan komputasi user dengan '''[https://wiki.efisonlt.com/wiki/Module_Environment#Module_Environment_di_SLURM_Submit_Script Module Environment]'''
!Jumlah Core Fisik CPU
# Alur perintah menjalankan program user.
per node
 
!Jumlah Core Thread CPU
[[Berkas:Slurmsubmitscript.png|al=|nir|jmpl|''Struktur dan contoh SLURM Submit Script'']]Berikut adalah beberapa contoh nyata Submit Script:
per node
 
!Kapasitas RAM
* Template Submit Script untuk masing-masing software komputasi tersedia di laman [[Daftar Software Komputasi dan Tutorial Penggunaan|'''Daftar Software Komputasi dan Tutorial Penggunaan''']]
per node
 
!Jumlah GPU
{| class="wikitable mw-collapsible mw-collapsed"
per node
!Contoh Submit Script menjalankan software R
|-
|-
|'''epyc''' (DEFAULT)
|<syntaxhighlight lang="bash" line="1">
|compute node '''CPU'''
#!/bin/bash
|3
 
|64
# -------------------------------------------------------------
|128
# | Template SLURM Submit Script
|250GB
# | Software        : R
|0
# | Versi          : 4.3.0
# |
# | NOTES:
# | 1. Isi bagian yang ditandai 4 garing (////).
# | 2. Template ini bersifat referensi.
# |    User dapat mengubah bagian yang sekiranya perlu diubah.
# -------------------------------------------------------------
 
# --------------------------------------------------
# Alokasi komputasi, modul software, dan file input
# --------------------------------------------------
 
# Alokasi jumlah core thread CPU
#SBATCH --ntasks=32
 
# Alokasi jumlah memori RAM (satuan GB)
#SBATCH --mem=128GB
 
# Alokasi limit waktu menjalankan job.
# Format HH:MM:SS atau D-HH:MM:SS
#SBATCH --time=2-00:00:00
 
# Definisi file untuk menampung output terminal
#SBATCH --output=result-%j.txt
 
# Definisi file untuk menampung output error log   
#SBATCH --error=error-%j.txt
 
# Nama input file R dengan format file-nya
INPUT_FILE='dataumat.R'
 
# Memuat modul software R yang akan digunakan user
module load R/4.3.0-GCC11.3-MKL
 
# -------------------------------------------------
# RUN SCRIPT
# -------------------------------------------------
 
# Perintah menjakankan R
Rscript ${INPUT_FILE}
</syntaxhighlight>
|}
{| class="wikitable mw-collapsible mw-collapsed"
!Contoh Submit Script menjalankan software LAMMPS
|-
|-
|'''gpu_ampere'''
|<syntaxhighlight lang="bash" line="1">
|compute node '''GPU'''
#!/bin/bash
|1
 
|64
# ------------------------------------------------------------------------
|128
# | Template SLURM Submit Script
|125GB
# | Software        : LAMMPS
|2
# | Versi          : 2022.06.23u4
|}
# |
Keterangan:
# | NOTES:
# | 1. Isi bagian yang ditandai 4 garing (////).
# | 2. Template ini adalah referensi - user dapat mengubah bagian yang
# |   sekiranya perlu diubah.
# ------------------------------------------------------------------------


* '''Partisi adalah pengelompokan jenis Compute Node.''' Partisi epyc khusus untuk komputasi CPU sedangkan Partisi gpu_ampere mempunyai GPU.
# --------------------------------------------------
* '''Secara default, komputasi pada ALELEON Supercomputer diarahkan ke Partisi epyc.''' Gunakan parameter SBATCH partition untuk menggunakan Partisi gpu_ampere (penjelasan di bawah).
# Alokasi komputasi, modul software, dan file input
# --------------------------------------------------


* '''Istilah node digunakan sebagai satuan jumlah server'''. Contoh, Partisi epyc mempunyai 3 node yang artinya mempunyai 3 unit server.
# Partisi compute node GPU
#SBATCH --partition=ampere


== '''Core Thread CPU pada ALELEON Supercomputer''' ==
# Alokasi jumlah GPU
EFISON menggunakan CPU [https://www.amd.com/en/products/cpu/amd-epyc-7702p '''AMD EPYC 7702P'''] pada Partisi epyc dan [https://www.amd.com/en/products/cpu/amd-ryzen-threadripper-3990x '''AMD Threadripper 3990X'''] pada Partisi gpu_ampere'''.''' EFISON mengaktifkan '''SMT (Simultaneous Multi-Threading)''' pada semua CPU AMD di ALELEON Supercomputer sehingga masing-masing CPU mempunyai '''2 core thread per 1 core fisik'''. 
#SBATCH --gpus=1


Secara default, '''penggunaan CPU pada ALELEON Supercomputer didasarkan pada core thread, termasuk [[Core Hour|penghitungan penggunaan komputasi CPU Core Hour user]]'''.
# Alokasi jumlah core thread CPU
#SBATCH --ntasks=16


=='''Parameter Resources SBATCH Esensial'''==
# Rekomendasi 2 thread OMP secara umum
Terdapat ratusan jenis parameter SBATCH pada SLURM. Admin EFISON merangkum parameter esensial yang digunakan pada ALELEON Supercomputer.
#SBATCH --cpus-per-task=2
{| class="wikitable"
|+Parameter esensial SBATCH SLURM untuk menjalankan job di partisi default yaitu epyc
!Parameter
!Penjelasan
!Alokasi
maksimal
|-
| rowspan="2" |
'''#SBATCH --nodes=''' 
|
* Alokasi jumlah node yang digunakan.


* Contoh mengalokasikan 1 node:
# Alokasi jumlah memori RAM (satuan GB)
|3
#SBATCH --mem=64GB
|-
| colspan="2" |'''#SBATCH --nodes=1'''
|-
| rowspan="2" |
'''#SBATCH --ntasks='''   
|
* Alokasi jumlah core thread CPU yang digunakan.


* Contoh mengalokasikan 32 core thread CPU:
# Alokasi limit waktu menjalankan job
|384
#SBATCH --time=10:00:00
|-
| colspan="2" |'''<nowiki>#</nowiki>SBATCH --ntasks=32'''
|-
| colspan="3" |Cara memilih alokasi nodes dan ntasks lihat bagian:  
[https://wiki.efisonlt.com/wiki/Alokasi_Resources_Job_dan_Contoh_SLURM_Script#Rekomendasi_Kombinasi_Alokasi_nodes_dan_ntasks '''Rekomendasi Kombinasi Alokasi nodes dan ntasks''']
|-
| rowspan="2" |
'''#SBATCH --mem='''
|
* Alokasi memori RAM yang akan digunakan.


* User bisa menetapkan satuan KB, MB, atau GB.
# Definisi file untuk menampung output terminal
#SBATCH --output=result-%j.txt


* Contoh mengalokasikan memori 32GB:
# Definisi file untuk menampung output error log   
|250GB
#SBATCH --error=error-%j.txt  
|-
| colspan="2" |'''<nowiki>#</nowiki>SBATCH --mem=32GB'''
|-
| rowspan="3" |
  '''#SBATCH --time'''=
|
* Waktu maksimal yang dialokasikan untuk job.


* Format waktu <walltime> yang digunakan:
# Nama input file LAMMPS dengan format file-nya
|14-00:00:00
INPUT_FILE='zobarne.lammps'  
|-
| colspan="2" |'''HH:MM:SS'''. Contoh alokasi 10 jam: '''#SBATCH --time=10:00:00'''
|-
| colspan="2" |'''D-HH:MM:SS'''. Contoh alokasi 2 hari: '''#SBATCH --time=2-00:00:00'''
|-
| rowspan="2" |
'''#SBATCH --output='''
| colspan="2" |
* Merekap output terminal program kedalam text file.
* User memberikan nama file (bebas, satu kata tanpa spasi) dan format file.
* Format file dibebaskan, misalnya format .txt atau .out
* Terdapat penamaan ''pattern'' dari SLURM yaitu '''%j yang merekap JOB ID'''.


Contoh pengisian output:
# Memuat modul software LAMMPS versi GPU
|-
module load lammps/2022.06.23u4-GCC11.3-AOCL4.0-CUDA12.1
| colspan="2" |'''<nowiki>#</nowiki>SBATCH --output=result-%j.txt'''
Ketika job berjalan dengan '''ID 2500''', maka file output bernama '''result-2500.txt'''.
|-
| rowspan="2" |
'''#SBATCH --error='''
| colspan="2" |
* Merekap output verbose program (contoh: error log ketika program gagal selesai).


* Admin EFISON menyarankan user untuk selalu menggunakan parameter ini.
# -------------------------------------------------
# RUN SCRIPT
# -------------------------------------------------


* Berguna untuk melakukan troubleshooting ketika program user gagal berjalan.
# Export threading OMP
export OMP_NUM_THREADS=$SLURM_CPUS_PER_TASK


Contoh pengisian error output:
# Perintah menjalankan LAMMPS
|-
mpirun --mca pml ucx --mca osc ucx --np $SLURM_NTASKS lmp -sf gpu -pk gpu $SLURM_GPUS -in $INPUT_FILE
| colspan="2" |'''<nowiki>#</nowiki>SBATCH --error=error-%j.txt'''
</syntaxhighlight>
|}
|}


=== '''Menggunakan Compute Node GPU''' ===
== '''Parameter SBATCH esensial'''  ==
Berikut adalah dua parameter tambahan untuk menggunakan compute node GPU ALELEON Supercomputer atau Partisi gpu_ampere:  
Parameter SBATCH berfungsi untuk mengatur alokasi komputasi (CPU, RAM, GPU, time limit) dan output program. SLURM mempunyai ratusan opsi untuk parameter SBATCH dimana pada tutorial ini kami memberikan daftar SBATCH yang esensial untuk menjalankan komputasi di ALELEON Supercomputer.
 
=== Format Penulisan SBATCH ===
SBATCH ditulis dengan format <code>'''#SBATCH --<nama-parameter>=<nilai>'''</code> sesuai contoh berikut:  <syntaxhighlight lang="bash">
# --- Contoh penulisan SBATCH yang benar
#SBATCH --ntasks=32
#SBATCH --mem=64GB
#SBATCH --time=01:00:00
#SBATCH --output=result-%j.txt
#SBATCH --error=error-%j.txt
 
# --- Contoh penulisan SBATCH yang salah
#SBATCH --ntasks = 32
#SBATCH --mem= 64GB
#SBATCH --mem = 64 GB
</syntaxhighlight>
=== #SBATCH --partition ===
Menentukan jenis partisi (Compute Node) untuk menjalankan job komputasi user. ALELEON Supercomputer mempunyai 2 partisi Compute Node:  
{| class="wikitable"
{| class="wikitable"
|+Parameter wajib SBATCH SLURM untuk menjalankan job di [[Partisi Aleleon Mk.II|compute node GPU]]
!Partisi Compute Node
!Paramater
!Menulis SBATCH
!Penjelasan
!Alokasi
maksimal
|-
|
'''#SBATCH --partition=gpu_ampere'''
| colspan="2" |Menjalankan job pada partisi compute node GPU
|-
|-
| rowspan="2" |
|'''epyc''' (Compute Node CPU)
'''#SBATCH --gres=gpu:<jumlah-GPU>'''
|Merupakan partisi default
|
* Jumlah GPU yang digunakan.


* Contoh menggunakan 1 GPU:
* user tidak perlu menulis SBATCH parameter untuk epyc
|gpu:2
|-
|-
| colspan="2" |'''$SBATCH --gres=gpu:1'''
|'''ampere''' (Compute Node GPU)
|<code>#SBATCH --partition=ampere</code>
|}
|}


=== '''Menggunakan Paralelisasi Threading Core pada OpenMP atau BLAS''' ===
=== #SBATCH --ntasks, --mem, dan --gpus ===
Berikut adalah parameter untuk mengalokasikan threading per core para program paralel yang menggunakan metode OpenMP (OMP), hybrid MPI/OMP, atau terintegrasi dengan BLAS:
ntasks, mem, dan gpus adalah parameter SBATCH utama untuk menentukan alokasi komputasi.
 
* '''ntasks''' -> alokasi jumlah '''core CPU.''' ALELEON Supercomputer mengaktifkan ''SMT (Simultaneous Multithreading)'' pada semua CPU sehingga ntasks mendefinisikan jumlah core thread CPU.
* '''mem''' -> alokasi jumlah '''memori RAM'''. Ditulis dengan satuan memori GB (Gigabyte).
* '''gpus''' -> alokasi jumlah '''GPU'''.
 
Berikut adalah panduan nilai maksimal masing-masing parameter untuk beberapa skenario penggunaan.
{| class="wikitable"
{| class="wikitable"
|+Parameter SBATCH SLURM untuk menjalankan threading CPU
! rowspan="2" |Skenario Penggunaan
!Parameter
! colspan="3" |Nilai maksimal
!Penjelasan
!Alokasi maksimal
|-
|-
| rowspan="2" |
!ntasks (CPU)
'''#SBATCH --cpus-per-task='''                    
!mem (RAM)
|
!gpus (GPU)
* Jumlah paralelisasi threading per core yang digunakan.
|-
 
|Akumulasi ''concurrent'' job fair policy usage<sup>''1''</sup>
* Contoh mengalokasikan paralelisasi 8 threading per core:
|128
|128 untuk Pure OMP.
|128GB
4 atau 8 untuk Hybrid MPI/OMP.
|2
|-
|Job non-MPI di epyc (Compute Node CPU)''<sup>2</sup>''
|128
|240GB
|0
|-
|-
| colspan="2" |'''<nowiki>#</nowiki>SBATCH --cpus-per-task=8'''
|Job MPI di epyc (Compute Node CPU)<sup>''3''</sup>  
|}
|384
User yang menjalankan program hybrid MPI/OMP atau terintegrasi dengan BLAS dapat mempelajari bagaimana [https://wiki.efisonlt.com/wiki/Software_HPC_AMD#Threading_di_AMD_Zen2_dan_Contoh_SLURM_Script '''threading bekerja di AMD EPYC ALELEON Supercomputer'''] supaya menghasilkan performa yang optimal.
|240GB
 
|0
=== Pengiriman Status Jalannya Job via E-mail ===
SLURM pada ALELEON Supercomputer dapat mengirim notifikasi email kepada user untuk mengabarkan apabila job user sudah berjalan atau selesai. SLURM ALELEON Supercomputer menggunakan alamat email '''[[/cdn-cgi/l/email-protection|[email protected]]]'''  untuk mengirim notifikasi email.
{| class="wikitable"
|+Parameter email SLURM
!Parameter
!Penjelasan
|-
|-
|
|Semua jenis job di high-mem node epyc''<sup>4</sup>''
'''#SBATCH --mail-user='''
|128
|Email user untuk menerima pesan dari SLURM
|500GB
|0
|-
|-
|
|Semua jenis job di ampere (Compute Node GPU)''<sup>5</sup>''
'''#SBATCH --mail-type=begin'''           
|32
|Mengirim pesan email bahwa job user sudah berjalan.
|120GB
|2
|-
|-
|
| colspan="4" |''Tim admin dapat membantu user untuk membedakan program MPI dan non-MPI.''
'''#SBATCH --mail-type=end'''
* ''Daftar [[Daftar Software Komputasi dan Tutorial Penggunaan|'''software komputasi ALELEON''']] memberikan indikator program MPI atau non-MPI.''
|
* ''Dapat pula menghubungi admin untuk diskusi melalui email '''support@efisonlt.com'''.''
* Mengirim pesan email bahwa job user sudah selesai.
|}
'''''Keterangan:'''''
# Limitasi '''fair policy usage''' untuk menjaga kualitas layanan ALELEON Supercomputer.
#* User dapat mengajukan permintaan membuka limitasi apabila job membutuhkan alokasi lebih.
#* Info lebih detail lihat laman [[Limitasi Fair Usage ALELEON Supercomputer|'''Limitasi Fair Usage ALELEON Supercomputer''']]
# Program non-MPI hanya dapat berjalan satu node (maks 128 core di epyc dan 32 core di ampere).
# Program MPI dapat berjalan ''multi-node (parallel computing)'' pada Partisi epyc yaitu lebih dari 128 core
#* Pada jumlah ntasks >128, SLURM otomatis menjalankan job secara multi-node.
#* Dalam kaitan ini, parameter mem adalah alokasi memori RAM per-node.
#* Info lebih detail lihat laman [[MPI ALELEON Supercomputer|'''MPI ALELEON Supercomputer''']].
#Partisi epyc mempunyai satu node dengan jumlah memori 500GB yaitu epyc001.
##Tambahkan parameter '''<code>#SBATCH --nodelist=epyc001</code>'''
#Jangan lupa untuk menggunakan compute node GPU, tambahkan parameter '''<code>#SBATCH --partition=ampere</code>'''
=== #SBATCH --time ===
Alokasi waktu maksimal untuk menjalankan job. Ditulis dengan format HH:MM:SS atau D-HH:MM:SS. ALELEON Supercomputer mengizinkan time maksimal 3 hari per job (72:00:00 atau 3-00:00:00).  


* Email ini sekaligus berisikan cuplikan 20 baris terakhir dari file output dan error SLURM.
* SLURM akan menghentikan job apabila berjalan melebihi time yang dialokasikan,
|}
* SLURM juga dapat menghitung penggunaan Core Hour maksimal job berdasarkan time dan ntasks yang dialokasikan user. SLURM akan menahan job (status PENDING) apabila ntasks * time yang dialokasikan lebih besar dari sisa Core Hour user.
 
=== #SBATCH --output ===
SBATCH output membuat file untuk merekap output terminal jalannya program. User mendefinisikan nama dan format file.
* Terdapat pola penamaan dari SLURM yaitu %j untuk merekap nomor Job ID.
* Format file dibebaskan (biasanya menggunakan .txt atau .out).
Kebanyakan template submit script pada wiki ini memberikan contoh penamaan <code>#SBATCH --output=result-%j.txt</code> dimana ketika job berjalan (contoh) dengan job-ID 670, maka nama file output menjadi '''result-670.txt'''.
 
=== #SBATCH --error ===
SBATCH error membuat file untuk merekap output verbose program (status jalannya program dan error log ketika program gagal berjalan). File SBATCH error bermanfaat untuk melakukan ''troubleshooting'' ketika program gagal berjalan. Apabila membutuhkan support, admin biasanya akan meminta file output dari SBATCH error ini. Pola penamaan mengikuti SBATCH output di atas.


== '''Rekomendasi Kombinasi Alokasi nodes dan ntasks''' ==
=== '''SBATCH untuk notifikasi email SLURM''' ===
Ketika membutuhkan kekuatan komputasi atau jumlah core thread yang besar, user dapat menjalankan komputasi paralel multi-node (lebih dari satu node) pada ALELEON Supercomputer dengan memasukkan jumlah node lebih dari satu. SLURM secara otomatis akan menyebarkan alokasi core thread ntasks ke semua node. Contoh menggunakan 2 node dengan total 128 core thread:  
SLURM ALELEON Supercomputer dapat mengirim notifikasi email kepada user dengan nama "Jojo" untuk mengabarkan status berjalannya job komputasi user. Silahkan tambahan SBATCH berikut pada submit script apabila user ingin menerima notifikasi email dari SLURM: <syntaxhighlight lang="bash">
'''#SBATCH --nodes=2
#SBATCH --mail-user=<alamat-email-user>
#SBATCH --ntasks=128'''
#SBATCH --mail-type=BEGIN,END,FAIL
</syntaxhighlight>SBATCH mail-type mengatur konten email notifikasi SLURM dengan pilihan opsi yang sekiranya berguna untuk user:


=== Berapa Jumlah Minimal ntasks untuk Menggunakan Multi-Node? ===
* BEGIN -> notifikasi job sudah mulai
Tidak ada jawaban pasti atas jawaban ini karena '''setiap software komputasi mempunyai karakteristik optimasi performa yang berbeda-beda'''. Ambil contoh user akan menggunakan 96 atau 128 core thread untuk menjalankan software komputasi. Dengan 128 core thread per node pada ALELEON Supercomputer, akan terdapat 2 skenario yang umum terjadi:
* END -> notifikasi job sudah selesai beserta cuplikan 20 baris terakhir dari file SBATCH output dan error.
* FAIL -> notifikasi apabila job gagal berjalan atau berhenti tidak sewajarnya.
* TIME_LIMIT_50 -> job telah berjalan dengan durasi waktu 50% time limit.
* TIME_LIMIT_80 -> job telah berjalan dengan durasi waktu 80% time limit.


* '''Skenario 1:''' Software tersebut berjalan optimal pada 1 node karena mempunyai pemograman paralelisasi threading yang efisien.
=== SBATCH lainnya untuk job MPI ===
* '''Skenario 2:''' Software tersebut berjalan lebih lambat dibandingkan dengan jumlah core yang lebih kecil (contoh 64 core) pada 1 node dan ternyata berjalan optimal ketika dipecah ke 2 node karena mempunyai pemograman yang, misalnya, membutuhkan cache L3 per task yang besar.
Dalam menjalankan job MPI, user dapat menggunakan parameter SBATCH yang lebih kompleks seperti <code>nodes</code> (alokasi jumlah node), <code>mem-per-cpu</code> (alokasi jumlah RAM per core CPU), <code>mem-per-gpu</code> (alokasi jumlah RAM per GPU). <code>cpus-per-task</code> (alokasi jumlah core per proses MPI untuk skenario hybrid MPI / OMP job), dan lain-lainnya. Info lebih detail lihat laman [[MPI ALELEON Supercomputer|'''MPI ALELEON Supercomputer''']]


Skenario apa yang akan terjadi? User dapat mengetahuinya dengan melakukan tes benchmark sendiri ('''perlu disadari akan mengurangi kredit Core Hour user!''') atau bertanya kepada forum software tersebut. Maka dari itu EFISON merumuskan kombinasi nodes dan ntasks untuk komputasi multi-node:
== '''Memuat Software dengan module load''' ==
{| class="wikitable"
Perintah <code>module load</code> (bagian dari [[Module Environment|'''Module Environment''']] untuk memuat modul software) pada Submit Script berfungsi supaya Compute Node dapat menjalankan software yang dibutuhkan job user. <syntaxhighlight lang="bash">
|+Kombinasi jumlah nodes dan ntasks untuk komputasi multi-node:
module load <nama-modul-software>
!Jumlah nodes
</syntaxhighlight>'''''Keterangan:'''''
!Rekomendasi EFISON:
Jumlah ntasks setiap kelipatan 64
!Jumlah ntasks setiap kelipatan 128
|-
|1
|1 - 64
|1 - 128
|-
|2
|65 - 128
|129 - 256
|-
|3
|129 - 192
|256 - 384
|}


== '''Contoh SLURM Script''' ==
* Tulis <code>module load</code> sebelum menulis script alur jalannya program.
EFISON merangkum contoh SLURM script untuk penggunaan berbagai skenario komputasi pada laman '''[[Contoh SLURM Script]]'''.


=='''Contoh SLURM Script Software Spesifik'''==
* Template Submit Script pada masing-masing tutorial software komputasi di laman [[Daftar Software Komputasi dan Tutorial Penggunaan|'''Daftar Software Komputasi dan Tutorial Penggunaan''']] dapat memandu memilih modul software yang tepat.
EFISON juga merangkum contoh SLURM script untuk software komputasi saintifik pada laman '''[https://wiki.efisonlt.com/wiki/Software_di_HPC_Aleleon_Mk.II#Daftar_Software_Komputasi Software di HPC Aleleon Mk.II]'''.
* Daftar modul software yang lengkap dirangkum pada laman [[Katalog Software ALELEON Supercomputer|'''Katalog Software ALELEON Supercomputer''']].

Revisi terkini sejak 19 Oktober 2023 09.31

Halaman ini menjelaskan panduan memahami, membuat, dan mengisi SLURM Submit Script (atau disingkat Submit Script) yang merupakan 'formulir' untuk menjalankan komputasi ke Compute Node menggunakan sistem manajemen SLURM.

Struktur Submit Script

Submit Script mempunyai 4 bagian utama:

  1. Header #!/bin/bash (karena script ini ditulis dengan bahasa bash)
  2. Parameter SBATCH untuk mengalokasikan resources job seperti CPU, RAM, GPU, time, dll.
    • Pada penggunaan superkomputer, user menentukan sendiri jumlah alokasi komputasi (CPU, RAM, GPU, time limit) yang akan dipakai untuk menjalankan komputasi asalkan tidak melebihi kapasitas Compute Node ALELEON Supercomputer.
  3. Apabila membutuhkan, memuat modul software tertentu untuk menjalankan komputasi user dengan Module Environment
  4. Alur perintah menjalankan program user.
Struktur dan contoh SLURM Submit Script

Berikut adalah beberapa contoh nyata Submit Script:

Contoh Submit Script menjalankan software R 
#!/bin/bash

# -------------------------------------------------------------
# | Template SLURM Submit Script
# | Software        : R
# | Versi           : 4.3.0
# |
# | NOTES: 
# | 1. Isi bagian yang ditandai 4 garing (////).
# | 2. Template ini bersifat referensi.
# |    User dapat mengubah bagian yang sekiranya perlu diubah.
# -------------------------------------------------------------

# --------------------------------------------------
# Alokasi komputasi, modul software, dan file input
# --------------------------------------------------

# Alokasi jumlah core thread CPU
#SBATCH --ntasks=32

# Alokasi jumlah memori RAM (satuan GB)
#SBATCH --mem=128GB

# Alokasi limit waktu menjalankan job. 
# Format HH:MM:SS atau D-HH:MM:SS
#SBATCH --time=2-00:00:00

# Definisi file untuk menampung output terminal
#SBATCH --output=result-%j.txt

# Definisi file untuk menampung output error log    
#SBATCH --error=error-%j.txt 

# Nama input file R dengan format file-nya
INPUT_FILE='dataumat.R'

# Memuat modul software R yang akan digunakan user
module load R/4.3.0-GCC11.3-MKL

# -------------------------------------------------
# RUN SCRIPT
# -------------------------------------------------

# Perintah menjakankan R
Rscript ${INPUT_FILE}
Contoh Submit Script menjalankan software LAMMPS 
#!/bin/bash
  
# ------------------------------------------------------------------------
# | Template SLURM Submit Script
# | Software        : LAMMPS
# | Versi           : 2022.06.23u4
# |
# | NOTES: 
# | 1. Isi bagian yang ditandai 4 garing (////).
# | 2. Template ini adalah referensi - user dapat mengubah bagian yang 
# |    sekiranya perlu diubah.
# ------------------------------------------------------------------------

# --------------------------------------------------
# Alokasi komputasi, modul software, dan file input
# --------------------------------------------------

# Partisi compute node GPU
#SBATCH --partition=ampere

# Alokasi jumlah GPU 
#SBATCH --gpus=1

# Alokasi jumlah core thread CPU
#SBATCH --ntasks=16

# Rekomendasi 2 thread OMP secara umum
#SBATCH --cpus-per-task=2

# Alokasi jumlah memori RAM (satuan GB)
#SBATCH --mem=64GB

# Alokasi limit waktu menjalankan job 
#SBATCH --time=10:00:00

# Definisi file untuk menampung output terminal
#SBATCH --output=result-%j.txt

# Definisi file untuk menampung output error log    
#SBATCH --error=error-%j.txt  

# Nama input file LAMMPS dengan format file-nya
INPUT_FILE='zobarne.lammps' 

# Memuat modul software LAMMPS versi GPU
module load lammps/2022.06.23u4-GCC11.3-AOCL4.0-CUDA12.1

# -------------------------------------------------
# RUN SCRIPT
# -------------------------------------------------

# Export threading OMP 
export OMP_NUM_THREADS=$SLURM_CPUS_PER_TASK 

# Perintah menjalankan LAMMPS
mpirun --mca pml ucx --mca osc ucx --np $SLURM_NTASKS lmp -sf gpu -pk gpu $SLURM_GPUS -in $INPUT_FILE

Parameter SBATCH esensial

Parameter SBATCH berfungsi untuk mengatur alokasi komputasi (CPU, RAM, GPU, time limit) dan output program. SLURM mempunyai ratusan opsi untuk parameter SBATCH dimana pada tutorial ini kami memberikan daftar SBATCH yang esensial untuk menjalankan komputasi di ALELEON Supercomputer.

Format Penulisan SBATCH

SBATCH ditulis dengan format #SBATCH --<nama-parameter>=<nilai> sesuai contoh berikut: 

# --- Contoh penulisan SBATCH yang benar
#SBATCH --ntasks=32
#SBATCH --mem=64GB
#SBATCH --time=01:00:00
#SBATCH --output=result-%j.txt
#SBATCH --error=error-%j.txt

# --- Contoh penulisan SBATCH yang salah
#SBATCH --ntasks = 32
#SBATCH --mem= 64GB 
#SBATCH --mem = 64 GB

#SBATCH --partition

Menentukan jenis partisi (Compute Node) untuk menjalankan job komputasi user. ALELEON Supercomputer mempunyai 2 partisi Compute Node:

Partisi Compute Node Menulis SBATCH
epyc (Compute Node CPU) Merupakan partisi default
  • user tidak perlu menulis SBATCH parameter untuk epyc
ampere (Compute Node GPU) #SBATCH --partition=ampere

#SBATCH --ntasks, --mem, dan --gpus

ntasks, mem, dan gpus adalah parameter SBATCH utama untuk menentukan alokasi komputasi.

  • ntasks -> alokasi jumlah core CPU. ALELEON Supercomputer mengaktifkan SMT (Simultaneous Multithreading) pada semua CPU sehingga ntasks mendefinisikan jumlah core thread CPU.
  • mem -> alokasi jumlah memori RAM. Ditulis dengan satuan memori GB (Gigabyte).
  • gpus -> alokasi jumlah GPU.

Berikut adalah panduan nilai maksimal masing-masing parameter untuk beberapa skenario penggunaan.

Skenario Penggunaan Nilai maksimal
ntasks (CPU) mem (RAM) gpus (GPU)
Akumulasi concurrent job fair policy usage1 128 128GB 2
Job non-MPI di epyc (Compute Node CPU)2 128 240GB 0
Job MPI di epyc (Compute Node CPU)3 384 240GB 0
Semua jenis job di high-mem node epyc4 128 500GB 0
Semua jenis job di ampere (Compute Node GPU)5 32 120GB 2
Tim admin dapat membantu user untuk membedakan program MPI dan non-MPI.
  • Daftar software komputasi ALELEON memberikan indikator program MPI atau non-MPI.
  • Dapat pula menghubungi admin untuk diskusi melalui email support@efisonlt.com.

Keterangan:

  1. Limitasi fair policy usage untuk menjaga kualitas layanan ALELEON Supercomputer.
  2. Program non-MPI hanya dapat berjalan satu node (maks 128 core di epyc dan 32 core di ampere).
  3. Program MPI dapat berjalan multi-node (parallel computing) pada Partisi epyc yaitu lebih dari 128 core
    • Pada jumlah ntasks >128, SLURM otomatis menjalankan job secara multi-node.
    • Dalam kaitan ini, parameter mem adalah alokasi memori RAM per-node.
    • Info lebih detail lihat laman MPI ALELEON Supercomputer.
  4. Partisi epyc mempunyai satu node dengan jumlah memori 500GB yaitu epyc001.
    1. Tambahkan parameter #SBATCH --nodelist=epyc001
  5. Jangan lupa untuk menggunakan compute node GPU, tambahkan parameter #SBATCH --partition=ampere

#SBATCH --time

Alokasi waktu maksimal untuk menjalankan job. Ditulis dengan format HH:MM:SS atau D-HH:MM:SS. ALELEON Supercomputer mengizinkan time maksimal 3 hari per job (72:00:00 atau 3-00:00:00).

  • SLURM akan menghentikan job apabila berjalan melebihi time yang dialokasikan,
  • SLURM juga dapat menghitung penggunaan Core Hour maksimal job berdasarkan time dan ntasks yang dialokasikan user. SLURM akan menahan job (status PENDING) apabila ntasks * time yang dialokasikan lebih besar dari sisa Core Hour user.

#SBATCH --output

SBATCH output membuat file untuk merekap output terminal jalannya program. User mendefinisikan nama dan format file.

  • Terdapat pola penamaan dari SLURM yaitu %j untuk merekap nomor Job ID.
  • Format file dibebaskan (biasanya menggunakan .txt atau .out).

Kebanyakan template submit script pada wiki ini memberikan contoh penamaan #SBATCH --output=result-%j.txt dimana ketika job berjalan (contoh) dengan job-ID 670, maka nama file output menjadi result-670.txt.

#SBATCH --error

SBATCH error membuat file untuk merekap output verbose program (status jalannya program dan error log ketika program gagal berjalan). File SBATCH error bermanfaat untuk melakukan troubleshooting ketika program gagal berjalan. Apabila membutuhkan support, admin biasanya akan meminta file output dari SBATCH error ini. Pola penamaan mengikuti SBATCH output di atas.

SBATCH untuk notifikasi email SLURM

SLURM ALELEON Supercomputer dapat mengirim notifikasi email kepada user dengan nama "Jojo" untuk mengabarkan status berjalannya job komputasi user. Silahkan tambahan SBATCH berikut pada submit script apabila user ingin menerima notifikasi email dari SLURM: 

#SBATCH --mail-user=<alamat-email-user> 
#SBATCH --mail-type=BEGIN,END,FAIL

SBATCH mail-type mengatur konten email notifikasi SLURM dengan pilihan opsi yang sekiranya berguna untuk user:

  • BEGIN -> notifikasi job sudah mulai
  • END -> notifikasi job sudah selesai beserta cuplikan 20 baris terakhir dari file SBATCH output dan error.
  • FAIL -> notifikasi apabila job gagal berjalan atau berhenti tidak sewajarnya.
  • TIME_LIMIT_50 -> job telah berjalan dengan durasi waktu 50% time limit.
  • TIME_LIMIT_80 -> job telah berjalan dengan durasi waktu 80% time limit.

SBATCH lainnya untuk job MPI

Dalam menjalankan job MPI, user dapat menggunakan parameter SBATCH yang lebih kompleks seperti nodes (alokasi jumlah node), mem-per-cpu (alokasi jumlah RAM per core CPU), mem-per-gpu (alokasi jumlah RAM per GPU). cpus-per-task (alokasi jumlah core per proses MPI untuk skenario hybrid MPI / OMP job), dan lain-lainnya. Info lebih detail lihat laman MPI ALELEON Supercomputer

Memuat Software dengan module load

Perintah module load (bagian dari Module Environment untuk memuat modul software) pada Submit Script berfungsi supaya Compute Node dapat menjalankan software yang dibutuhkan job user. 

module load <nama-modul-software>

Keterangan:

  • Tulis module load sebelum menulis script alur jalannya program.
Diperoleh dari "https://wiki.efisonlt.com/index.php?title=Submit_Script_ALELEON_Supercomputer&oldid=1220"