NIXL Bench

This workload (test_template_name is NIXLBench) runs NIXL benchmarking suite for network and interconnect performance testing.

Test TOML example:

            

            
name = "my_nixl_bench_test"
description = "Example NIXL Bench test"
test_template_name = "NIXLBench"

[cmd_args]
docker_image_url = "<docker container url here>"
path_to_benchmark = "/workspace/nixlbench/build/nixlbench"
backend = "UCX"
initiator_seg_type = "VRAM"
target_seg_type = "VRAM"
op_type = "READ"
        

Test Scenario example:

            

            
name = "nixl-bench-test"

[[Tests]]
id = "bench.1"
num_nodes = 1
time_limit = "00:10:00"

test_name = "my_nixl_bench_test"
        

Test-in-Scenario example:

            

            
name = "nixl-bench-test"

[[Tests]]
id = "bench.1"
num_nodes = 1
time_limit = "00:10:00"

name = "my_nixl_bench_test"
description = "Example NIXL Bench test"
test_template_name = "NIXLBench"

  [Tests.cmd_args]
  docker_image_url = "<docker container url here>"
  path_to_benchmark = "/workspace/nixlbench/build/nixlbench"
  backend = "UCX"
  initiator_seg_type = "DRAM"
  target_seg_type = "DRAM"
  op_type = "WRITE"
        

Command Arguments

class cloudai.workloads.nixl_bench.nixl_bench.NIXLBenchCmdArgs(*, docker_image_url: str, path_to_benchmark: str, etcd_path: str = 'etcd', etcd_endpoints: str = 'http://$NIXL_ETCD_ENDPOINTS', **extra_data: Any)[source]

Bases: CmdArgs

Command line arguments for a NIXL Bench test.

docker_image_url: str

path_to_benchmark: str

etcd_path: str

etcd_endpoints: str

Test Definition

class cloudai.workloads.nixl_bench.nixl_bench.NIXLBenchTestDefinition(*, name: str, description: str, test_template_name: str, cmd_args: NIXLBenchCmdArgs, extra_env_vars: dict[str, str | List[str]] = {}, extra_cmd_args: dict[str, str] = {}, extra_container_mounts: list[str] = [], git_repos: list[GitRepo] = [], nsys: NsysConfiguration | None = None, predictor: PredictorConfig | None = None, agent: str = 'grid_search', agent_steps: int = 1, agent_metrics: list[str] = ['default'], agent_reward_function: str = 'inverse')[source]

Bases: TestDefinition

Test definition for a NIXL Bench test.

cmd_args: NIXLBenchCmdArgs

property docker_image: DockerImage

property installables: list[Installable]

property cmd_args_dict: dict[str, str | list[str]]

was_run_successful(tr: TestRun) → JobStatusResult[source]