From e3d1a5a3b1e04e8d3f2eee9c9d3749dcb016b447 Mon Sep 17 00:00:00 2001
From: RJ Ascani <rjascani@google.com>
Date: Mon, 14 Aug 2023 12:18:02 -0700
Subject: [PATCH 1/4] Add py load statement for codegen (#2166)

The new codegen python build rules were added without properly loading the rules.

BUG=b/295216390
---
 codegen/BUILD | 1 +
 1 file changed, 1 insertion(+)

diff --git a/codegen/BUILD b/codegen/BUILD
index 042a1125f83..5473361484f 100644
--- a/codegen/BUILD
+++ b/codegen/BUILD
@@ -1,3 +1,4 @@
+load("@rules_python//python:defs.bzl", "py_binary", "py_library")
 load("@tflm_pip_deps//:requirements.bzl", "requirement")
 
 package(

From 46ccaf8fb3687d0f6b579f726400f81ab5fa7a81 Mon Sep 17 00:00:00 2001
From: RJ Ascani <rjascani@google.com>
Date: Mon, 14 Aug 2023 12:50:55 -0700
Subject: [PATCH 2/4] Remove unused and combine similar loads (#2165)

BUG=cleanup
---
 python/tflite_micro/signal/utils/BUILD                | 3 +--
 tensorflow/lite/micro/examples/person_detection/BUILD | 1 -
 2 files changed, 1 insertion(+), 3 deletions(-)

diff --git a/python/tflite_micro/signal/utils/BUILD b/python/tflite_micro/signal/utils/BUILD
index 16047dbffaf..a29cd9335db 100644
--- a/python/tflite_micro/signal/utils/BUILD
+++ b/python/tflite_micro/signal/utils/BUILD
@@ -1,6 +1,5 @@
 # Signal python utilities.
-load("@rules_python//python:defs.bzl", "py_library")
-load("@rules_python//python:defs.bzl", "py_test")
+load("@rules_python//python:defs.bzl", "py_library", "py_test")
 load("@tflm_pip_deps//:requirements.bzl", "requirement")
 load("@pybind11_bazel//:build_defs.bzl", "pybind_extension")
 
diff --git a/tensorflow/lite/micro/examples/person_detection/BUILD b/tensorflow/lite/micro/examples/person_detection/BUILD
index c18e024b268..449c4be11da 100644
--- a/tensorflow/lite/micro/examples/person_detection/BUILD
+++ b/tensorflow/lite/micro/examples/person_detection/BUILD
@@ -1,6 +1,5 @@
 # Description:
 #   TensorFlow Lite for Microcontrollers Vision Example.
-load("@rules_python//python:defs.bzl", "py_binary", "py_library", "py_test")
 load("//tensorflow/lite/micro:build_def.bzl", "generate_cc_arrays")
 
 package(

From 3c291cf7d495a83df1d515d8791f5febdcedb052 Mon Sep 17 00:00:00 2001
From: Advait Jain <advaitjain@users.noreply.github.com>
Date: Tue, 15 Aug 2023 17:32:03 -0700
Subject: [PATCH 3/4] Update int16 LSTM test case with zero_point=0 (#2171)

* https://github.com/tensorflow/tflite-micro/commit/a76d1541b65c59f36fd0afff76c2443aaf261eb3 has the changes needed to create test data for the current PR. I reverted the changes back to have the script be mostly unchanged (except for some typos and trailing whitespaces).
 * To get the new quantization parameters:
```bash
bazel run tensorflow/lite/micro/kernels/testdata:lstm_test_data_generator
```
And then manually copy over the parameters into `lstm_test_data.cc`

BUG=http://b/296130372
---
 .../lite/micro/kernels/testdata/lstm_test_data.cc  | 14 ++++++++------
 .../kernels/testdata/lstm_test_data_generator.py   | 10 +++++-----
 2 files changed, 13 insertions(+), 11 deletions(-)

diff --git a/tensorflow/lite/micro/kernels/testdata/lstm_test_data.cc b/tensorflow/lite/micro/kernels/testdata/lstm_test_data.cc
index 4d7d9d9edcb..8a89fe2b33d 100644
--- a/tensorflow/lite/micro/kernels/testdata/lstm_test_data.cc
+++ b/tensorflow/lite/micro/kernels/testdata/lstm_test_data.cc
@@ -251,12 +251,14 @@ NodeQuantizationParameters Get2X2Int16LstmQuantizationSettings() {
 
   // state quantization parameters
   quantization_settings.input = {/*scale=*/3.0518044e-5, /*zp=*/0,
-                                 /*symmetry=*/false};
-  quantization_settings.output = {/*scale=*/1.8310826e-5, /*zp=*/-5461,
-                                  /*symmetry=*/false};
-  quantization_settings.hidden_state = {/*scale=*/1.8310826e-5, /*zp=*/-5461,
-                                        /*symmetry=*/false};
-  quantization_settings.cell_state = {/*scale=*/0.00024414062, /*zp=*/0,
+                                 /*symmetry=*/true};
+  quantization_settings.output = {/*scale=*/2.1362956633198035e-05, /*zp=*/0,
+                                  /*symmetry=*/true};
+  quantization_settings.hidden_state = {/*scale=*/2.1362956633198035e-05,
+                                        /*zp=*/0,
+                                        /*symmetry=*/true};
+  quantization_settings.cell_state = {/*scale=*/0.00024414807580797754,
+                                      /*zp=*/0,
                                       /*symmetry=*/true};
 
   // gate quantization parameters
diff --git a/tensorflow/lite/micro/kernels/testdata/lstm_test_data_generator.py b/tensorflow/lite/micro/kernels/testdata/lstm_test_data_generator.py
index 97c8798ef44..c6553fe2e4f 100644
--- a/tensorflow/lite/micro/kernels/testdata/lstm_test_data_generator.py
+++ b/tensorflow/lite/micro/kernels/testdata/lstm_test_data_generator.py
@@ -17,15 +17,15 @@
 2. Print the intermediate step outputs inside the LSTM for a single step LSTM invocation (Get2X2GateOutputCheckData in .cc)
 3. Print the outputs for multi-step LSTM invocation (Get2X2LstmEvalCheckData in .cc)
 
-Every invocation gives three types information: 
-1. Quantized output: kernel output in integer 
+Every invocation gives three types information:
+1. Quantized output: kernel output in integer
 2. Dequantized output: Quantized output in floating point representation
 3. Float output: output from the floating point computation (i.e., float kernel)
 
-Note: 
+Note:
 1. Change quantization settings in _KERNEL_CONFIG to see the outcomes from various quantization schema (e.g., 8x8 Vs. 16x8)
 2. Only single batch inference is supporte here. Change _GATE_TEST_DATA or _MULTISTEP_TEST_DATA to see kernel outputs on different input data
-3. The quantization computation here is not the exact as the c++ implementation. The integer calculation is mimiced here using floating point. 
+3. The quantization computation here is not the exact as the c++ implementation. The integer calculation is emulated here using floating point.
 No fixed point math is implemented here. The purpose is to illustrate the computation procedure and possible quantization error accumulation, not for bit exactness.
 """
 from absl import app
@@ -88,7 +88,7 @@
 _MULTISTEP_TEST_DATA = {
     'init_hidden_state_vals': [0, 0],
     'init_cell_state_vals': [0, 0],
-    'input_data': [0.2, 0.3, 0.2, 0.3, 0.2, 0.3],  # three time steps 
+    'input_data': [0.2, 0.3, 0.2, 0.3, 0.2, 0.3],  # three time steps
     'hidden_state_range': (-0.5, 0.7),
     'cell_state_range': [-8, 8],
     'input_data_range': [-1, 1]

From f4c2d0870f13c95b2ecbdc98c88063d4595a4be0 Mon Sep 17 00:00:00 2001
From: Ryan Kuester <kuester@bdti.com>
Date: Wed, 16 Aug 2023 14:04:37 -0500
Subject: [PATCH 4/4] feat(py): give package a developmental version label
 (#2168)

Use Bazel's workspace status mechanism, designed for "stamping" builds with
identifying information from the build environment, to dynamically generate the
version label of the Python distribution package. Generate stamps when Bazel
runs via the --workspace_status_command option and command script. Then use
these stamps in the version label.

Guidelines for Python version labels are given in [PEP 440][]. TFLM does not
currently tag and publish what PEP 440 calls "final releases". Instead,
distribution packages will periodically be published from the tip of the main
branch, and users will be expected to use the latest version or pin to a
historical version of their choice. To facilitate such use, the build system
needs to generate a unique, ascending version label for each commit on the main
branch.

Guided by [PEP 440][], use developmental version labels of the form
*major[.minor].dev<time>*, for example:

    0.dev20090103181505

Use a release segment with a major number of 0 (via the standard Bazel
BUILD_EMBED_LABEL stamp), because TFLM does not currently tag and publish
releases. This leaves room in the version space for making semver-style final
releases in the future. Add a developmental release segment with a date and
time stamp.

Packages should be traceable to the exact source from which they were built.
[PEP 440][] does not allow Git hashes in version labels published to PyPI;
however, the Git hash can be embedded in the package's runtime-visible
attribute `tflite_micro.__version__`, and in the package's description, which
is displayed on PyPI.

[PEP 440]: https://peps.python.org/pep-0440

BUG=part of #1484
---
 .bazelrc                              |  9 ++++
 python/tflite_micro/BUILD             | 21 +++++++-
 python/tflite_micro/README.pypi.md.in |  5 ++
 python/tflite_micro/__init__.py       |  4 ++
 python/tflite_micro/_version.py.in    |  1 +
 python/tflite_micro/whl_test.sh       |  6 +--
 tools/BUILD                           | 16 ++++++
 tools/expand_stamp_vars.bzl           | 52 +++++++++++++++++++
 tools/expand_stamp_vars.py            | 75 +++++++++++++++++++++++++++
 tools/expand_stamp_vars_test.py       | 46 ++++++++++++++++
 tools/workspace_status.sh             | 42 +++++++++++++++
 11 files changed, 273 insertions(+), 4 deletions(-)
 create mode 100644 python/tflite_micro/README.pypi.md.in
 create mode 100644 python/tflite_micro/_version.py.in
 create mode 100644 tools/BUILD
 create mode 100644 tools/expand_stamp_vars.bzl
 create mode 100644 tools/expand_stamp_vars.py
 create mode 100644 tools/expand_stamp_vars_test.py
 create mode 100755 tools/workspace_status.sh

diff --git a/.bazelrc b/.bazelrc
index 55bf613e10f..b150e1f7197 100644
--- a/.bazelrc
+++ b/.bazelrc
@@ -15,6 +15,15 @@
 #
 # TFLM Bazel configuration file.
 
+# The semver-format version label embedded in build outputs when and where
+# stamping is used. Note TFLM does not currently publish semver-versioned
+# releases; however, this value is used where a version label is required, such
+# as in the Python distribution package.
+build --embed_label=0
+
+# Get stamp values from a script's output
+build --workspace_status_command=./tools/workspace_status.sh
+
 # Use the following C++ standard
 build --cxxopt -std=c++17
 
diff --git a/python/tflite_micro/BUILD b/python/tflite_micro/BUILD
index e0661b58560..ddd9a35242c 100644
--- a/python/tflite_micro/BUILD
+++ b/python/tflite_micro/BUILD
@@ -1,6 +1,7 @@
 load("@rules_python//python:defs.bzl", "py_library", "py_test")
 load("@pybind11_bazel//:build_defs.bzl", "pybind_extension")
 load("//python:py_namespace.bzl", "py_namespace")
+load("//tools:expand_stamp_vars.bzl", "expand_stamp_vars")
 load("@rules_python//python:packaging.bzl", "py_package", "py_wheel")
 load("@tflm_pip_deps//:requirements.bzl", "requirement")
 load(
@@ -109,6 +110,14 @@ py_library(
     ],
 )
 
+# Generate a version attribute, imported as tflite_micro.__version__, using
+# stamp (a.k.a. workspace status) variables.
+expand_stamp_vars(
+    name = "version",
+    out = "_version.py",
+    template = "_version.py.in",
+)
+
 # Collect the `deps` and their transitive dependences together into a set of
 # files to package. The files retain their full path relative to the workspace
 # root, which determines the subpackage path at which they're located within
@@ -129,6 +138,7 @@ py_package(
     deps = [
         ":postinstall_check",
         ":runtime",
+        ":version",
     ],
 )
 
@@ -151,16 +161,25 @@ py_namespace(
     ],
 )
 
+expand_stamp_vars(
+    name = "description_file",
+    out = "README.pypi.md",
+    template = "README.pypi.md.in",
+)
+
 py_wheel(
     name = "whl",
+    description_file = ":description_file",
     distribution = "tflite_micro",
     requires = [
         "flatbuffers",
         "numpy",
         "tensorflow",
     ],
+    stamp = 1,  # 1 == always stamp
     strip_path_prefixes = [package_name()],
-    version = "0.1.0",
+    summary = "TensorFlow Lite for Microcontrollers",
+    version = "{BUILD_EMBED_LABEL}.dev{STABLE_GIT_COMMIT_TIME}",
     deps = [
         ":namespace",
     ],
diff --git a/python/tflite_micro/README.pypi.md.in b/python/tflite_micro/README.pypi.md.in
new file mode 100644
index 00000000000..a04356e94b2
--- /dev/null
+++ b/python/tflite_micro/README.pypi.md.in
@@ -0,0 +1,5 @@
+# TensorFlow Lite for Microcontrollers
+
+This package is built from commit
+[{STABLE_GIT_HASH}](https://github.com/tensorflow/tflite-micro/blob/{STABLE_GIT_HASH}/python/tflite_micro)
+of [github.com/tensorflow/tflite-micro](https://github.com/tensorflow/tflite-micro).
diff --git a/python/tflite_micro/__init__.py b/python/tflite_micro/__init__.py
index 940289ce5d0..9f15213249b 100644
--- a/python/tflite_micro/__init__.py
+++ b/python/tflite_micro/__init__.py
@@ -11,6 +11,7 @@
 # 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.
+# ----
 
 # Define a public API for the package by providing aliases for modules which
 # are otherwise deeply nested in subpackages determined by their location in
@@ -20,5 +21,8 @@
 
 from tflite_micro.python.tflite_micro import runtime
 
+# Unambiguously identify the source used to build the package.
+from tflite_micro.python.tflite_micro._version import __version__
+
 # Ordered after `runtime` to avoid a circular dependency
 from tflite_micro.python.tflite_micro import postinstall_check
diff --git a/python/tflite_micro/_version.py.in b/python/tflite_micro/_version.py.in
new file mode 100644
index 00000000000..77768f70dab
--- /dev/null
+++ b/python/tflite_micro/_version.py.in
@@ -0,0 +1 @@
+__version__ = "{BUILD_EMBED_LABEL}.dev{STABLE_GIT_COMMIT_TIME}-g{STABLE_GIT_HASH}"
diff --git a/python/tflite_micro/whl_test.sh b/python/tflite_micro/whl_test.sh
index 8b6d97fd3da..f3e829314ec 100755
--- a/python/tflite_micro/whl_test.sh
+++ b/python/tflite_micro/whl_test.sh
@@ -37,7 +37,7 @@ pip show --files tflite-micro
 
 # Run the package's post-installation checks.
 python3 << HEREDOC
-import sys
-from tflite_micro import postinstall_check
-sys.exit(0 if postinstall_check.passed() else 1)
+import sys, tflite_micro
+print(tflite_micro.__version__)
+sys.exit(0 if tflite_micro.postinstall_check.passed() else 1)
 HEREDOC
diff --git a/tools/BUILD b/tools/BUILD
new file mode 100644
index 00000000000..d886dc5b72a
--- /dev/null
+++ b/tools/BUILD
@@ -0,0 +1,16 @@
+load("@rules_python//python:defs.bzl", "py_binary", "py_test")
+
+package(
+    default_visibility = ["//visibility:public"],
+)
+
+py_binary(
+    name = "expand_stamp_vars",
+    srcs = ["expand_stamp_vars.py"],
+)
+
+py_test(
+    name = "expand_stamp_vars_test",
+    srcs = ["expand_stamp_vars_test.py"],
+    deps = [":expand_stamp_vars"],
+)
diff --git a/tools/expand_stamp_vars.bzl b/tools/expand_stamp_vars.bzl
new file mode 100644
index 00000000000..39db265de3b
--- /dev/null
+++ b/tools/expand_stamp_vars.bzl
@@ -0,0 +1,52 @@
+# Copyright 2023 The TensorFlow 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.
+# ----
+
+def expand_stamp_vars(name, template, out):
+    """Macro for expanding a template using workspace status variables.
+
+    Typical usage in a BUILD file:
+
+        expand_stamp_vars(
+            name = "version",
+            template = "_version.py.in",
+            out = "_version.py",
+        )
+
+    Writes `template` to `out`, expanding references of the form '{KEY}' to the
+    value of the corresponding Bazel workspace status variable.
+    """
+
+    # This macro uses a genrule to call a helper program at Bazel execution
+    # time, because workspace variables are not available until execution time.
+    # Workspace variables are generated by bazel on each invocation, and
+    # written to the hardcoded files names used below. See the Bazel
+    # documentation for the option --workspace_status_command.
+
+    native.genrule(
+        name = name,
+        srcs = [template],
+        outs = [out],
+        cmd = "$(location //tools:expand_stamp_vars) " +
+              "bazel-out/stable-status.txt " +
+              "bazel-out/volatile-status.txt " +
+              "<$< >$@",
+        tools = [
+            "//tools:expand_stamp_vars",
+        ],
+
+        # Undocumented, but valid, and the only way to declare the necessary
+        # dependencies on {stable,volatile}-status.txt.
+        stamp = 1,
+    )
diff --git a/tools/expand_stamp_vars.py b/tools/expand_stamp_vars.py
new file mode 100644
index 00000000000..08910217aab
--- /dev/null
+++ b/tools/expand_stamp_vars.py
@@ -0,0 +1,75 @@
+#!/usr/bin/env python3
+
+# Copyright 2023 The TensorFlow 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.
+# ----
+
+# A filter that expands Bazel workspace stamp variables.
+#
+# For example, the input steam:
+#
+#     This build was compiled at {BUILD_DATE}.
+#
+# is expanded into the output stream:
+#
+#     This build was compiled at 2023-02-10T14:15.
+#
+# Stamp variable key-value pairs are read from all files passed as positional
+# arguments. These files are typically bazel-out/stable-status.txt and
+# bazel-out/volatile-status.txt. See the Bazel documentation for the option
+# --workspace_status_command.
+
+import sys
+
+
+def read_stamps(file):
+  """Return a dictionary of key-value pairs read from a stamp file.
+
+  These files are typically bazel-out/stable-status.txt and
+  bazel-out/volatile-status.txt. See the Bazel documentation for the option
+  --workspace_status_command."""
+
+  stamps = {}
+  for line in file:
+    try:
+      key, value = line.split(" ", maxsplit=1)
+      stamps[key] = value.strip()
+    except ValueError:
+      pass  # Skip blank lines, etc.
+
+  return stamps
+
+
+def expand(istream, ostream, stamps):
+  """Write istream to ostream, expanding placeholders like {KEY}."""
+  for line in istream:
+    for key, value in stamps.items():
+      line = line.replace(f"{{{key}}}", value)
+    ostream.write(line)
+
+
+def _main():
+  """Stamp variables are read from all files passed as positional arguments."""
+  stamps = {}
+  for name in sys.argv[1:]:
+    with open(name) as f:
+      stamps.update(read_stamps(f))
+
+  expand(sys.stdin, sys.stdout, stamps)
+
+  sys.exit(0)
+
+
+if __name__ == "__main__":
+  _main()
diff --git a/tools/expand_stamp_vars_test.py b/tools/expand_stamp_vars_test.py
new file mode 100644
index 00000000000..9db201e1114
--- /dev/null
+++ b/tools/expand_stamp_vars_test.py
@@ -0,0 +1,46 @@
+#!/usr/bin/env python3
+
+# Copyright 2023 The TensorFlow 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.
+# ----
+
+# A test for the filter that expands Bazel workspace stamp variables.
+
+from tools import expand_stamp_vars
+
+import io
+import unittest
+
+
+class FilterTest(unittest.TestCase):
+  """A simple test of the expansion feature."""
+
+  def test_basic(self):
+    stamps = """
+BUILD_STAMP_ONE value_one
+BUILD_STAMP_TWO value_two
+"""
+    input = "This is {BUILD_STAMP_TWO}. This is {BUILD_STAMP_ONE}."
+    golden = "This is value_two. This is value_one."
+
+    istream = io.StringIO(input)
+    ostream = io.StringIO()
+    stamps = expand_stamp_vars.read_stamps(io.StringIO(stamps))
+    expand_stamp_vars.expand(istream, ostream, stamps)
+
+    self.assertEqual(ostream.getvalue(), golden)
+
+
+if __name__ == "__main__":
+  unittest.main()
diff --git a/tools/workspace_status.sh b/tools/workspace_status.sh
new file mode 100755
index 00000000000..5d17d1ae08b
--- /dev/null
+++ b/tools/workspace_status.sh
@@ -0,0 +1,42 @@
+#!/bin/sh
+
+# Copyright 2023 The TensorFlow 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.
+# ---
+
+# Output key-value pairs with which to stamp build outputs. This script is
+# called by the bazel option --workspace_status_command, which is likely to be
+# embedded in .bazelrc. Bazel generates some keys, such as BUILD_EMBED_LABEL,
+# on its own, outside of this script. Search for "Bazel workspace status" for
+# more, including the differences between STABLE_ and volatile keys.
+
+
+# Unambiguous identification of the source tree
+echo STABLE_GIT_HASH $(git describe --always --long --dirty)
+
+# Human-readable timestamp of git HEAD's commit date. Use dates derived from
+# git for stability across multiple invocations of the `bazel` command. Use UTC
+# rather than committer or local timezones for consistency across build
+# environments. Use commit date instead of author date, the default date shown
+# by `git log` and GitHub, because amending, rebasing, merging, etc. can cause
+# the author date of descendent commits to be earlier than those of their
+# ancestors.
+#
+# Comparable commit dates can be produced via:
+#     `TZ=UTC0 git log --pretty=fuller --date=local`.
+#
+echo STABLE_GIT_COMMIT_TIME $(TZ=UTC0 git show \
+    --no-patch \
+    --format=format:%cd \
+    --date=format-local:%Y%m%d%H%M%S)