add custom dict camelize logic (#246)

This removes reliance on the library pyhumps converting dicts keys from
snake_case to camelCase for use in the UI

---------

Signed-off-by: dalthecow <[email protected]>
Signed-off-by: Samuel Monson <[email protected]>
Signed-off-by: Jared O'Connell <[email protected]>
Co-authored-by: Samuel Monson <[email protected]>
Co-authored-by: Jared O'Connell <[email protected]>

Author: 3 people

src/guidellm/benchmark/output.py

@@ -5,6 +5,7 @@
 import math
 from abc import ABC, abstractmethod
 from collections import OrderedDict
+from copy import deepcopy
 from datetime import datetime
 from pathlib import Path
 from typing import Any, ClassVar
@@ -36,6 +37,8 @@
     safe_format_timestamp,
     split_text_list_by_length,
 )
+from guidellm.utils.dict import recursive_key_update
+from guidellm.utils.text import camelize_str
 
 __all__ = [
     "GenerativeBenchmarkerCSV",
@@ -711,22 +714,20 @@ async def finalize(self, report: GenerativeBenchmarksReport) -> Path:
         :param report: The completed benchmark report.
         :return: Path to the saved HTML file.
         """
-        import humps
-
         output_path = self.output_path
         if output_path.is_dir():
             output_path = output_path / GenerativeBenchmarkerHTML.DEFAULT_FILE
         output_path.parent.mkdir(parents=True, exist_ok=True)
 
         data_builder = UIDataBuilder(report.benchmarks)
         data = data_builder.to_dict()
-        camel_data = humps.camelize(data)
+        camel_data = recursive_key_update(deepcopy(data), camelize_str)
 
         ui_api_data = {}
-        for key, value in camel_data.items():
-            placeholder_key = f"window.{key} = {{}};"
+        for k, v in camel_data.items():
+            placeholder_key = f"window.{k} = {{}};"
             replacement_value = (
-                f"window.{key} = {json.dumps(value, indent=2)};\n"
+                f"window.{k} = {json.dumps(v, indent=2)};\n"
             )
             ui_api_data[placeholder_key] = replacement_value
 

src/guidellm/utils/__init__.py

@@ -1,6 +1,7 @@
 from .auto_importer import AutoImporterMixin
 from .console import Colors, Console, ConsoleUpdateStep, StatusIcons, StatusStyles
 from .default_group import DefaultGroupHandler
+from .dict import recursive_key_update
 from .encoding import (
     Encoder,
     EncodingTypesAlias,
@@ -55,6 +56,7 @@
 )
 from .text import (
     EndlessTextCreator,
+    camelize_str,
     clean_text,
     filter_text,
     format_value_display,
@@ -79,6 +81,7 @@
     "EndlessTextCreator",
     "InfoMixin",
     "IntegerRangeSampler",
+    "camelize_str",
     "InterProcessMessaging",
     "InterProcessMessagingManagerQueue",
     "InterProcessMessagingPipe",
@@ -110,6 +113,7 @@
     "format_value_display",
     "get_literal_vals",
     "is_punctuation",
+    "recursive_key_update",
     "load_text",
     "safe_add",
     "safe_divide",

src/guidellm/utils/dict.py

@@ -0,0 +1,23 @@
+def recursive_key_update(d, key_update_func):
+    if not isinstance(d, dict) and not isinstance(d, list):
+        return d
+
+    if isinstance(d, list):
+        for item in d:
+            recursive_key_update(item, key_update_func)
+        return d
+
+    updated_key_pairs = []
+    for key, _ in d.items():
+        updated_key = key_update_func(key)
+        if key != updated_key:
+            updated_key_pairs.append((key, updated_key))
+
+    for key_pair in updated_key_pairs:
+        old_key, updated_key = key_pair
+        d[updated_key] = d[old_key]
+        del d[old_key]
+
+    for _, value in d.items():
+        recursive_key_update(value, key_update_func)
+    return d

src/guidellm/utils/text.py

@@ -28,6 +28,7 @@
 __all__ = [
     "MAX_PATH_LENGTH",
     "EndlessTextCreator",
+    "camelize_str",
     "clean_text",
     "filter_text",
     "format_value_display",
@@ -281,6 +282,12 @@ def is_punctuation(text: str) -> bool:
     return len(text) == 1 and not text.isalnum() and not text.isspace()
 
 
+def camelize_str(snake_case_string: str) -> str:
+    return (words := snake_case_string.split("_"))[0].lower() + "".join(
+        word.capitalize() for word in words[1:]
+    )
+
+
 class EndlessTextCreator:
     """
     Infinite text generator for load testing and content creation operations.

tests/unit/utils/dict.py

@@ -0,0 +1,71 @@
+import pytest
+
+from guidellm.utils.dict import recursive_key_update
+
+
+def update_str(string):
+    return string + "_updated"
+
+
+@pytest.mark.smoke
+def test_recursive_key_update_updates_keys():
+    my_dict = {
+        "my_key": {
+            "my_nested_key": {"my_double_nested_key": "someValue"},
+            "my_other_nested_key": "someValue",
+        },
+        "my_other_key": "value",
+    }
+    my_updated_dict = {
+        "my_key_updated": {
+            "my_nested_key_updated": {"my_double_nested_key_updated": "someValue"},
+            "my_other_nested_key_updated": "someValue",
+        },
+        "my_other_key_updated": "value",
+    }
+    recursive_key_update(my_dict, update_str)
+    assert my_dict == my_updated_dict
+
+
+def truncate_str_to_ten(string):
+    return string[:10]
+
+
+@pytest.mark.smoke
+def test_recursive_key_update_leaves_unchanged_keys():
+    my_dict = {
+        "my_key": {
+            "my_nested_key": {"my_double_nested_key": "someValue"},
+            "my_other_nested_key": "someValue",
+        },
+        "my_other_key": "value",
+    }
+    my_updated_dict = {
+        "my_key": {
+            "my_nested_": {"my_double_": "someValue"},
+            "my_other_n": "someValue",
+        },
+        "my_other_k": "value",
+    }
+    recursive_key_update(my_dict, truncate_str_to_ten)
+    assert my_dict == my_updated_dict
+
+
+@pytest.mark.smoke
+def test_recursive_key_update_updates_dicts_in_list():
+    my_dict = {
+        "my_key": [
+            {"my_list_item_key_1": "someValue"},
+            {"my_list_item_key_2": "someValue"},
+            {"my_list_item_key_3": "someValue"},
+        ]
+    }
+    my_updated_dict = {
+        "my_key_updated": [
+            {"my_list_item_key_1_updated": "someValue"},
+            {"my_list_item_key_2_updated": "someValue"},
+            {"my_list_item_key_3_updated": "someValue"},
+        ]
+    }
+    recursive_key_update(my_dict, update_str)
+    assert my_dict == my_updated_dict

tests/unit/utils/text.py

@@ -0,0 +1,13 @@
+import pytest
+
+from guidellm.utils.text import camelize_str
+
+
+@pytest.mark.smoke
+def test_camelize_str_camelizes_string():
+    assert camelize_str("no_longer_snake_case") == "noLongerSnakeCase"
+
+
+@pytest.mark.smoke
+def test_camelize_str_leaves_non_snake_case_text_untouched():
+    assert camelize_str("notsnakecase") == "notsnakecase"