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 NcclTest) allows users to execute NCCL benchmarks within the CloudAI framework.
Usage Example
Test TOML example:
name = "my_nccl_test"description = "Example NCCL test"test_template_name = "NcclTest"[cmd_args]docker_image_url = "nvcr.io#nvidia/pytorch:25.06-py3"
Test Scenario example:
name = "nccl-test"[[Tests]]id = "nccl.1"num_nodes = 1time_limit = "00:05:00"test_name = "my_nccl_test"
Test-in-Scenario example:
name = "nccl-test"[[Tests]]id = "nccl.1"num_nodes = 1time_limit = "00:05:00"name = "my_nccl_test"description = "Example NCCL test"test_template_name = "NcclTest"[Tests.cmd_args]docker_image_url = "nvcr.io#nvidia/pytorch:25.06-py3"subtest_name = "all_reduce_perf_mpi"iters = 100
API Documentation
Command Arguments
NCCLCmdArgs
NCCL test command arguments.
| Field | Type | Default | Description |
|---|---|---|---|
docker_image_url | str | Required | |
subtest_name | Literal['all_reduce_perf_mpi', 'all_gather_perf_mpi', 'alltoall_perf_mpi', 'alltoallv_perf_mpi', 'broadcast_perf_mpi', 'gather_perf_mpi', 'hypercube_perf_mpi', 'reduce_perf_mpi', 'reduce_scatter_perf_mpi', 'scatter_perf_mpi', 'sendrecv_perf_mpi', 'bisection_perf_mpi', 'all_reduce_perf', 'all_gather_perf', 'alltoall_perf', 'alltoallv_perf', 'broadcast_perf', 'gather_perf', 'hypercube_perf', 'reduce_perf', 'reduce_scatter_perf', 'scatter_perf', 'sendrecv_perf', 'bisection_perf'] | list[Literal['all_reduce_perf_mpi', 'all_gather_perf_mpi', 'alltoall_perf_mpi', 'alltoallv_perf_mpi', 'broadcast_perf_mpi', 'gather_perf_mpi', 'hypercube_perf_mpi', 'reduce_perf_mpi', 'reduce_scatter_perf_mpi', 'scatter_perf_mpi', 'sendrecv_perf_mpi', 'bisection_perf_mpi', 'all_reduce_perf', 'all_gather_perf', 'alltoall_perf', 'alltoallv_perf', 'broadcast_perf', 'gather_perf', 'hypercube_perf', 'reduce_perf', 'reduce_scatter_perf', 'scatter_perf', 'sendrecv_perf', 'bisection_perf']] | 'all_reduce_perf_mpi' | |
nthreads | int | list[int] | 1 | |
ngpus | int | list[int] | 1 | |
minbytes | str | list[str] | '32M' | |
maxbytes | str | list[str] | '32M' | |
stepbytes | str | list[str] | '1M' | |
op | Literal['sum', 'prod', 'min', 'max', 'avg', 'all'] | list[Literal['sum', 'prod', 'min', 'max', 'avg', 'all']] | 'sum' | |
datatype | Literal['uint8', 'float'] | list[Literal['uint8', 'float']] | 'float' | |
root | int | list[int] | 0 | |
iters | int | list[int] | 20 | |
warmup_iters | int | list[int] | 5 | |
agg_iters | int | list[int] | 1 | |
average | int | list[int] | 1 | |
parallel_init | int | list[int] | 0 | |
check | int | list[int] | 1 | |
blocking | int | list[int] | 0 | |
cudagraph | int | list[int] | 0 | |
stepfactor | int | list[int] | None | None | |
use_deepep_matrix | bool | False | |
alltoallv_matrix_container_path | str | '/tmp/traffic_matrix.txt' | |
min_busbw | float | None | None |
Test Definition
NCCLTestDefinition
Test object for NCCL.
| Field | Type | Default | Description |
|---|---|---|---|
name | str | Required | |
description | str | Required | |
test_template_name | str | Required | |
cmd_args | cloudai.workloads.nccl_test.nccl.NCCLCmdArgs | 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. |