UCC#
This workload (test_template_name is UCCTest
) allows you to execute UCC benchmarks within the CloudAI framework.
Usage Example#
Test TOML example:
name = "ucc"
description = "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 = 1
time_limit = "00:02:00"
test_name = "ucc"
Test-in-Scenario example:
name = "ucc-test"
[[Tests]]
id = "ucc.1"
num_nodes = 1
time_limit = "00:02:00"
name = "ucc"
description = "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',
- **extra_data: Any,
Bases:
CmdArgs
UCC test command arguments.
- 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']]#
- b: int | list[int]#
- e: str | list[str]#
Test Definition#
- class cloudai.workloads.ucc_test.ucc.UCCTestDefinition(
- *,
- name: str,
- description: str,
- test_template_name: str,
- cmd_args: 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',
Bases:
TestDefinition
Test object for UCC.
- cmd_args: UCCCmdArgs#
- property docker_image: DockerImage#
- property installables: list[Installable]#