> This page is for version 1.8.1 (default).
> For other versions, use one of these documentation indexes:
> - 1.8.1 (default): https://docs.nvidia.com/networking/cloudai/1.8.1/llms.txt
> - 1.7.1: https://docs.nvidia.com/networking/cloudai/1.7.1/llms.txt
> - 1.6.1: https://docs.nvidia.com/networking/cloudai/1.6.1/llms.txt
> - dev: https://docs.nvidia.com/networking/cloudai/dev/llms.txt

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.nvidia.com/networking/cloudai/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.nvidia.com/networking/cloudai/_mcp/server.

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

## Usage Examples

Test TOML example:

```toml
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:

```toml
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:

```toml
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

**&#x20;*pydantic model* cloudai.workloads.nixl_kvbench.nixl_kvbench.NIXLKVBenchCmdArgs**

Command line arguments for NIXL KVBench.

**&#x20;*field* command*: Literal\['profile'] = 'profile'*\*\*

**&#x20;*field* kvbench_script*: str = '/workspace/nixl/benchmark/kvbench/main.py'*\*\*

**&#x20;*field* python_executable*: str = 'python'*\*\*

**&#x20;*field* backend*: str | list\[str] | None = None*\*\*

**&#x20;*field* docker_image_url*: str* *\[Required]*\*\*

URL of the Docker image to use for the benchmark.

**&#x20;*field* etcd_path*: str = 'etcd'*\*\*

Path to the etcd executable.

**&#x20;*field* wait_etcd_for*: int = 60*\*\*

Number of seconds to wait for etcd to become healthy.

**&#x20;*field* etcd_image_url*: str | None = None*\*\*

Optional URL of the Docker image to use for etcd, by default etcd will be run from the same image as the benchmark.

**&#x20;*field* filepath*: str | None = None*\*\*

Directory path (in container) for storage operations. Example: /data

**&#x20;*field* total_buffer_size*: str | list\[str] | None = None*\*\*

Total buffer size in bytes. Examples: 1024, 1kb, 1mb, 1gb. Use with device_list. The size will be passed into NIXL as integer (bytes)

**&#x20;*field* device_list*: str | list\[str] | None = None*\*\*

Device specs in format ‘id:type:path’ (e.g., ‘11:F:/store0.bin,27:K:/dev/nvme0n1’)

### Test Definition

*class* cloudai.workloads.nixl_kvbench.nixl_kvbench.NIXLKVBenchTestDefinition(*\*, name: str, description: str, test_template_name: str, cmd_args: \~cloudai.workloads.nixl_kvbench.nixl_kvbench.NIXLKVBenchCmdArgs, 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, training_report: \~cloudai.models.workload.TrainingReportConfig | 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, env_params: dict\[str, \~cloudai.configurator.env_params.EnvParamSpec] = \<factory>*)

Bases: `NIXLBaseTestDefinition[NIXLKVBenchCmdArgs]`

Test definition for NIXL KVBench.

**&#x20;*property* is_domain_randomization_enabled*: bool*\*\*

at least one `env_params` annotation.

**Type:**

Whether the config declares domain randomization

**&#x20;is_dse_excluded_arg(*path: str*) → bool**

Return whether a dot-separated cmd_args path should be ignored by DSE.

**&#x20;is_env_sampled(*cmd_args_path: str*) → bool**

Whether a cmd_args field is env-sampled (env draws it per trial, not the agent).

metric_observations(

*system: System*,

*tr: TestRun*,

) → list\[MetricObservation]

Return canonical metric observations produced by this test run, if supported.

**&#x20;*property* uses_asio*: bool*\*\*

Return whether this workload uses NIXLBench’s ASIO runtime.

**&#x20;*property* uses_etcd*: bool*\*\*

Return whether this workload needs CloudAI to manage an ETCD server.

**&#x20;*validator* validate_env_params*  » \* *all fields**\*

Validate env_params annotations against cmd_args.

`env_params` is an annotation: each key names a `cmd_args` field whose value is the candidate set (the single source of truth), and the entry carries only *how* to sample. So each key must name a real `cmd_args` field whose value is a candidate list; a scalar is already fixed, so annotating it is a meaningless label and is rejected here. When `weights` are declared, the list needs >= 2 values and the weights must align 1:1 with it. Sampling, persistence, the per-trial cmd_args overlay, and the cache key all live in `CloudAIGymEnv`; keeping this shape check in core lets the overlay stay agent- and workload-agnostic rather than re-implemented per workload.