ai-edge-torch-nightly 0.3.0.dev20250114__py3-none-any.whl

ai_edge_torch/quantize/quant_config.py

@@ -0,0 +1,85 @@
+# Copyright 2024 The AI Edge Torch Authors. All Rights Reserved.
+#
+# 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 dataclasses
+import enum
+from typing import Optional
+
+from ai_edge_torch.generative.quantize import quant_recipe
+from ai_edge_torch.quantize import pt2e_quantizer as pt2eq
+
+
+@dataclasses.dataclass(frozen=True)
+class QuantConfig:
+  """Encapsulates a quantization configuration.
+
+  Encapsulates all different quantization methods and schemes available for
+  models converted with ai_edge_torch.
+
+  Attributes:
+    pt2e_quantizer: The instance of PT2EQuantizer used to quantize the model
+      with PT2E quantization. This method of quantization is not applicable to
+      models created with the Edge Generative API.
+    generative_recipe: Quantization recipe to be applied on a model created with
+      the Edge Generative API.
+  """
+
+  pt2e_quantizer: pt2eq.PT2EQuantizer = None
+  generative_recipe: quant_recipe.GenerativeQuantRecipe = None
+
+  @enum.unique
+  class _QuantizerMode(enum.Enum):
+    NONE = enum.auto()
+    PT2E_DYNAMIC = enum.auto()
+    PT2E_STATIC = enum.auto()
+    AI_EDGE_QUANTIZER = enum.auto()
+
+  _quantizer_mode: _QuantizerMode = _QuantizerMode.NONE
+
+  def __init__(
+      self,
+      pt2e_quantizer: Optional[pt2eq.PT2EQuantizer] = None,
+      generative_recipe: Optional[quant_recipe.GenerativeQuantRecipe] = None,
+  ):
+    """Initializes some internal states based on selected quantization method.
+
+    Performs internal sanity checks to ensure that the user is inputting valid
+    quantization requests. Verifies that the received quantization config
+    is properly setup. Additionally sets up an utility enum _quantizer_mode to
+    guide certain conversion processes.
+    """
+    if pt2e_quantizer is not None and generative_recipe is not None:
+      raise ValueError('Cannot set both pt2e_quantizer and generative_recipe.')
+    elif pt2e_quantizer is not None:
+      object.__setattr__(self, 'pt2e_quantizer', pt2e_quantizer)
+      object.__setattr__(
+          self,
+          '_quantizer_mode',
+          (
+              self._QuantizerMode.PT2E_DYNAMIC
+              if pt2e_quantizer.global_config.is_dynamic
+              else self._QuantizerMode.PT2E_STATIC
+          ),
+      )
+    elif generative_recipe is not None:
+      generative_recipe.verify()
+      object.__setattr__(self, 'generative_recipe', generative_recipe)
+      object.__setattr__(
+          self, '_quantizer_mode', self._QuantizerMode.AI_EDGE_QUANTIZER
+      )
+    else:
+      raise ValueError(
+          'Either pt2e_quantizer or generative_recipe must be set.'
+      )

ai_edge_torch/testing/__init__.py

@@ -0,0 +1,14 @@
+# Copyright 2024 The AI Edge Torch 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.
+# ==============================================================================

ai_edge_torch/testing/model_coverage/__init__.py

@@ -0,0 +1,16 @@
+# Copyright 2024 The AI Edge Torch 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.
+# ==============================================================================
+
+from ai_edge_torch.testing.model_coverage.model_coverage import compare_tflite_torch  # NOQA

ai_edge_torch/testing/model_coverage/model_coverage.py

