fix a small bug in stats unit

genai-perf/genai_perf/metrics/statistics.py

@@ -122,7 +122,7 @@ def _scale(self, metric: float, factor: float) -> float:
     def _add_units(self, key) -> None:
         if self._is_time_metric(key):
             self._stats_dict[key]["unit"] = "ms"
-        elif key == "request_throughput" or "request_goodput":
+        elif key in ["request_throughput", "request_goodput"]:
             self._stats_dict[key]["unit"] = "requests/sec"
         elif key == "image_throughput":
             self._stats_dict[key]["unit"] = "pages/sec"

genai-perf/tests/test_statistics.py

@@ -0,0 +1,82 @@
+# Copyright 2024, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions
+# are met:
+#  * Redistributions of source code must retain the above copyright
+#    notice, this list of conditions and the following disclaimer.
+#  * Redistributions in binary form must reproduce the above copyright
+#    notice, this list of conditions and the following disclaimer in the
+#    documentation and/or other materials provided with the distribution.
+#  * Neither the name of NVIDIA CORPORATION nor the names of its
+#    contributors may be used to endorse or promote products derived
+#    from this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY
+# EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+# OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+from genai_perf.metrics import ImageRetrievalMetrics, LLMMetrics, Metrics, Statistics
+
+
+class TestStatistics:
+
+    def test_base_metric_units(self):
+        metrics = Metrics(
+            request_throughputs=[1, 2, 3],
+            request_latencies=[4, 5, 6],
+            request_goodputs=[7, 8, 9],
+        )
+
+        stats = Statistics(metrics=metrics).stats_dict
+        assert stats["request_throughput"]["unit"] == "requests/sec"
+        assert stats["request_latency"]["unit"] == "ms"
+        assert stats["request_goodput"]["unit"] == "requests/sec"
+
+    def test_llm_metric_units(self):
+        metrics = LLMMetrics(
+            request_throughputs=[1, 2, 3],
+            request_latencies=[4, 5, 6],
+            time_to_first_tokens=[7, 8, 9],
+            inter_token_latencies=[1, 2, 3],
+            output_token_throughputs=[4, 5, 6],
+            output_token_throughputs_per_request=[7, 8, 9],
+            output_sequence_lengths=[1, 2, 3],
+            input_sequence_lengths=[4, 5, 6],
+            request_goodputs=[7, 8, 9],
+        )
+
+        stats = Statistics(metrics=metrics).stats_dict
+        assert stats["request_throughput"]["unit"] == "requests/sec"
+        assert stats["request_latency"]["unit"] == "ms"
+        assert stats["time_to_first_token"]["unit"] == "ms"
+        assert stats["inter_token_latency"]["unit"] == "ms"
+        assert stats["output_token_throughput"]["unit"] == "tokens/sec"
+        assert stats["output_token_throughput_per_request"]["unit"] == "tokens/sec"
+        assert stats["output_sequence_length"]["unit"] == "tokens"
+        assert stats["input_sequence_length"]["unit"] == "tokens"
+        assert stats["request_goodput"]["unit"] == "requests/sec"
+
+    def test_image_retriever_metric_units(self):
+        metrics = ImageRetrievalMetrics(
+            request_throughputs=[1, 2, 3],
+            request_latencies=[4, 5, 6],
+            image_throughputs=[7, 8, 9],
+            image_latencies=[1, 2, 3],
+            request_goodputs=[4, 5, 6],
+        )
+
+        stats = Statistics(metrics=metrics).stats_dict
+        assert stats["request_throughput"]["unit"] == "requests/sec"
+        assert stats["request_latency"]["unit"] == "ms"
+        assert stats["image_throughput"]["unit"] == "pages/sec"
+        assert stats["image_latency"]["unit"] == "ms"
+        assert stats["request_goodput"]["unit"] == "requests/sec"