helia-profiler 0.1.1__tar.gz

helia_profiler-0.1.1/LICENSE

@@ -0,0 +1,201 @@
+                                 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.

helia_profiler-0.1.1/PKG-INFO

@@ -0,0 +1,129 @@
+Metadata-Version: 2.4
+Name: helia-profiler
+Version: 0.1.1
+Summary: Profile LiteRT models on Ambiq Apollo hardware
+License-Expression: Apache-2.0
+Project-URL: Documentation, https://ambiqai.github.io/helia-profiler/
+Project-URL: Issues, https://github.com/AmbiqAI/helia-profiler/issues
+Project-URL: Repository, https://github.com/AmbiqAI/helia-profiler
+Keywords: ambiq,apollo,embedded,joulescope,litert,profiling
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Embedded Systems
+Requires-Python: <3.13,>=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: THIRD_PARTY_NOTICES.md
+License-File: src/helia_profiler/vendor/segger_rtt/LICENSE.md
+Requires-Dist: Jinja2>=3.1
+Requires-Dist: PyYAML>=6.0
+Requires-Dist: rich>=13.0
+Requires-Dist: pyserial>=3.5
+Requires-Dist: pylink-square>=0.14.0
+Requires-Dist: neuralspotx<0.8.0,>=0.7.8
+Requires-Dist: numpy<3,>=2.1
+Requires-Dist: pyjoulescope-driver<2.3.0,>=2.2.12; python_version < "3.12"
+Requires-Dist: pyjoulescope-driver<3,>=2.3.2; python_version >= "3.12"
+Requires-Dist: pydantic<3,>=2.7
+Requires-Dist: typer>=0.16
+Requires-Dist: click>=8.2
+Provides-Extra: aot
+Requires-Dist: helia-aot>=0.18.0; extra == "aot"
+Requires-Dist: ai-edge-litert<2.2,>=2.1.6; extra == "aot"
+Requires-Dist: backports-strenum<1.3; extra == "aot"
+Provides-Extra: analysis
+Requires-Dist: ai-edge-litert<2.2,>=2.1.6; extra == "analysis"
+Requires-Dist: backports-strenum<1.3; extra == "analysis"
+Requires-Dist: flatbuffers>=24.0; extra == "analysis"
+Dynamic: license-file
+
+# heliaPROFILER
+
+**`hpx`** profiles LiteRT (`.tflite`) models on real Ambiq Apollo silicon —
+one command builds temporary firmware, flashes it, and returns per-layer PMU
+counter breakdowns plus optional Joulescope power/energy per inference.
+
+> **Alpha.** heliaPROFILER is pre-1.0. Breaking changes may land on **minor**
+> versions until v1.0. Pin an exact version in production pipelines.
+
+📖 Full docs: **https://ambiqai.github.io/helia-profiler/**
+
+## Why hpx
+
+- **Per-layer PMU breakdowns** — cycles, instructions, cache, and (on
+  Cortex-M55 boards) MVE and memory counter groups, one row per layer.
+- **Power & energy per inference** — GPIO-gated Joulescope capture
+  (JS110/JS220) isolates the inference window from setup/teardown noise.
+- **Three engines** — `tflm` (vanilla TFLM baseline), `helia-rt` (Ambiq's
+  optimized TFLM interpreter), and `helia-aot` (Ambiq's ahead-of-time model
+  compiler), selected explicitly
+  per run.
+- **Multiple toolchains** — `arm-none-eabi-gcc`, `armclang`, and ATfE, so you
+  can compare build/runtime trade-offs without changing your model.
+- **Memory placement control** — pin the tensor arena and model weights to
+  TCM, SRAM, MRAM, or PSRAM independently.
+- **Model Explorer overlays** — export per-layer metrics as JSON overlays
+  for [Model Explorer](https://github.com/google-ai-edge/model-explorer).
+- **Config-file driven** — a frozen, immutable `hpx.yml` schema merges with
+  CLI flags, with strict validation and did-you-mean suggestions for typos.
+- **Multi-board** — Apollo3, Apollo4, and Apollo5-family EVBs. Run
+  `hpx boards` for the exact list your install supports.
+
+## Install
+
+```bash
+pip install helia-profiler
+# or
+uv tool install helia-profiler
+```
+
+Extras: `helia-profiler[aot]` adds the heliaAOT compiler;
+`helia-profiler[analysis]` enables model compute/parameter analysis without
+hardware.
+
+Hardware prerequisites (ARM toolchain, SEGGER J-Link, and optional
+Joulescope drivers) are covered step by step in
+[Getting Started](https://ambiqai.github.io/helia-profiler/getting-started/).
+
+## Quick taste
+
+```bash
+hpx doctor                                   # check toolchain + dependencies
+hpx profile model.tflite                     # profile with defaults
+hpx profile model.tflite --power             # add Joulescope power capture
+hpx profile --config hpx.yml                 # reproducible, config-driven run
+```
+
+```text
+  Layer  Op                  ARM_PMU_CPU_CYCLES  ARM_PMU_INST_RETIRED
+  0      CONV_2D                        123,456                98,765
+  1      DEPTHWISE_CONV_2D               45,678                34,567
+  ...
+  Power:  1.234 mA avg   12.345 mW avg   x.xxx µJ / inference
+```
+
+*(Illustrative sample only — see
+[Getting Started](https://ambiqai.github.io/helia-profiler/getting-started/)
+for a real walkthrough.)*
+
+## Development
+
+```bash
+uv sync --locked --all-groups
+uv run ruff check src tests tools
+uv run pytest -q
+uv run mkdocs build --strict
+```
+
+Repository workflows use the committed `uv.lock` for reproducibility. PyPI
+installations continue to resolve the compatible dependency ranges published in
+`pyproject.toml`.
+
+## License
+
+Apache-2.0

helia_profiler-0.1.1/README.md

@@ -0,0 +1,85 @@
+# heliaPROFILER
+
+**`hpx`** profiles LiteRT (`.tflite`) models on real Ambiq Apollo silicon —
+one command builds temporary firmware, flashes it, and returns per-layer PMU
+counter breakdowns plus optional Joulescope power/energy per inference.
+
+> **Alpha.** heliaPROFILER is pre-1.0. Breaking changes may land on **minor**
+> versions until v1.0. Pin an exact version in production pipelines.
+
+📖 Full docs: **https://ambiqai.github.io/helia-profiler/**
+
+## Why hpx
+
+- **Per-layer PMU breakdowns** — cycles, instructions, cache, and (on
+  Cortex-M55 boards) MVE and memory counter groups, one row per layer.
+- **Power & energy per inference** — GPIO-gated Joulescope capture
+  (JS110/JS220) isolates the inference window from setup/teardown noise.
+- **Three engines** — `tflm` (vanilla TFLM baseline), `helia-rt` (Ambiq's
+  optimized TFLM interpreter), and `helia-aot` (Ambiq's ahead-of-time model
+  compiler), selected explicitly
+  per run.
+- **Multiple toolchains** — `arm-none-eabi-gcc`, `armclang`, and ATfE, so you
+  can compare build/runtime trade-offs without changing your model.
+- **Memory placement control** — pin the tensor arena and model weights to
+  TCM, SRAM, MRAM, or PSRAM independently.
+- **Model Explorer overlays** — export per-layer metrics as JSON overlays
+  for [Model Explorer](https://github.com/google-ai-edge/model-explorer).
+- **Config-file driven** — a frozen, immutable `hpx.yml` schema merges with
+  CLI flags, with strict validation and did-you-mean suggestions for typos.
+- **Multi-board** — Apollo3, Apollo4, and Apollo5-family EVBs. Run
+  `hpx boards` for the exact list your install supports.
+
+## Install
+
+```bash
+pip install helia-profiler
+# or
+uv tool install helia-profiler
+```
+
+Extras: `helia-profiler[aot]` adds the heliaAOT compiler;
+`helia-profiler[analysis]` enables model compute/parameter analysis without
+hardware.
+
+Hardware prerequisites (ARM toolchain, SEGGER J-Link, and optional
+Joulescope drivers) are covered step by step in
+[Getting Started](https://ambiqai.github.io/helia-profiler/getting-started/).
+
+## Quick taste
+
+```bash
+hpx doctor                                   # check toolchain + dependencies
+hpx profile model.tflite                     # profile with defaults
+hpx profile model.tflite --power             # add Joulescope power capture
+hpx profile --config hpx.yml                 # reproducible, config-driven run
+```
+
+```text
+  Layer  Op                  ARM_PMU_CPU_CYCLES  ARM_PMU_INST_RETIRED
+  0      CONV_2D                        123,456                98,765
+  1      DEPTHWISE_CONV_2D               45,678                34,567
+  ...
+  Power:  1.234 mA avg   12.345 mW avg   x.xxx µJ / inference
+```
+
+*(Illustrative sample only — see
+[Getting Started](https://ambiqai.github.io/helia-profiler/getting-started/)
+for a real walkthrough.)*
+
+## Development
+
+```bash
+uv sync --locked --all-groups
+uv run ruff check src tests tools
+uv run pytest -q
+uv run mkdocs build --strict
+```
+
+Repository workflows use the committed `uv.lock` for reproducibility. PyPI
+installations continue to resolve the compatible dependency ranges published in
+`pyproject.toml`.
+
+## License
+
+Apache-2.0

helia_profiler-0.1.1/THIRD_PARTY_NOTICES.md

@@ -0,0 +1,15 @@
+# Third-Party Notices
+
+heliaPROFILER includes the following third-party source code.
+
+## SEGGER Real Time Transfer (RTT)
+
+- Copyright: Copyright (c) 2026 SEGGER Microcontroller GmbH
+- Version: V8.58.0
+- Source: [SEGGERMicro/RTT](https://github.com/SEGGERMicro/RTT)
+- License: permissive redistribution license; see
+  `src/helia_profiler/vendor/segger_rtt/LICENSE.md`
+
+The bundled target sources are used to build temporary profiling firmware.
+SEGGER J-Link host software, libraries, drivers, and firmware are not included
+in heliaPROFILER and remain subject to SEGGER's separate terms.

helia_profiler-0.1.1/pyproject.toml

@@ -0,0 +1,125 @@
+[project]
+name = "helia-profiler"
+version = "0.1.1"
+description = "Profile LiteRT models on Ambiq Apollo hardware"
+readme = "README.md"
+requires-python = ">=3.11,<3.13"
+license = "Apache-2.0"
+license-files = [
+    "LICENSE",
+    "THIRD_PARTY_NOTICES.md",
+    "src/helia_profiler/vendor/segger_rtt/LICENSE.md",
+]
+keywords = ["ambiq", "apollo", "embedded", "joulescope", "litert", "profiling"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Software Development :: Embedded Systems",
+]
+dependencies = [
+    "Jinja2>=3.1",
+    "PyYAML>=6.0",
+    "rich>=13.0",
+    "pyserial>=3.5",
+    "pylink-square>=0.14.0",
+    "neuralspotx>=0.7.8,<0.8.0",
+    "numpy>=2.1,<3",
+    "pyjoulescope-driver>=2.2.12,<2.3.0; python_version < '3.12'",
+    "pyjoulescope-driver>=2.3.2,<3; python_version >= '3.12'",
+    "pydantic>=2.7,<3",
+    "typer>=0.16",
+    "click>=8.2",
+]
+
+[project.optional-dependencies]
+aot = [
+    "helia-aot>=0.18.0",
+    "ai-edge-litert>=2.1.6,<2.2",
+    "backports-strenum<1.3",
+]
+analysis = [
+    "ai-edge-litert>=2.1.6,<2.2",
+    "backports-strenum<1.3",
+    "flatbuffers>=24.0",
+]
+
+[project.scripts]
+hpx = "helia_profiler.cli:main"
+
+[project.urls]
+Documentation = "https://ambiqai.github.io/helia-profiler/"
+Issues = "https://github.com/AmbiqAI/helia-profiler/issues"
+Repository = "https://github.com/AmbiqAI/helia-profiler"
+
+[dependency-groups]
+lint = ["ruff>=0.11.0,<0.12"]
+test = ["pytest>=8.0", "pytest-timeout>=2.3"]
+notebook = ["ipykernel>=6,<8"]
+docs = [
+    "mkdocs-material>=9.0",
+    "mkdocstrings[python]>=0.27",
+    "pymdown-extensions>=10.15",
+    "zensical>=0.0.51,<0.1",
+]
+
+[build-system]
+requires = ["setuptools>=77.0.3", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+include-package-data = true
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["helia_profiler", "helia_profiler.*"]
+
+[tool.setuptools.package-data]
+helia_profiler = [
+    "firmware/templates/**/*",
+    "engines/templates/**/*",
+    "data/*.json",
+    "data/models/*.json",
+    "data/models/*.tflite",
+    "vendor/segger_rtt/**/*",
+]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "-m 'not hardware'"
+markers = [
+    "hardware: requires physical target hardware (EVB + J-Link, optional Joulescope). Excluded by default; run via `hpx validate` or `pytest -m hardware`.",
+]
+
+[tool.ruff]
+line-length = 100
+target-version = "py310"
+
+[tool.ruff.lint]
+select = [
+    "E4",
+    "E7",
+    "E9",
+    "F",
+    "I",
+]
+ignore = [
+    "E741",
+    "F401",
+    "F841",
+    "I001",
+]
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+skip-magic-trailing-comma = false
+line-ending = "auto"
+
+[tool.ruff.lint.per-file-ignores]
+"**/__init__.py" = ["F401"]

helia_profiler-0.1.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+