Add --gpus option (#8)

* add gpus option

* Add documentation note for usage of non-standard commands

---------

Co-authored-by: Paolo Greppi <paolo.greppi@libpf.com>
Co-authored-by: Benjamin Lozes <62449444+byjtew@users.noreply.github.com>

Author: 3 people

README.md

@@ -173,10 +173,10 @@ with every _SBATCH_VAR_ replaced by _SLURM_VAR_.
 | CI_**SLURM_CI_SLURM_PRIORITY** | [--priority](https://slurm.schedmd.com/sbatch.html#OPT_priority)                |     ✅     |                              |                                        |
 | CI_**SLURM_CI_SLURM_NICE**     | [--nice](https://slurm.schedmd.com/sbatch.html#OPT_nice)                        |     ✅     |                              |                                        |
 | CI_**SLURM_MEM_PER_CPU**       | [--mem-per-cpu](https://slurm.schedmd.com/sbatch.html#OPT_mem-per-cpu)          |     ✅     |                              |                                        |
-| CI_**SLURM_COMMENT**           | [--comment](https://slurm.schedmd.com/sbatch.html#OPT_comment)                  |     ✅     |                              | `Automatic job created from GitLab CI` |
+| CI_**SLURM_COMMENT**           | [--comment](https://slurm.schedmd.com/sbatch.html#OPT_comment)                  |     ✅     |                              | _Automatic job created from GitLab CI_ |
 | CI_**SLURM_ACCOUNT**           | [-A / --account](https://slurm.schedmd.com/sbatch.html#OPT_account)             |     ✅     |                              |                                        |
 | CI_**SLURM_QOS**               | [--qos](https://slurm.schedmd.com/sbatch.html#OPT_qos)                          |     ✅     |                              |                                        |
-| CI_**SLURM_GPUS**              | [-G / --gpus](https://slurm.schedmd.com/sbatch.html#OPT_gpus)                   |     ⌛     |                              |                                        |
+| CI_**SLURM_GPUS**              | [-G / --gpus](https://slurm.schedmd.com/sbatch.html#OPT_gpus)                   |     ✅     |                              | _Non-standard: `--gres=gpu:` is not implemented yet_ |
 | CI_**SLURM_GPUS_PER_NODE**     | [--gpus-per-node](https://slurm.schedmd.com/sbatch.html#OPT_gpus-per-node)      |     ⌛     |                              |                                        |
 | CI_**SLURM_GPUS_PER_TASK**     | [--gpus-per-task](https://slurm.schedmd.com/sbatch.html#OPT_gpus-per-task)      |     ⌛     |                              |                                        |
 | CI_**SLURM_CPUS_PER_GPU**      | [--cpus-per-gpu](https://slurm.schedmd.com/sbatch.html#OPT_mem-per-gpu)         |     ⌛     |                              |                                        |

driver/driver.py

@@ -250,6 +250,7 @@ def prepare():
             chdir=GitLabJobInterface.get_build_dir_path(),
             account=GitLabJobInterface.get_env("CI_SLURM_ACCOUNT"),
             qos=GitLabJobInterface.get_env("CI_SLURM_QOS"),
+            gpus=GitLabJobInterface.get_env("CI_SLURM_GPUS"),
             export="ALL",
             stdout_file="stdout.log",
             stderr_file="stderr.log"

driver/slurm_interface.py

@@ -148,6 +148,7 @@ def __init__(
             stderr_file: str = None,
             account: str = None,
             qos: str = None,
+            gpus: str = None,
     ):
         self.job_name = job_name
         self.nodes = nodes
@@ -172,6 +173,7 @@ def __init__(
         self.stderr_file = stderr_file
         self.account = account
         self.qos = qos
+        self.gpus = gpus
 
     def get_cli_parameters(self) -> List[str]:
         parameters = [
@@ -198,6 +200,7 @@ def get_cli_parameters(self) -> List[str]:
             f"--error={self.stderr_file}" if self.stderr_file is not None else None,
             f"--account={self.account}" if self.account is not None else None,
             f"--qos={self.qos}" if self.qos is not None else None,
+            f"--gpus={self.gpus}" if self.gpus is not None else None,
         ]
         return [x for x in parameters if x is not None]