ai-edge-quantizer-nightly 0.5.0.dev20260203__py3-none-any.whl → 0.5.0.dev20260204__py3-none-any.whl

ai_edge_quantizer/utils/progress_utils.py

@@ -0,0 +1,96 @@
+# Copyright 2024 The AI Edge Quantizer Authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# ==============================================================================
+
+"""Utility functions to display a progress bar and progress report."""
+
+import time
+import tracemalloc
+import tqdm
+
+
+class ProgressBar:
+  """A Progress Bar that can be used to track the progress of a process."""
+
+  def __init__(
+      self,
+      total_steps: int,
+      description: str = '',
+      disappear_on_finish: bool = False,
+      disable: bool = False,
+  ):
+    self._progress_bar = tqdm.tqdm(
+        total=total_steps,
+        desc=description,
+        leave=not disappear_on_finish,
+        disable=disable,
+    )
+
+  def __enter__(self):
+    """Enters the context manager."""
+    return self
+
+  def __exit__(self, exc_type, exc_value, traceback):
+    """Exits the context manager and closes the progress bar."""
+    self.close()
+
+  def update_single_step(self):
+    """Updates the progress bar by a single step."""
+    self._progress_bar.update(1)
+
+  def close(self):
+    """Closes the progress bar."""
+    self._progress_bar.close()
+
+
+class ProgressReport:
+  """A class to generate a progress report for the quantization process."""
+
+  def __init__(self, description: str = ''):
+    self._description = description
+    self._start_time = None
+
+  def capture_progess_start(self):
+    self._start_time = time.time()
+    tracemalloc.start()
+
+  def render_report(
+      self,
+      original_size: int,
+      quantized_size: int,
+      quantization_ratio: float,
+      memory_peak: float,
+      total_time: float,
+  ):
+    """Prints out the progress report."""
+    print(f'Original model size: {original_size/1024:.2f} KB')
+    print(f'Quantized model size: {quantized_size/1024:.2f} KB')
+    print(f'Quantization Ratio: {quantization_ratio:.2f}')
+    print(f'Total time: {total_time:.2f} seconds')
+    print(f'Memory peak: {memory_peak:.2f} MB')
+
+  def generate_progress_report(self, original_model, quantized_model):
+    original_size = len(original_model)
+    quantized_size = len(quantized_model)
+    quantization_ratio = quantized_size / original_size
+    total_time = time.time() - self._start_time
+    _, mem_peak_bytes = tracemalloc.get_traced_memory()
+    mem_peak_mb = mem_peak_bytes / 1024 / 1024
+    self.render_report(
+        original_size,
+        quantized_size,
+        quantization_ratio,
+        mem_peak_mb,
+        total_time,
+    )

ai_edge_quantizer/utils/progress_utils_test.py

@@ -0,0 +1,105 @@
+# Copyright 2024 The AI Edge Quantizer Authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# ==============================================================================
+
+import io
+import sys
+import time
+import tracemalloc
+from unittest import mock
+
+from tensorflow.python.platform import googletest
+from ai_edge_quantizer.utils import progress_utils
+
+
+class ProgressBarTest(googletest.TestCase):
+
+  @mock.patch('tqdm.tqdm')
+  def test_progress_bar_update(self, mock_tqdm):
+    mock_progress_bar_instance = mock_tqdm.return_value
+    with progress_utils.ProgressBar(total_steps=10) as pb:
+      pb.update_single_step()
+      pb.update_single_step()
+
+    mock_tqdm.assert_called_once_with(
+        total=10, desc='', leave=True, disable=False
+    )
+    self.assertEqual(mock_progress_bar_instance.update.call_count, 2)
+    mock_progress_bar_instance.update.assert_called_with(1)
+    mock_progress_bar_instance.close.assert_called_once()
+
+  @mock.patch('tqdm.tqdm')
+  def test_progress_bar_disable(self, mock_tqdm):
+    mock_progress_bar_instance = mock_tqdm.return_value
+    with progress_utils.ProgressBar(total_steps=10, disable=True):
+      pass
+    mock_tqdm.assert_called_once_with(
+        total=10, desc='', leave=True, disable=True
+    )
+    mock_progress_bar_instance.close.assert_called_once()
+
+  @mock.patch('tqdm.tqdm')
+  def test_progress_bar_disappear_on_finish(self, mock_tqdm):
+    mock_progress_bar_instance = mock_tqdm.return_value
+    with progress_utils.ProgressBar(total_steps=10, disappear_on_finish=True):
+      pass
+    mock_tqdm.assert_called_once_with(
+        total=10, desc='', leave=False, disable=False
+    )
+    mock_progress_bar_instance.close.assert_called_once()
+
+
+class ProgressReportTest(googletest.TestCase):
+
+  def setUp(self):
+    super().setUp()
+    self.mock_time = self.enter_context(
+        mock.patch.object(time, 'time', autospec=True)
+    )
+    self.mock_tracemalloc_start = self.enter_context(
+        mock.patch.object(tracemalloc, 'start', autospec=True)
+    )
+    self.mock_tracemalloc_get_traced_memory = self.enter_context(
+        mock.patch.object(tracemalloc, 'get_traced_memory', autospec=True)
+    )
+
+  def test_generate_progress_report(self):
+    self.mock_time.side_effect = [100.0, 105.5]  # Start time, end time.
+    # Mock memory: current=1MB, peak=2MB.
+    self.mock_tracemalloc_get_traced_memory.return_value = (
+        1 * 1024 * 1024,
+        2 * 1024 * 1024,
+    )
+
+    progress_report = progress_utils.ProgressReport()
+    progress_report.capture_progess_start()
+
+    original_model = b'\x01' * 2048  # 2KB.
+    quantized_model = b'\x02' * 1024  # 1KB
+
+    mock_stdout = io.StringIO()
+    with mock.patch.object(sys, 'stdout', mock_stdout):
+      progress_report.generate_progress_report(original_model, quantized_model)
+
+    self.mock_tracemalloc_start.assert_called_once()
+    output = mock_stdout.getvalue()
+    self.assertIn('Original model size: 2.00 KB', output)
+    self.assertIn('Quantized model size: 1.00 KB', output)
+    self.assertIn('Quantization Ratio: 0.50', output)
+    self.assertIn('Total time: 5.50 seconds', output)
+    self.assertIn('Memory peak: 2.00 MB', output)
+
+
+if __name__ == '__main__':
+  googletest.main()

