> This page is for version dev.
> For other versions, use one of these documentation indexes:
> - 1.8.1 (default): https://docs.nvidia.com/networking/cloudai/1.8.1/llms.txt
> - 1.7.1: https://docs.nvidia.com/networking/cloudai/1.7.1/llms.txt
> - 1.6.1: https://docs.nvidia.com/networking/cloudai/1.6.1/llms.txt
> - dev: https://docs.nvidia.com/networking/cloudai/dev/llms.txt

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.nvidia.com/networking/cloudai/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.nvidia.com/networking/cloudai/_mcp/server.

This workload (`test_template_name` is `SlurmContainer`) executes containerized workloads using Slurm with custom container configurations.

## Usage Examples

Test TOML example:

```toml
name = "my_container_test"
description = "Example Slurm container test"
test_template_name = "SlurmContainer"

[cmd_args]
check_exit_code = true
docker_image_url = "/path/to/container.sqsh"
cmd = "python train.py"
```

Test Scenario example:

```toml
name = "slurm-container-test"

[[Tests]]
id = "container.1"
num_nodes = 2
time_limit = "01:00:00"

test_name = "my_container_test"
```

Test-in-Scenario example:

```toml
name = "slurm-container-test"

[[Tests]]
id = "container.1"
num_nodes = 2
time_limit = "01:00:00"

name = "my_container_test"
description = "Example Slurm container test"
test_template_name = "SlurmContainer"

  [Tests.cmd_args]
  check_exit_code = true
  docker_image_url = "/path/to/container.sqsh"
  cmd = "python train.py"
```

## Run Status

Exit-code checking is disabled by default for backwards compatibility. Set `check_exit_code = true` in `cmd_args` to record the aggregate `srun` exit code in the per-test `exit_code.txt` file and use it to determine success. Only integer `0` is successful. Any non-zero integer, or a missing, malformed, unreadable, or undecodable file, marks the run as failed. Slurm-style exit code `0:0` is not accepted.

## API Documentation

### Command Arguments

### `SlurmContainerCmdArgs`

Command line arguments for a generic Slurm container test.

| Field              | Type   | Default  | Description                                                    |
| ------------------ | ------ | -------- | -------------------------------------------------------------- |
| `docker_image_url` | `str`  | Required |                                                                |
| `cmd`              | `str`  | Required |                                                                |
| `check_exit_code`  | `bool` | `False`  | Whether to grade the run from the container command exit code. |

### Test Definition

### `SlurmContainerTestDefinition`

Test definition for a generic Slurm container test.

| Field                    | Type                                                                      | Default         | Description                                                                                                                                                                                                                   |
| ------------------------ | ------------------------------------------------------------------------- | --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `name`                   | `str`                                                                     | Required        |                                                                                                                                                                                                                               |
| `description`            | `str`                                                                     | Required        |                                                                                                                                                                                                                               |
| `test_template_name`     | `str`                                                                     | Required        |                                                                                                                                                                                                                               |
| `cmd_args`               | `cloudai.workloads.slurm_container.slurm_container.SlurmContainerCmdArgs` | Required        |                                                                                                                                                                                                                               |
| `dse_excluded_args`      | `list[str]`                                                               | Factory: `list` |                                                                                                                                                                                                                               |
| `extra_env_vars`         | `dict[str, str \| typing.List[str]]`                                      | `{}`            |                                                                                                                                                                                                                               |
| `extra_cmd_args`         | `dict[str, str]`                                                          | `{}`            |                                                                                                                                                                                                                               |
| `extra_container_mounts` | `list[str]`                                                               | `[]`            |                                                                                                                                                                                                                               |
| `git_repos`              | `list[cloudai._core.installables.git_repo.GitRepo]`                       | `[]`            |                                                                                                                                                                                                                               |
| `nsys`                   | `cloudai.models.workload.NsysConfiguration \| None`                       | `None`          |                                                                                                                                                                                                                               |
| `predictor`              | `cloudai.models.workload.PredictorConfig \| None`                         | `None`          |                                                                                                                                                                                                                               |
| `training_report`        | `cloudai.models.workload.TrainingReportConfig \| None`                    | `None`          |                                                                                                                                                                                                                               |
| `agent`                  | `str`                                                                     | `'grid_search'` |                                                                                                                                                                                                                               |
| `agent_steps`            | `int`                                                                     | `1`             |                                                                                                                                                                                                                               |
| `agent_metrics`          | `list[str]`                                                               | `['default']`   |                                                                                                                                                                                                                               |
| `agent_reward_function`  | `str`                                                                     | `'inverse'`     |                                                                                                                                                                                                                               |
| `agent_config`           | `dict[str, Any] \| None`                                                  | `None`          | Agent configuration.                                                                                                                                                                                                          |
| `env_params`             | `dict[str, cloudai.configurator.env_params.EnvParamSpec]`                 | Factory: `dict` | Environment parameters sampled by the env per trial. Sibling to cmd_args; not part of the agent's action space. CloudAIGymEnv samples, persists them in the trajectory output, and includes them in the trajectory cache key. |
| `extra_srun_args`        | `list[str]`                                                               | Factory: `list` |                                                                                                                                                                                                                               |
| `scripts`                | `list[cloudai._core.installables.file.File]`                              | Factory: `list` |                                                                                                                                                                                                                               |