RFTSystems commited on
Commit
d089458
·
verified ·
1 Parent(s): d0b9a0c

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +59 -38
README.md CHANGED
@@ -10,58 +10,79 @@ pinned: false
10
  license: other
11
  short_description: Live coherence + throughput benchmark (no precomputed result
12
  thumbnail: >-
13
- https://cdn-uploads.huggingface.co/production/uploads/685edcb04796127b024b4805/Sr9bUuYsRuDtVZnb-
14
-
15
  ---
16
- # Coherent_Compute_Engine
17
 
18
- A real-time, on-machine benchmark that measures coherent state-update throughput and produces a tamper-evident receipt for every run.
 
 
19
 
20
- ## What it does
21
- - Runs a coherent update kernel over **N oscillators** for **S steps**
22
- - Measures:
23
- - **Throughput** (B/s = billions of items per second)
24
- - **Coherence** (|C| stability proxy)
25
- - **Mean Energy** (bounded mean of E)
26
- - **Elapsed time**
27
- - Produces a **downloadable receipt** (JSON) containing inputs, environment, outputs, and a **SHA-256** hash.
28
 
29
  ## What an “item” is
30
- **1 item = one per-oscillator coherent state update of `[Psi, E, L]` per step**, as implemented in this Space.
31
 
32
- This definition is explicit so the metric is reproducible.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
33
 
34
- ## Verification / receipts
35
- Each run writes a receipt JSON under `results/` and exposes it via the UI.
36
- The receipt includes:
37
- - timestamp (UTC)
38
- - app version
39
- - platform + python
40
- - logical CPU count
41
- - inputs (N, steps, seed, scale)
42
- - measured outputs
43
- - SHA-256 hash of the canonical receipt JSON
44
 
45
- This makes runs easy to share and tamper-evident.
46
 
47
- ## Baselines (optional)
48
- If enabled, the Space also measures:
49
- - live **NumPy** baseline (vectorised)
50
- - tiny **Python loop** baseline (hard safety caps)
51
 
52
- If `numba` is available, the primary engine automatically uses a Numba JIT kernel.
53
 
54
- ## Important note about “your CPU”
55
- Hugging Face Spaces run on hosted hardware. The results reflect the **Space runtime**, not the visitor’s laptop CPU.
56
 
57
- If you want your own machine’s numbers, run the repo locally.
 
 
 
58
 
59
- ## Files
60
- - `app.py` Gradio app + benchmark + receipt writer
61
- - `results/` — receipts + `runs.csv` (created automatically)
 
62
 
63
- ## Licence
64
- Please read LICENCE, listed in repo
65
 
 
66
 
 
 
67
  Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
10
  license: other
11
  short_description: Live coherence + throughput benchmark (no precomputed result
12
  thumbnail: >-
13
+ https://cdn-uploads.huggingface.co/production/uploads/685edcb04796127b024b4805/
14
+
15
  ---
 
16
 
17
+ # README.md Coherent Compute Engine
18
+
19
+ **Coherent Compute Engine** is a live benchmark Space that measures **real** compute throughput and stability for a coherent state update rule — with **no precomputed results** and **no estimates**.
20
 
21
+ It’s designed to be understandable, verifiable, and brutally honest:
22
+ - Everything is computed **now**, on the Space machine.
23
+ - Baselines (Python loop + vectorised NumPy) are measured **live** on the **same machine**.
24
+ - Results can be downloaded as a **receipt** (JSON) with a SHA-256 hash.
 
 
 
 
25
 
26
  ## What an “item” is
 
27
 
28
+ **One item = one coherent update of `[Ψ, E, L]` per oscillator per step.**
29
+
30
+ So:
31
+
32
+ `items/sec = (N oscillators × steps) / elapsed_seconds`
33
+
34
+ We report throughput in **billions of items/sec** (“B/s”).
35
+
36
+ ## What this Space measures
37
+
38
+ For the chosen oscillator count and step count, it reports:
39
+
40
+ - **Throughput (B/s)**: billions of coherent updates per second
41
+ - **Coherence (|C|)**: a stability proxy computed from a normalised dot product of sampled `Ψ` before/after
42
+ - **Mean Energy**: bounded mean proxy from `E` in `[0, 1.5]`
43
+ - **Elapsed Time (s)**
44
+ - **Engine**: `numba` when available; otherwise `numpy`
45
+ - **Verification baselines (optional)**:
46
+ - **Baseline (Vectorised NumPy)**
47
+ - **Baseline (Python loop, capped)** — safety-capped and subset-based to keep the Space responsive
48
+ - **Speedup factors** vs those baselines
49
+
50
+ ## Receipts: verification you can download
51
+
52
+ Each run emits a small JSON “receipt” containing:
53
+ - input settings (N, steps)
54
+ - engine name
55
+ - measured metrics
56
+ - runtime info
57
+ - **SHA-256 hash** of the canonical JSON
58
 
59
+ This supports the “don’t trust it, verify it” approach.
 
 
 
 
 
 
 
 
 
60
 
61
+ ## Why baselines exist (and why they’re not a contest)
62
 
63
+ Baselines are **verification anchors**:
64
+ - They show what “normal” Python looks like (slow floor)
65
+ - They show what vectorised NumPy looks like (standard reference)
66
+ - They show what the engine path achieved under the same rules
67
 
68
+ No claims about beating GPUs or other systems. Just measured, reproducible data.
69
 
70
+ ## Running locally
 
71
 
72
+ ```bash
73
+ pip install -r requirements.txt
74
+ python app.py
75
+ Safety rails
76
 
77
+ To keep the Space stable:
78
+ • oscillator count is clamped to a safe max
79
+ • steps are clamped
80
+ • Python loop baseline is time-capped and subset-based
81
 
82
+ That ensures the Space stays responsive while still measuring real throughput.
 
83
 
84
+
85
 
86
+ Built by RFTSystems.
87
+
88
  Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference