Describe what these artifacts are and who consumes them
Browse files
README.md
ADDED
|
@@ -0,0 +1,54 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
license: other
|
| 3 |
+
tags:
|
| 4 |
+
- build-artifacts
|
| 5 |
+
- not-a-dataset
|
| 6 |
+
---
|
| 7 |
+
|
| 8 |
+
# MobileTransformers — build artifacts
|
| 9 |
+
|
| 10 |
+
**This is not a dataset.** It is the set of build inputs that cannot live in git, published here so
|
| 11 |
+
that a `git clone` of
|
| 12 |
+
[MobileTransformers](https://github.com/martinkorelic/mobiletransformers) can provision itself.
|
| 13 |
+
|
| 14 |
+
Nothing here is downloaded by the Android app or by any model package. These files are consumed by
|
| 15 |
+
one script, at development time:
|
| 16 |
+
|
| 17 |
+
```bash
|
| 18 |
+
scripts/fetch_native_deps.sh # the natives bundle — required to build the Android SDK
|
| 19 |
+
TRAINING=1 scripts/fetch_native_deps.sh # + the ORT-training wheel, for exporting a training stage
|
| 20 |
+
SYMBOLS=1 scripts/fetch_native_deps.sh # + unstripped binaries, for symbolicating a native crash
|
| 21 |
+
```
|
| 22 |
+
|
| 23 |
+
That script reads `third_party/android/manifest.json`, downloads what is missing, checks the archive
|
| 24 |
+
sha256, unpacks it, and then checks every unpacked file's sha256 individually. Both halves matter: the
|
| 25 |
+
archive hash proves the download, the per-file hashes prove the unpack, and a half-populated
|
| 26 |
+
`jniLibs/` is the failure mode that produces a linker error naming a symbol rather than a file.
|
| 27 |
+
|
| 28 |
+
## Contents
|
| 29 |
+
|
| 30 |
+
| file | size | needed for |
|
| 31 |
+
| --- | --- | --- |
|
| 32 |
+
| `mobiletransformers-natives-0.2.0-arm64-v8a.tar.zst` | 63 MB | **Required** to build the Android SDK: ONNX Runtime (training build), the GenAI engine, the tokenizer static libs, and vendored headers. |
|
| 33 |
+
| `onnxruntime_training-1.23.0+cpu-cp312-cp312-linux_x86_64.whl` | 632 MB | Only to export a **training** stage. Source-built, cp312/linux_x86_64 only — it is not on PyPI. |
|
| 34 |
+
| `mobiletransformers-natives-0.2.0-arm64-v8a-debug-symbols.tar.zst` | 261 MB | Optional. The unstripped originals of the shipped `.so` files. Android's build strips them at packaging, so these cost nothing at runtime and are the only way to read a native stack trace. |
|
| 35 |
+
|
| 36 |
+
Every sha256, size, provenance and role is recorded in
|
| 37 |
+
[`third_party/android/manifest.json`](https://github.com/martinkorelic/mobiletransformers/blob/main/third_party/android/manifest.json)
|
| 38 |
+
and
|
| 39 |
+
[`third_party/onnxruntime/manifest.json`](https://github.com/martinkorelic/mobiletransformers/blob/main/third_party/onnxruntime/manifest.json).
|
| 40 |
+
Verify by hand with `sha256sum` if you prefer; the fetch script does it for you either way.
|
| 41 |
+
|
| 42 |
+
## Licensing
|
| 43 |
+
|
| 44 |
+
These are builds of third-party projects — ONNX Runtime, onnxruntime-genai, tokenizers-cpp, protobuf
|
| 45 |
+
— each under its own upstream licence. See
|
| 46 |
+
[`THIRD_PARTY_NOTICES.md`](https://github.com/martinkorelic/mobiletransformers/blob/main/THIRD_PARTY_NOTICES.md).
|
| 47 |
+
The `license: other` tag above reflects that this repo is a mixed bundle of upstream artifacts rather
|
| 48 |
+
than a single licensed work.
|
| 49 |
+
|
| 50 |
+
## arm64-v8a only
|
| 51 |
+
|
| 52 |
+
There is no x86_64 build, so the SDK does not run on a standard Android emulator. `libonnxruntime.so`
|
| 53 |
+
and the tokenizer archives were never built for it; restoring x86_64 means building ONNX Runtime
|
| 54 |
+
Training and tokenizers-cpp for that ABI first.
|