Skip to navigation

NIXL KVBench

View as Markdown

This workload (test_template_name is NIXLKVBench) runs NIXL KV-cache benchmarking for key-value store performance testing.

Usage Examples

Test TOML example:

name = "my_nixl_kvbench_test"
description = "Example NIXL KVBench test"
test_template_name = "NIXLKVBench"
[cmd_args]
docker_image_url = "<docker container url here>"
model = "./examples/model_deepseek_r1.yaml"
model_config = "./examples/block-tp1-pp16.yaml"
backend = "POSIX"
num_requests = 1
source = "file"
num_iter = 16
page_size = 256
filepath = "/data"

Test Scenario example:

name = "nixl-kvbench-test"
[[Tests]]
id = "kvbench.1"
num_nodes = 1
time_limit = "00:10:00"
test_name = "my_nixl_kvbench_test"

Test-in-Scenario example:

name = "nixl-kvbench-test"
[[Tests]]
id = "kvbench.1"
num_nodes = 1
time_limit = "00:10:00"
name = "my_nixl_kvbench_test"
description = "Example NIXL KVBench test"
test_template_name = "NIXLKVBench"
[Tests.cmd_args]
docker_image_url = "<docker container url here>"
backend = "UCX"
source = "memory"
op_type = "READ"

API Documentation

Command Arguments

NIXLKVBenchCmdArgs

Command line arguments for NIXL KVBench.

FieldTypeDefaultDescription
filepathstr | NoneNoneDirectory path (in container) for storage operations. Example: /data
total_buffer_sizestr | list[str] | NoneNoneTotal buffer size in bytes. Examples: 1024, 1kb, 1mb, 1gb. Use with device_list. The size will be passed into NIXL as integer (bytes)
device_liststr | list[str] | NoneNoneDevice specs in format ‘id:type:path’ (e.g., ‘11:F:/store0.bin,27:K:/dev/nvme0n1’)
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.
commandLiteral['profile']'profile'
kvbench_scriptstr'/workspace/nixl/benchmark/kvbench/main.py'
python_executablestr'python'
model_cfgstr | list[str] | NoneNonePath to model configuration file used by NIXL KVBench.
backendstr | list[str] | NoneNone

Test Definition

NIXLKVBenchTestDefinition

Test definition for NIXL KVBench.

FieldTypeDefaultDescription
namestrRequired
descriptionstrRequired
test_template_namestrRequired
cmd_argscloudai.workloads.nixl_kvbench.nixl_kvbench.NIXLKVBenchCmdArgsRequired
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.