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
This workload (test_template_name is UCCTest) allows users to execute UCC benchmarks within the CloudAI framework.
Usage Examples
Test TOML example:
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:
name = "ucc-test"[[Tests]]id = "ucc.1"num_nodes = 1time_limit = "00:02:00"test_name = "ucc"
Test-in-Scenario example:
name = "ucc-test"[[Tests]]id = "ucc.1"num_nodes = 1time_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
UCCCmdArgs
UCC test command arguments.
| Field | Type | Default | Description |
|---|---|---|---|
docker_image_url | str | Required | |
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 | |
use_deepep_matrix | bool | False |
Test Definition
UCCTestDefinition
Test object for UCC.
| Field | Type | Default | Description |
|---|---|---|---|
name | str | Required | |
description | str | Required | |
test_template_name | str | Required | |
cmd_args | cloudai.workloads.ucc_test.ucc.UCCCmdArgs | 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. |