> This page is for version 1.6.1.
> 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 `UCCTest`) allows users to execute UCC benchmarks within the CloudAI framework.

## Usage Examples

Test TOML example:

```toml
name = "ucc"
description = "Example UCC test"
test_template_name = "UCCTest"

[cmd_args]
docker_image_url = "nvcr.io#nvidia/pytorch:25.06-py3"
```

Test Scenario example:

```toml
name = "ucc-test"

[[Tests]]
id = "ucc.1"
num_nodes = 1
time_limit = "00:02:00"

test_name = "ucc"
```

Test-in-Scenario example:

```toml
name = "ucc-test"

[[Tests]]
id = "ucc.1"
num_nodes = 1
time_limit = "00:02:00"

name = "ucc"
description = "Example UCC test"
test_template_name = "UCCTest"

[Tests.cmd_args]
docker_image_url = "nvcr.io#nvidia/pytorch:25.06-py3"
```

## API Documentation

### Command Arguments

*class* cloudai.workloads.ucc_test.ucc.UCCCmdArgs(

*\**,

*docker_image_url: str*,

*collective: Literal\['allgather', 'allgatherv', 'allreduce', 'alltoall', 'alltoallv', 'barrier', 'bcast', 'gather', 'gatherv', 'reduce', 'reduce_scatter', 'reduce_scatterv', 'scatter', 'scatterv', 'memcpy', 'reducedt', 'reducedt_strided'] | list\[Literal\['allgather', 'allgatherv', 'allreduce', 'alltoall', 'alltoallv', 'barrier', 'bcast', 'gather', 'gatherv', 'reduce', 'reduce_scatter', 'reduce_scatterv', 'scatter', 'scatterv', 'memcpy', 'reducedt', 'reducedt_strided']] = 'alltoall'*,

*b: int | list\[int] = 1*,

*e: str | list\[str] = '8M'*,

*gen: str | list\[str] | None = None*,

*\*\*extra_data: Any*,

)

Bases: `CmdArgs`

UCC test command arguments.

### Test Definition

*class* cloudai.workloads.ucc_test.ucc.UCCTestDefinition(

*\**,

*name: str*,

*description: str*,

*test_template_name: str*,

*cmd_args: [UCCCmdArgs](/networking/cloudai/1.6.1/workloads/ucc#cloudai.workloads.ucc_test.ucc.UCCCmdArgs "cloudai.workloads.ucc_test.ucc.UCCCmdArgs")*,

*extra_env_vars: dict\[str, str | List\[str]] = \{}*,

*extra_cmd_args: dict\[str, str] = \{}*,

*extra_container_mounts: list\[str] = \[]*,

*git_repos: list\[GitRepo] = \[]*,

*nsys: NsysConfiguration | None = None*,

*predictor: PredictorConfig | 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*,

)

Bases: `TestDefinition`

Test object for UCC.