Skip to navigation

NIXL CTPerf

View as Markdown

This workload (test_template_name is NixlPerftest) runs NIXL performance testing suite for comprehensive network performance evaluation.

Usage Examples

Test TOML example:

name = "my_nixl_perftest_test"
description = "Example NIXL Perftest test"
test_template_name = "NixlPerftest"
[cmd_args]
docker_image_url = "<docker container url here>"
subtest = "sequential-ct-perftest"
num_user_requests = 1
batch_size = 1
num_prefill_nodes = 1
num_decode_nodes = 1
prefill_tp = 4
decode_tp = 4
isl_mean = 10000
isl_scale = 3000
model = "deepseek-r1-distill-llama-70b"

Test Scenario example:

name = "nixl-perftest-test"
[[Tests]]
id = "perftest.1"
num_nodes = 2
time_limit = "00:20:00"
test_name = "my_nixl_perftest_test"

Test-in-Scenario example:

name = "nixl-perftest-test"
[[Tests]]
id = "perftest.1"
num_nodes = 2
time_limit = "00:20:00"
name = "my_nixl_perftest_test"
description = "Example NIXL Perftest test"
test_template_name = "NixlPerftest"
[Tests.cmd_args]
docker_image_url = "<docker container url here>"
subtest = "sequential-ct-perftest"
num_user_requests = 100
batch_size = 1
num_prefill_nodes = 1
num_decode_nodes = 1
prefill_tp = 8
decode_tp = 8
model = "deepseek-r1-distill-llama-70b"
[Tests.extra_env_vars]
CUDA_VISIBLE_DEVICES = "$SLURM_LOCALID"

API Documentation

Command Arguments

NixlPerftestCmdArgs

CmdArgs for NIXL Perftest.

FieldTypeDefaultDescription
docker_image_urlstrRequiredURL of the Docker image to use for the benchmark.
etcd_pathstr'etcd'Path to the etcd executable.
wait_etcd_forint60Number of seconds to wait for etcd to become healthy.
etcd_image_urlstr | NoneNoneOptional URL of the Docker image to use for etcd, by default etcd will be run from the same image as the benchmark.
subtestLiteral['sequential-ct-perftest']Required
perftest_scriptstr'/workspace/nixl/benchmark/kvbench/main.py'
matgen_scriptstr'/workspace/nixl/benchmark/kvbench/test/inference_workload_matgen.py'
python_executablestr'python'
num_user_requestsint | list[int]Required
batch_sizeint | list[int]Required
num_prefill_nodesint | list[int]Required
num_decode_nodesint | list[int]Required
isl_meanint | list[int] | NoneNone
isl_scaleint | list[int] | NoneNone
prefill_tpint | list[int]1
prefill_ppint | list[int]1
prefill_cpint | list[int]1
decode_tpint | list[int]1
decode_ppint | list[int]1
decode_cpint | list[int]1
modelstr | list[str] | NoneNone
hidden_sizeint | NoneNone
num_layersint | NoneNone
num_headsint | NoneNone
num_kv_headsint | NoneNone
dtype_sizeint | NoneNone
matgen_argscloudai.workloads.nixl_perftest.nixl_perftest.MatgenCmdArgsFactory: MatgenCmdArgs

Test Definition

NixlPerftestTestDefinition

TestDefinition for NixlPerftest.

FieldTypeDefaultDescription
namestrRequired
descriptionstrRequired
test_template_namestrRequired
cmd_argscloudai.workloads.nixl_perftest.nixl_perftest.NixlPerftestCmdArgsRequired
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.