{ai_edge_quantizer_nightly-0.5.0.dev20260203.dist-info → ai_edge_quantizer_nightly-0.5.0.dev20260204.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ai-edge-quantizer-nightly
-Version: 0.5.0.dev20260203
+Version: 0.5.0.dev20260204
 Summary: A quantizer for advanced developers to quantize converted AI Edge models.
 Home-page: https://github.com/google-ai-edge/ai-edge-quantizer
 Keywords: On-Device ML,AI,Google,TFLite,Quantization,LLMs,GenAI

{ai_edge_quantizer_nightly-0.5.0.dev20260203.dist-info → ai_edge_quantizer_nightly-0.5.0.dev20260204.dist-info}/RECORD

@@ -67,6 +67,8 @@ ai_edge_quantizer/utils/calibration_utils.py,sha256=dFDsjc3CXaDFNbCMyoPrMVubd3ED
 ai_edge_quantizer/utils/calibration_utils_test.py,sha256=jod4iokZkG00y9JrYaFzVvg4JwiA6mX8_whAMkNyoEc,9334
 ai_edge_quantizer/utils/constrained_ops_utils.py,sha256=z0sm1R9anRRVgdgI23XQKwDRcdARdpTo_6UBDB_lHXE,4502
 ai_edge_quantizer/utils/constrained_ops_utils_test.py,sha256=zmMIAS1WIvYK1Z9ZMMxYovIGtxfek-jvfZqrois1ahE,1756
+ai_edge_quantizer/utils/progress_utils.py,sha256=itgRhA5Gcu0xsPjFzAsZhNfOxa2KB8Dc0a_ysQ9DCac,2940
+ai_edge_quantizer/utils/progress_utils_test.py,sha256=t8O8kGRerq9pXGylROHI9YyAgA7KEAKwDrj8G0CBs88,3709
 ai_edge_quantizer/utils/test_utils.py,sha256=a4Nk-wbeB09dFjTDZiA0K67d26j5DD0UDH_GIVmVG_4,8685
 ai_edge_quantizer/utils/tfl_flatbuffer_utils.py,sha256=3mngikx_lF-qKBc5KxGX-5kELH_XGKpeGjwUyR5dfZI,12167
 ai_edge_quantizer/utils/tfl_flatbuffer_utils_test.py,sha256=K1SbK8q92qYVtiVj0I0GtugsPTkpIpEKv9zakvFV_Sc,8555
@@ -74,8 +76,8 @@ ai_edge_quantizer/utils/tfl_interpreter_utils.py,sha256=ptdlC3WVUE9aBznT7kZQ0ZOk
 ai_edge_quantizer/utils/tfl_interpreter_utils_test.py,sha256=EPOXbmXqbt3tAewo3BQQjh2mjuxrrFit5tkF0wUVYHU,12471
 ai_edge_quantizer/utils/validation_utils.py,sha256=Mr0D6X-pTDLODFAnCX3IlqdV1OL02tlq0ZjHbqx8nzg,7439
 ai_edge_quantizer/utils/validation_utils_test.py,sha256=T8K5mCWeMcihND2KS_dHvCJUU9lEdG2sD95EgPkaX3w,5584
-ai_edge_quantizer_nightly-0.5.0.dev20260203.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-ai_edge_quantizer_nightly-0.5.0.dev20260203.dist-info/METADATA,sha256=w9CInW8S9Tj3DUcUaidtrO-x_JAYqEzJIZ560cdXLAU,1731
-ai_edge_quantizer_nightly-0.5.0.dev20260203.dist-info/WHEEL,sha256=SmOxYU7pzNKBqASvQJ7DjX3XGUF92lrGhMb3R6_iiqI,91
-ai_edge_quantizer_nightly-0.5.0.dev20260203.dist-info/top_level.txt,sha256=8QTfPnFXNVUhScFLaa-NWZMFWMn72M50DVPubpwWB1g,18
-ai_edge_quantizer_nightly-0.5.0.dev20260203.dist-info/RECORD,,
+ai_edge_quantizer_nightly-0.5.0.dev20260204.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+ai_edge_quantizer_nightly-0.5.0.dev20260204.dist-info/METADATA,sha256=zJ0WvuCMyRufJW7Z3j8zDGAhNd-y-bWvpbrjJIxw-Kg,1731
+ai_edge_quantizer_nightly-0.5.0.dev20260204.dist-info/WHEEL,sha256=SmOxYU7pzNKBqASvQJ7DjX3XGUF92lrGhMb3R6_iiqI,91
+ai_edge_quantizer_nightly-0.5.0.dev20260204.dist-info/top_level.txt,sha256=8QTfPnFXNVUhScFLaa-NWZMFWMn72M50DVPubpwWB1g,18
+ai_edge_quantizer_nightly-0.5.0.dev20260204.dist-info/RECORD,,