Update documentation for custom metrics API arguments

pytorch · Aug 11, 2023 · f5bcf4e · f5bcf4e
1 parent 4db3328
commit f5bcf4e
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 12 deletions.
diff --git a/ts/metrics/caching_metric.py b/ts/metrics/caching_metric.py
@@ -58,7 +58,7 @@ def _validate_and_get_dimensions(
             values corresponding to the metrics dimension names
         Returns
         -------
-        list of dimension objects or ValueError
+        list of Dimension objects or ValueError
         """
         if dimension_values is None or len(dimension_values) != len(
             self.dimension_names
@@ -157,7 +157,7 @@ def update(
         request_id : str
             request id to be associated with the metric
         dimensions : list
-            list of dimension objects
+            list of Dimension objects
         """
         logger.warning("Overriding existing dimensions")
         self.dimension_names = [dim.name for dim in dimensions]

diff --git a/ts/metrics/metric.py b/ts/metrics/metric.py
@@ -5,9 +5,9 @@
 import time
 from builtins import str
 from collections import OrderedDict
+
 from ts.metrics.caching_metric import CachingMetric
 from ts.metrics.metric_type_enum import MetricTypes
-
 from ts.metrics.unit import Units
 
 MetricUnit = Units()
@@ -41,7 +41,7 @@ def __init__(
         unit: str
             unit can be one of ms, percent, count, MB, GB or a generic string
         dimensions: list
-            list of dimension objects
+            list of Dimension objects
         request_id: str
             req_id of metric
         metric_method: str
@@ -73,13 +73,17 @@ def update(self, value):
         value : int, float
             metric to be updated
         """
-        self._caching_metric.add_or_update(value, self.dimension_values, request_id=self.request_id)
+        self._caching_metric.add_or_update(
+            value, self.dimension_values, request_id=self.request_id
+        )
 
     def reset(self):
         """
         Reset Metric value to 0
         """
-        self._caching_metric.add_or_update(0, self.dimension_values, request_id=self.request_id)
+        self._caching_metric.add_or_update(
+            0, self.dimension_values, request_id=self.request_id
+        )
 
     def __str__(self):
         dims = ",".join([str(d) for d in self.dimensions])

diff --git a/ts/metrics/metric_cache_abstract.py b/ts/metrics/metric_cache_abstract.py
@@ -94,7 +94,7 @@ def add_metric(
         idx: str
             request id to be associated with the metric
         dimensions: list
-            list of dimension objects for the metric
+            list of Dimension objects for the metric
         metric_type MetricTypes
             Type of metric Counter, Gauge, Histogram
         """
@@ -122,7 +122,7 @@ def add_counter(
         idx: str
             request id to be associated with the metric
         dimensions: list
-            list of dimension objects for the metric
+            list of Dimension objects for the metric
         """
         req_id = self._get_req(idx)
         dimensions = self._add_default_dims(req_id, dimensions)
@@ -153,7 +153,7 @@ def add_time(
         unit: str
             unit of metric,  default here is ms, s is also accepted
         dimensions: list
-            list of dimension objects for the metric
+            list of Dimension objects for the metric
         metric_type MetricTypes
             Type of metric Counter, Gauge, Histogram
         """
@@ -190,7 +190,7 @@ def add_size(
         unit: str
             unit of metric, default here is 'MB', 'kB', 'GB' also supported
         dimensions: list
-            list of dimension objects for the metric
+            list of Dimension objects for the metric
         metric_type MetricTypes
             Type of metric Counter, Gauge, Histogram
         """
@@ -224,7 +224,7 @@ def add_percent(
         idx: str
             request id to be associated with the metric
         dimensions: list
-            list of dimension objects for the metric
+            list of Dimension objects for the metric
         metric_type MetricTypes
             Type of metric Counter, Gauge, Histogram
         """
@@ -250,7 +250,7 @@ def add_error(
         value: int or float
             value of the metric
         dimensions: list
-            list of dimension objects for the metric
+            list of Dimension objects for the metric
         """
         dimensions = self._add_default_dims(None, dimensions)
         metric = self._get_or_add_metric(name, "", dimensions, MetricTypes.COUNTER)