Skip to content

guidellm.benchmark.scenarios

Builtin benchmark scenario definitions and discovery utilities.

This module provides access to predefined benchmark scenarios stored as JSON files within the scenarios directory. It enables discovery and retrieval of builtin scenarios by name or filename, supporting both stem names (without extension) and full filenames for flexible scenario loading.

get_builtin_scenarios() cached

Retrieve all builtin scenario definitions from the scenarios directory.

Scans the scenarios directory for JSON files and returns a mapping of scenario names to their file paths. Each scenario is indexed by both its stem name (filename without extension) and full filename for convenient lookup.

Returns:

Type Description
dict[str, Path]

Dictionary mapping scenario names and filenames to their Path objects
Source code in src/guidellm/benchmark/scenarios/__init__.py 
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
@cache
def get_builtin_scenarios() -> dict[str, Path]:
    """
    Retrieve all builtin scenario definitions from the scenarios directory.

    Scans the scenarios directory for JSON files and returns a mapping of scenario
    names to their file paths. Each scenario is indexed by both its stem name
    (filename without extension) and full filename for convenient lookup.

    :return: Dictionary mapping scenario names and filenames to their Path objects
    """
    builtin = {}
    for path in SCENARIO_DIR.glob("*.json"):
        builtin[path.stem] = path
        builtin[path.name] = path

    return builtin