pyglove 0.5.0.dev202510010810__py3-none-any.whl → 0.5.0.dev202510030810__py3-none-any.whl

pyglove/core/monitoring.py

@@ -19,11 +19,13 @@ programs.
 
 import abc
 import collections
+import contextlib
 import math
 import threading
+import time
 import typing
-from typing import Any, Callable, Dict, List, Optional, Tuple, Type, Union
-
+from typing import Any, Callable, Dict, Iterator, List, Optional, Tuple, Type, Union
+from pyglove.core.utils import error_utils
 
 try:
   import numpy  # pylint: disable=g-import-not-at-top
@@ -194,6 +196,38 @@ class Scalar(Metric):
       The distribution of the scalar.
     """
 
+  @contextlib.contextmanager
+  def record_duration(
+      self,
+      *,
+      scale: int = 1000,
+      error_parameter: str = 'error',
+      **parameters) -> Iterator[None]:
+    """Context manager that records the duration of code block to the scalar.
+
+    Args:
+      scale: The scale of the duration.
+      error_parameter: The parameter name for recording the error. If the name
+        is not defined as a parameter for the scalar, the error tag will not be
+        recorded.
+      **parameters: Parameters for parameterized scalars.
+    """
+    start_time = time.time()
+    error = None
+    try:
+      yield
+    except BaseException as e:
+      error = e
+      raise e
+    finally:
+      duration = (time.time() - start_time) * scale
+      if error_parameter in self._parameter_definitions:
+        parameters[error_parameter] = (
+            error_utils.ErrorInfo.from_exception(error).tag
+            if error is not None else ''
+        )
+      self.record(int(duration), **parameters)
+
 
 class MetricCollection(metaclass=abc.ABCMeta):
   """Base class for counter collections."""

pyglove/core/monitoring_test.py

@@ -12,8 +12,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+import time
 import unittest
 from pyglove.core import monitoring
+from pyglove.core.symbolic import error_info  # pylint: disable=unused-import
 
 
 class MetricCollectionTest(unittest.TestCase):
@@ -205,6 +207,11 @@ class InMemoryScalarTest(unittest.TestCase):
     scalar.distribution()
     self.assertEqual(dist.count, 3)
 
+    scalar = collection.get_scalar('scalar2', 'scalar description')
+    with scalar.record_duration():
+      time.sleep(0.1)
+    self.assertGreaterEqual(scalar.distribution().mean, 100)
+
   def test_scalar_with_parameters(self):
     collection = monitoring.InMemoryMetricCollection('/test')
     scalar = collection.get_scalar(
@@ -225,6 +232,18 @@ class InMemoryScalarTest(unittest.TestCase):
     dist = scalar.distribution(field1='bar')
     self.assertEqual(dist.count, 1)
 
+    scalar = collection.get_scalar(
+        'scalar2', 'scalar description', {'error': str}
+    )
+    with self.assertRaises(ValueError):
+      with scalar.record_duration():
+        time.sleep(0.1)
+        raise ValueError()
+    self.assertGreaterEqual(scalar.distribution(error='ValueError').mean, 100)
+    with scalar.record_duration():
+      time.sleep(0.1)
+    self.assertGreaterEqual(scalar.distribution(error='').mean, 100)
+
 
 if __name__ == '__main__':
   unittest.main()

{pyglove-0.5.0.dev202510010810.dist-info → pyglove-0.5.0.dev202510030810.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyglove
-Version: 0.5.0.dev202510010810
+Version: 0.5.0.dev202510030810
 Summary: PyGlove: A library for manipulating Python objects.
 Home-page: https://github.com/google/pyglove
 Author: PyGlove Authors

{pyglove-0.5.0.dev202510010810.dist-info → pyglove-0.5.0.dev202510030810.dist-info}/RECORD

@@ -2,8 +2,8 @@ pyglove/__init__.py,sha256=LP1HNk_VVWMHaakX3HZ0NeZ2c4lq2uJaRbalvT8haOg,1352
 pyglove/core/__init__.py,sha256=WPTvhQXv63f4-AkYH__RwVKQyr8vHr5e3tGqT2OxRGM,9774
 pyglove/core/logging.py,sha256=zTNLGnWrl6kkjjEjTphQMeNf9FfqFtl1G9VCh2LhnHg,4614
 pyglove/core/logging_test.py,sha256=ioDbmf4S6xQXeyGWihvk6292wfYdldBw_TK1WXvIq5k,1648
-pyglove/core/monitoring.py,sha256=6QWbnCBC9HOc6_lnPmoDi-JTsusNwlXz4_LPnwWjjsw,15143
-pyglove/core/monitoring_test.py,sha256=47zjsNiYEMKOOdYpUue7_BPJYi1z9eJN_t6cw65TB-4,8558
+pyglove/core/monitoring.py,sha256=RRA-pOne-UuMi6oSMB-z0_N-NRw7cB9qaDfEvElnmug,16221
+pyglove/core/monitoring_test.py,sha256=8QwmpYgKlxxQNAUWsqZMNCurtwcpMyBJGDj_dPINJBU,9267
 pyglove/core/coding/__init__.py,sha256=tuHIg19ZchtkOQbdFVTVLkUpBa5f1eo66XtnKw3lcIU,1645
 pyglove/core/coding/errors.py,sha256=aP3Y4amBzOKdlb5JnESJ3kdoijQXbiBiPDMeA88LNrk,3310
 pyglove/core/coding/errors_test.py,sha256=fwOR8vLiRvLadubsccyE19hLHj-kThlCQt88qmUYk9M,2311
@@ -218,8 +218,8 @@ pyglove/ext/scalars/randoms.py,sha256=LkMIIx7lOq_lvJvVS3BrgWGuWl7Pi91-lA-O8x_gZs
 pyglove/ext/scalars/randoms_test.py,sha256=nEhiqarg8l_5EOucp59CYrpO2uKxS1pe0hmBdZUzRNM,2000
 pyglove/ext/scalars/step_wise.py,sha256=IDw3tuTpv0KVh7AN44W43zqm1-E0HWPUlytWOQC9w3Y,3789
 pyglove/ext/scalars/step_wise_test.py,sha256=TL1vJ19xVx2t5HKuyIzGoogF7N3Rm8YhLE6JF7i0iy8,2540
-pyglove-0.5.0.dev202510010810.dist-info/licenses/LICENSE,sha256=WNHhf_5RCaeuKWyq_K39vmp9F28LxKsB4SpomwSZ2L0,11357
-pyglove-0.5.0.dev202510010810.dist-info/METADATA,sha256=owYy54yQlinPA3GYlyO2yfqxgmsfsUzFdFjXMNaIVX4,7089
-pyglove-0.5.0.dev202510010810.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-pyglove-0.5.0.dev202510010810.dist-info/top_level.txt,sha256=wITzJSKcj8GZUkbq-MvUQnFadkiuAv_qv5qQMw0fIow,8
-pyglove-0.5.0.dev202510010810.dist-info/RECORD,,
+pyglove-0.5.0.dev202510030810.dist-info/licenses/LICENSE,sha256=WNHhf_5RCaeuKWyq_K39vmp9F28LxKsB4SpomwSZ2L0,11357
+pyglove-0.5.0.dev202510030810.dist-info/METADATA,sha256=XK5-HtxQBDSCT-wGE07SOGTvQ5eNtCqW-HTgzeD-2Ik,7089
+pyglove-0.5.0.dev202510030810.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+pyglove-0.5.0.dev202510030810.dist-info/top_level.txt,sha256=wITzJSKcj8GZUkbq-MvUQnFadkiuAv_qv5qQMw0fIow,8
+pyglove-0.5.0.dev202510030810.dist-info/RECORD,,