Skip to navigation

UCC

View as Markdown

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

UCCCmdArgs

UCC test command arguments.

FieldTypeDefaultDescription
docker_image_urlstrRequired
collectiveLiteral['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'
bint | list[int]1
estr | list[str]'8M'
genstr | list[str] | NoneNone
use_deepep_matrixboolFalse

Test Definition

UCCTestDefinition

Test object for UCC.

FieldTypeDefaultDescription
namestrRequired
descriptionstrRequired
test_template_namestrRequired
cmd_argscloudai.workloads.ucc_test.ucc.UCCCmdArgsRequired
dse_excluded_argslist[str]Factory: list
extra_env_varsdict[str, str | typing.List[str]]{}
extra_cmd_argsdict[str, str]{}
extra_container_mountslist[str][]
git_reposlist[cloudai._core.installables.git_repo.GitRepo][]
nsyscloudai.models.workload.NsysConfiguration | NoneNone
predictorcloudai.models.workload.PredictorConfig | NoneNone
training_reportcloudai.models.workload.TrainingReportConfig | NoneNone
agentstr'grid_search'
agent_stepsint1
agent_metricslist[str]['default']
agent_reward_functionstr'inverse'
agent_configdict[str, Any] | NoneNoneAgent configuration.
env_paramsdict[str, cloudai.configurator.env_params.EnvParamSpec]Factory: dictEnvironment 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.