Skip to navigation

OSU

View as Markdown

This workload (test_template_name is OSUBench) allows you to execute OSU Micro Benchmarks within the CloudAI framework.

Usage Example

Test example:

name = "osu_example"
test_template_name = "OSUBench"
description = "OSU Benchmark example"
[cmd_args]
"docker_image_url" = "<docker container url here>"
"benchmarks_dir" = "/directory/with/osu/binaries/in/container"
"benchmark" = ["osu_allreduce", "osu_allgather"]
"iterations" = 10
"message_size" = "1024"

Test Scenario example:

name = "osu_example"
[[Tests]]
id = "Tests.1"
test_name = "osu_example"
num_nodes = "2"
time_limit = "00:20:00"

Test-in-Scenario example:

name = "osu-test"
[[Tests]]
id = "Tests.osu_allreduce"
num_nodes = 2
time_limit = "00:05:00"
name = "osu_example"
description = "OSU allreduce 1KB"
test_template_name = "OSUBench"
[Tests.cmd_args]
docker_image_url = "<docker container url here>"
benchmarks_dir = "/directory/with/osu/binaries/in/container"
benchmark = "osu_allreduce"
iterations = 10
message_size = "1024"

Comparison Reports

The OSU comparison v2 report labels the X axis with the measured message sizes in bytes. Sizes are displayed at equally spaced positions, including zero-byte messages, rather than using default logarithmic ticks. When runs measure different size ranges, charts and tables use the sorted union of measured sizes. Missing measurements appear as chart gaps and n/a table cells.

API Documentation

Command Arguments

OSUBenchCmdArgs

Command line arguments for a OSU Benchmark test.

FieldTypeDefaultDescription
docker_image_urlstrRequiredURL of the Docker image to use for the test.
benchmarks_dirstrRequiredDirectory with the OSU Benchmark binaries inside the container.
benchmarkstr | List[str]RequiredName of the benchmark to run.
message_sizestr | List[str] | NoneNoneMessage size for the benchmark.

Examples::

128 // min = default, max = 128
2:128 // min = 2, max = 128
2: // min 2, max = default
iterationsint | NoneNoneNumber of iterations for the benchmark.
warmupint | NoneNoneNumber of warmup iterations to skip before timing.
mem_limitint | NoneNonePer-process maximum memory consumption in bytes.
fullboolTruePrint full format listing of results.

Test Definition

OSUBenchTestDefinition

Test definition for OSU Benchmark test.

FieldTypeDefaultDescription
namestrRequired
descriptionstrRequired
test_template_namestrRequired
cmd_argscloudai.workloads.osu_bench.osu_bench.OSUBenchCmdArgsRequired
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.