@@ -0,0 +1,145 @@
+# Copyright 2024 The AI Edge Torch 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.
+# ==============================================================================
+
+"""Contains utility functions to test TFLite models exported from PyTorch."""
+
+from collections.abc import Callable
+
+from ai_edge_torch import model
+import numpy as np
+import torch
+from torch.utils import _pytree as pytree
+
+
+# Utility to flatten the order to make it deterministic.
+# Ordering is done in left-to-right depth-first tree traversal.
+def _flatten(data):
+  out, _ = pytree.tree_flatten(data)
+  return out
+
+
+# Convert a Torch Tensor to a numpy array
+def _torch_tensors_to_np(*argv):
+  """Converts a Torch Tensor to a numpy array.
+
+  Args:
+    *argv: A list of torch.tensor or a single torch.tensor.
+
+  Returns:
+    A list of numpy array or a single numpy array.
+  """
+  if len(argv) > 1:
+    data = list(argv)
+  else:
+    data = argv[0]
+
+  if isinstance(data, torch.Tensor):
+    return data.to("cpu").detach().numpy()
+
+  elif isinstance(data, (list, tuple)):
+    out = []
+    for di in data:
+      out.append(_torch_tensors_to_np(di))
+    return out
+
+  elif isinstance(data, dict):
+    out = {}
+    for ni, di in data.items():
+      out[ni] = _torch_tensors_to_np(di)
+    return out
+
+  else:
+    raise ValueError("Unsupported torch.tensor type.")
+
+
+def compare_tflite_torch(
+    edge_model: model.Model,
+    torch_eval_func: Callable,
+    args=None,
+    kwargs=None,
+    *,
+    num_valid_inputs: int = 1,
+    signature_name: str = None,
+    atol: float = 1e-5,
+    rtol: float = 1e-5
+):
+  """Compares torch models and TFLite models.
+
+  Args:
+    edge_model: Serialized ai_edge_torch.model.Model object.
+    torch_eval_func: Callable function to evaluate torch model.
+    args: torch.tensor array or a callable to generate a torch.tensor array with
+      random data, to pass into models during inference. (default None).
+    kwargs: dict of str to torch.tensor, or a callable to generate such.
+    num_valid_inputs: Defines the number of times the random inputs will be
+      generated (if a callable is provided for input_data).
+    signature_name: If provided, specifies the name for the signature of the
+      edge_model to run. Calls the default signature if not provided.
+    atol: Absolute tolerance (see `numpy.allclose`)
+    rtol: Relative tolerance (see `numpy.allclose`)
+  """
+  # Convert the input data and the output data into an array.
+  # output data here is generated by running the `torch_eval_func` and
+  # is considered to act as golden data for verification purposes
+
+  # The supplied model_def.forward_args() will be executed num_valid_inputs
+  # times to generate num_valid_inputs random inputs.
+  torch_inputs = [
+      (
+          (args() if callable(args) else args) or tuple(),
+          (kwargs() if callable(kwargs) else kwargs) or {},
+      )
+      for _ in range(num_valid_inputs)
+  ]
+  torch_outputs = [
+      torch_eval_func(*args, **kwargs) for args, kwargs in torch_inputs
+  ]
+  np_inputs = [
+      (_torch_tensors_to_np(args), _torch_tensors_to_np(kwargs))
+      for args, kwargs in torch_inputs
+  ]
+  np_outputs = [_torch_tensors_to_np(_flatten(ys)) for ys in torch_outputs]
+
+  # Define inline utility function used throughout the function.
+  def equal_fn(actual, expected):
+    return np.allclose(actual, expected, atol=atol, rtol=rtol)
+
+  def get_edge_output(inputs):
+    args, kwargs = inputs
+    if signature_name is None:
+      return _flatten(edge_model(*args, **kwargs))
+    else:
+      return _flatten(
+          edge_model(*args, **kwargs, signature_name=signature_name)
+      )
+
+  for idx, np_input in enumerate(np_inputs):
+    output = get_edge_output(np_input)
+    golden_output = np_outputs[idx]
+    is_output_len_eq = len(golden_output) == len(output)
+
+    output = [v.astype(np.float32) for v in output]
+    golden_output = [v.astype(np.float32) for v in golden_output]
+
+    # Append the results of each invoke to a function-global variable
+    # used to store the comparison final results
+    is_equal = is_output_len_eq and all([
+        equal_fn(out, golden_out)
+        for out, golden_out in zip(output, golden_output)
+    ])
+    if not is_equal:
+      return False
+
+  return True

ai_edge_torch/version.py

@@ -0,0 +1,16 @@
+# Copyright 2024 The AI Edge Torch 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.
+# ==============================================================================
+
+__version__ = "0.3.0.dev20250114"

ai_edge_torch_nightly-0.3.0.dev20250114.dist-info/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

ai_edge_torch_nightly-0.3.0.dev20250114.dist-info/METADATA

@@ -0,0 +1,44 @@
+Metadata-Version: 2.1
+Name: ai-edge-torch-nightly
+Version: 0.3.0.dev20250114
+Summary: Supporting PyTorch models with the Google AI Edge TFLite runtime.
+Home-page: https://github.com/google-ai-edge/ai-edge-torch
+Keywords: On-Device ML,AI,Google,TFLite,PyTorch,LLMs,GenAI
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Software Development
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: scipy
+Requires-Dist: safetensors
+Requires-Dist: tabulate
+Requires-Dist: torch>=2.4.0
+Requires-Dist: tf-nightly>=2.19.0.dev20241201
+Requires-Dist: ai-edge-litert-nightly
+Requires-Dist: ai-edge-quantizer-nightly
+Requires-Dist: jax
+Requires-Dist: torch-xla2[odml]>=0.0.1.dev20241201
+Provides-Extra: torch-xla
+Requires-Dist: torch-xla>=2.4.0; extra == "torch-xla"
+
+Library that supports converting PyTorch models into a .tflite format, which can
+then be run with TensorFlow Lite and MediaPipe.  This enables applications for
+Android, iOS and IOT that can run models completely on-device.
+
+[Install steps](https://github.com/google-ai-edge/ai-edge-torch#installation)
+and additional details are in the AI Edge Torch
+[GitHub repository](https://github.com/google-ai-edge/ai-edge-torch).