UCC#

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 = 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 = "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,

)[source]#

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: ~cloudai.workloads.ucc_test.ucc.UCCCmdArgs, dse_excluded_args: list[str] = <factory>, 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, agent: str = 'grid_search', agent_steps: int = 1, agent_metrics: list[str] = ['default'], agent_reward_function: str = 'inverse', agent_config: dict[str, ~typing.Any] | None = None)[source]#

Bases: TestDefinition

Test object for UCC.

is_dse_excluded_arg(path: str) → bool#: Return whether a dot-separated cmd_args path should be ignored by DSE.