> 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.

DDLB workload (`test_template_name` is `DDLB`) allows users to execute DDLB (Distributed Deep Learning Benchmarks) within the CloudAI framework. Please find the DDLB README at [https://github.com/samnordmann/ddlb](https://github.com/samnordmann/ddlb).

## Usage Examples

Test TOML example:

```toml
name = "my_ddlb_test"
description = "Example DDLB test"
test_template_name = "DDLB"

[cmd_args]
docker_image_url = "<docker container url here>"
primitive = "tp_columnwise"
dtype = "float16"
```

Test Scenario example:

```toml
name = "ddlb-test"

[[Tests]]
id = "ddlb.1"
num_nodes = 1
time_limit = "00:10:00"

test_name = "my_ddlb_test"
```

Test-in-Scenario example:

```toml
name = "ddlb-test"

[[Tests]]
id = "ddlb.1"
num_nodes = 1
time_limit = "00:10:00"

name = "my_ddlb_test"
description = "Example DDLB test"
test_template_name = "DDLB"

  [Tests.cmd_args]
  docker_image_url = "<docker container url here>"
  primitive = "tp_columnwise"
  m = 1024
  n = 128
  k = 1024
  dtype = "float16"
  num_iterations = 50
  num_warmups = 5
  impl = "pytorch;backend=nccl;order=AG_before"
```

## API Documentation

### Command Arguments

### `DDLBCmdArgs`

DDLB test command arguments.

| Field              | Type               | Default                                  | Description |
| ------------------ | ------------------ | ---------------------------------------- | ----------- |
| `docker_image_url` | `str`              | Required                                 |             |
| `primitive`        | `str`              | Required                                 |             |
| `m`                | `int \| list[int]` | `1024`                                   |             |
| `n`                | `int \| list[int]` | `128`                                    |             |
| `k`                | `int \| list[int]` | `1024`                                   |             |
| `dtype`            | `str`              | Required                                 |             |
| `num_iterations`   | `int`              | `50`                                     |             |
| `num_warmups`      | `int`              | `5`                                      |             |
| `impl`             | `str \| list[str]` | `'pytorch;backend=nccl;order=AG_before'` |             |

### Test Definition

### `DDLBTestDefinition`

Test object for DDLB.

| Field                    | Type                                                      | Default         | Description                                                                                                                                                                                                                   |
| ------------------------ | --------------------------------------------------------- | --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `name`                   | `str`                                                     | Required        |                                                                                                                                                                                                                               |
| `description`            | `str`                                                     | Required        |                                                                                                                                                                                                                               |
| `test_template_name`     | `str`                                                     | Required        |                                                                                                                                                                                                                               |
| `cmd_args`               | `cloudai.workloads.ddlb.ddlb.DDLBCmdArgs`                 | 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. |