docs: clarify empty Hub mirror and canonical energy-attest source
Browse files
README.md
CHANGED
|
@@ -1,28 +1,56 @@
|
|
| 1 |
---
|
| 2 |
license: apache-2.0
|
| 3 |
tags:
|
| 4 |
-
- szl
|
| 5 |
-
- governed-inference
|
| 6 |
-
- energy-attestation
|
| 7 |
-
- receipts
|
|
|
|
|
|
|
| 8 |
---
|
| 9 |
|
| 10 |
# szl-energy-attest
|
| 11 |
|
| 12 |
-
|
|
|
|
|
|
|
| 13 |
|
| 14 |
-
|
| 15 |
|
| 16 |
-
|
| 17 |
|
| 18 |
-
-
|
| 19 |
-
- Absorbs the deprecated `governed-inference-meter` surface (see its Hub card, tagged `deprecated`).
|
| 20 |
-
- Energy labels are typed: `MEASURED` (live meter), `REPORTED` (external context), `UNAVAILABLE` (no meter — recorded as null, never invented).
|
| 21 |
|
| 22 |
-
|
| 23 |
|
| 24 |
-
|
| 25 |
-
- Unsigned receipts are labeled `UNSIGNED` honestly; DSSE/ECDSA-P256 signing rolls in via `szl-receipt`.
|
| 26 |
-
- Locked-proven formula count is exactly **8** `{F1,F4,F7,F11,F12,F18,F19,F22}`.
|
| 27 |
|
| 28 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
---
|
| 2 |
license: apache-2.0
|
| 3 |
tags:
|
| 4 |
+
- szl
|
| 5 |
+
- governed-inference
|
| 6 |
+
- energy-attestation
|
| 7 |
+
- receipts
|
| 8 |
+
- source-pointer
|
| 9 |
+
- no-implementation-here
|
| 10 |
---
|
| 11 |
|
| 12 |
# szl-energy-attest
|
| 13 |
|
| 14 |
+
> **SOURCE POINTER · HUB MIRROR EMPTY · NOT AN INSTALLABLE IMPLEMENTATION**
|
| 15 |
+
>
|
| 16 |
+
> This Hugging Face repository is a public pointer to the canonical `szl-energy-attest` source. The canonical source's `HUB_MIRROR_STATUS.json` records this Hub artifact as `MIRROR_EMPTY` on 2026-09-04. Do not infer that package files, tests, a Kernel Hub loader, or a runnable implementation are published here.
|
| 17 |
|
| 18 |
+
## Canonical implementation
|
| 19 |
|
| 20 |
+
The maintained implementation, test suite, examples, migration evidence, and package manifest are in the canonical GitHub repository:
|
| 21 |
|
| 22 |
+
https://github.com/szl-holdings/szl-energy-attest
|
|
|
|
|
|
|
| 23 |
|
| 24 |
+
The source repository contains `pyproject.toml`, `szl_energy_attest/`, `energy_core/`, `examples/`, `tests/`, `MIGRATION_PROVENANCE.json`, `SPEC.md`, and CI that installs pytest plus the pinned `szl-receipt` dependency before running `pytest -q`.
|
| 25 |
|
| 26 |
+
## What the canonical source provides
|
|
|
|
|
|
|
| 27 |
|
| 28 |
+
- NVML-backed energy attestation when a live meter is available.
|
| 29 |
+
- Honest null / unavailable energy fields when no meter is available.
|
| 30 |
+
- Tokens-per-joule only when joules are actually measured.
|
| 31 |
+
- Tamper-evident receipt-chain support.
|
| 32 |
+
- Optional signing and interop paths through `szl-receipt`.
|
| 33 |
+
- Migration evidence for the deprecated `governed-inference-meter` surface.
|
| 34 |
+
|
| 35 |
+
This Hub card does not itself establish that any of those interfaces are loadable from Hugging Face, currently tested, runnable in a particular environment, or producing measured energy on your hardware.
|
| 36 |
+
|
| 37 |
+
## Evidence boundary
|
| 38 |
+
|
| 39 |
+
```text
|
| 40 |
+
Hub repository = source pointer / mirror-empty record
|
| 41 |
+
Canonical source = GitHub repository named above
|
| 42 |
+
NVML joules = measured only when a live compatible meter is available
|
| 43 |
+
No meter = UNAVAILABLE / null; never fabricated
|
| 44 |
+
Λ aggregation = Conjecture 1; advisory, never a theorem
|
| 45 |
+
Unsigned receipt = UNSIGNED; never represented as signed
|
| 46 |
+
```
|
| 47 |
+
|
| 48 |
+
## Legacy relationship
|
| 49 |
+
|
| 50 |
+
`governed-inference-meter` is deprecated. It remains a historical tombstone and must not be used as new integration guidance. The canonical successor source is `szl-energy-attest`; consult its migration evidence before changing an existing integration.
|
| 51 |
+
|
| 52 |
+
## Use boundary
|
| 53 |
+
|
| 54 |
+
Do not treat this Hub repository as a model, checkpoint, benchmark, deployment, current runtime-status assertion, or energy-performance claim. Follow the canonical source and its tests for installation, verification, and migration instructions.
|
| 55 |
+
|
| 56 |
+
Apache-2.0.
|