Add a metadata section to the benchmark report

Signed-off-by: Samuel Monson <smonson@redhat.com>

Author: sjmonson

src/guidellm/benchmark/__init__.py

@@ -39,6 +39,7 @@
     GenerativeAudioMetricsSummary,
     GenerativeBenchmark,
     GenerativeBenchmarkAccumulator,
+    GenerativeBenchmarkMetadata,
     GenerativeBenchmarksReport,
     GenerativeBenchmarkTimings,
     GenerativeImageMetricsSummary,
@@ -67,6 +68,7 @@
     "GenerativeAudioMetricsSummary",
     "GenerativeBenchmark",
     "GenerativeBenchmarkAccumulator",
+    "GenerativeBenchmarkMetadata",
     "GenerativeBenchmarkTimings",
     "GenerativeBenchmarkerCSV",
     "GenerativeBenchmarkerConsole",

src/guidellm/benchmark/schemas/__init__.py

@@ -25,6 +25,7 @@
     GenerativeAudioMetricsSummary,
     GenerativeBenchmark,
     GenerativeBenchmarkAccumulator,
+    GenerativeBenchmarkMetadata,
     GenerativeBenchmarksReport,
     GenerativeBenchmarkTimings,
     GenerativeImageMetricsSummary,
@@ -49,6 +50,7 @@
     "GenerativeAudioMetricsSummary",
     "GenerativeBenchmark",
     "GenerativeBenchmarkAccumulator",
+    "GenerativeBenchmarkMetadata",
     "GenerativeBenchmarkTimings",
     "GenerativeBenchmarksReport",
     "GenerativeImageMetricsSummary",

src/guidellm/benchmark/schemas/generative/__init__.py

@@ -32,13 +32,14 @@
     GenerativeVideoMetricsSummary,
     SchedulerMetrics,
 )
-from .report import GenerativeBenchmarksReport
+from .report import GenerativeBenchmarkMetadata, GenerativeBenchmarksReport
 
 __all__ = [
     "BenchmarkGenerativeTextArgs",
     "GenerativeAudioMetricsSummary",
     "GenerativeBenchmark",
     "GenerativeBenchmarkAccumulator",
+    "GenerativeBenchmarkMetadata",
     "GenerativeBenchmarkTimings",
     "GenerativeBenchmarksReport",
     "GenerativeImageMetricsSummary",

src/guidellm/benchmark/schemas/generative/report.py

@@ -11,6 +11,8 @@
 from __future__ import annotations
 
 import json
+import platform
+from importlib.metadata import version
 from pathlib import Path
 from typing import ClassVar, Literal
 
@@ -23,7 +25,30 @@
 )
 from guidellm.schemas import StandardBaseModel
 
-__all__ = ["GenerativeBenchmarksReport"]
+__all__ = ["GenerativeBenchmarkMetadata", "GenerativeBenchmarksReport"]
+
+
+class GenerativeBenchmarkMetadata(StandardBaseModel):
+    """
+    Versioning and environment metadata for generative benchmark reports.
+    """
+
+    version: Literal[1] = Field(
+        description="Version of the benchmark report schema",
+        default=1,
+    )
+    guidellm_version: str = Field(
+        description="Version of the guidellm package used for the benchmark",
+        default_factory=lambda: version("guidellm"),
+    )
+    python_version: str = Field(
+        description="Version of Python interpreter used during the benchmark",
+        default_factory=lambda: platform.python_version(),
+    )
+    platform: str = Field(
+        description="Operating system platform where the benchmark was executed",
+        default_factory=lambda: platform.platform(),
+    )
 
 
 class GenerativeBenchmarksReport(StandardBaseModel):
@@ -40,6 +65,10 @@ class GenerativeBenchmarksReport(StandardBaseModel):
 
     DEFAULT_FILE: ClassVar[str] = "benchmarks.json"
 
+    metadata: GenerativeBenchmarkMetadata = Field(
+        description="Metadata about the benchmark report and execution environment",
+        default_factory=GenerativeBenchmarkMetadata,
+    )
     args: BenchmarkGenerativeTextArgs = Field(
         description="Benchmark arguments used for all benchmarks in the report"
     )