Skip to content

Commit 2336df4

Browse files
Update README.md
1 parent 188838b commit 2336df4

File tree

1 file changed

+64
-40
lines changed

1 file changed

+64
-40
lines changed

README.md

Lines changed: 64 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,60 +1,84 @@
1-
---
2-
title: Penguin Distortion Tester
3-
sdk: gradio
4-
app_file: gradio_demo.py
5-
pinned: false
6-
license: mit
7-
---
8-
91
Penguin Distortion Tester (v560L • CKMM • Disclose)
102

11-
Quickstart
12-
1) python3.11 -m venv .venv
13-
2) source .venv/bin/activate
14-
3) python -m pip install --upgrade pip
15-
4) pip install -r requirements.txt
16-
5) python gradio_demo.py --summary --ckmm-iterations 100000 --server_port 7860
3+
[![CI](https://github.com/stuck-inadream/penguin-tester/actions/workflows/ci.yml/badge.svg)](https://github.com/stuck-inadream/penguin-tester/actions)
4+
[![HF Space](https://img.shields.io/badge/%F0%9F%A4%97%20Spaces-Penguin%20Distortion%20Tester-blue)](https://huggingface.co/spaces/stuck-inadream/penguin-distortion-tester)
5+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
176

18-
Open http://127.0.0.1:7860
19-
For a public link add: --share
20-
Tested on macOS with Python 3.11
217

22-
### Public share
23-
Run with `--share` to get a temporary gradio.live URL.
8+
Overview
9+
The Penguin Distortion Tester is a minimal, public-safe harness to audit symbolic distortion on a toy “Penguin” task.
10+
It demonstrates sat/unsat behavior (via Z3) and reports CKMM-L context metrics across five layers:
11+
Fuel (Energy–Resource): wall time, peak KiB (tracemalloc), and human-attention ticks
2412

25-
---
2613

27-
### Penguin Distortion Tester — how to run
14+
Temporal Coherence: replay stability ratio
15+
Relational Field: council agreement vs. drift (majority vote placeholder)
16+
Ethical Constraints: regex penalties + recovery flag
17+
Embodiment: device/substrate capture with validated hint
2818

29-
[![HF Space](https://img.shields.io/badge/%F0%9F%A4%97%20Spaces-Penguin%20Distortion%20Tester-blue)](https://huggingface.co/spaces/stuck-inadream/penguin-distortion-tester)
19+
This repo is a disclose build: it lists exactly what a prior reviewer saw — no more, no less — and keeps proprietary weighting/heuristics private.
3020

31-
#### Local quickstart
32-
```bash
33-
# from repo root
34-
python3.11 -m venv .venv && source .venv/bin/activate
21+
Quickstart
22+
python3.11 -m venv .venv
23+
source .venv/bin/activate
24+
python -m pip install --upgrade pip
3525
pip install -r requirements.txt
3626

37-
# run (auto-summarize UI, 100k iterations, choose a port)
27+
# Run: summarize UI, 100k iterations, choose a port
3828
env PYTHONUNBUFFERED=1 python gradio_demo.py --summary --ckmm-iterations 100000 --server_port 7860
3929

40-
md
30+
Open http://127.0.0.1:7860 in your browser.
31+
Use --share for a temporary public link.
32+
⚠️ Heads-up: --share exposes a public URL. Treat it as untrusted. Do not upload sensitive data.
33+
34+
Features (Public-Safe)
35+
“Penguin” symbolic check (baseline sat, forced unsat via contradiction trigger)
36+
Distortion score toy formula: modal × diversity (with toy numbers disclosed below)
37+
CKMM-L interfaces only (no proprietary internals)
38+
Configurable workload and thresholds:
39+
--ckmm-iterations N (CPU loop, default documented)
40+
--ckmm-thresholds '{"fuel":{"max_time_s":2.0}}' (JSON Schema-validated)
41+
--ckmm-verbose (pretty JSON output)
42+
43+
44+
Logging: rotating errors.log + console log level
45+
CI: pytest via GitHub Actions
4146

42-
---
4347

44-
### Penguin Distortion Tester — how to run
48+
Public Disclosure Parity Appendix
49+
Score formula: modal × diversity; diversity = avg edit distance; toy values 0.33 × 2 = 0.66
50+
Load fractions: 1.0 / 0.6 / 0.7, divergence = 0.3
51+
HSIL policy names: prefer_specific_over_general, safety_first, audit_bias
52+
Z3 baseline sat; forced contradiction → unsat; heatmap.png modal plot
53+
Gradio flags (server name/port), log level, rotating logs
54+
CI + tests, CKMM-L interfaces (fuel / temporal / council / ethics / embodiment)
4555

46-
[![HF Space](https://img.shields.io/badge/%F0%9F%A4%97%20Spaces-Penguin%20Distortion%20Tester-blue)](https://huggingface.co/spaces/stuck-inadream/penguin-distortion-tester)
56+
Not disclosed: proprietary weighting/aggregation schemes, true diversity/council math beyond placeholders, production energy models, or internal heuristics.
4757

48-
#### Local quickstart
49-
```bash
50-
# from repo root
51-
python3.11 -m venv .venv && source .venv/bin/activate
58+
FAQ
59+
Is this just a toy?
60+
Yes — by design. It’s a teaching harness: easy to run, safe to share, useful for audits.
61+
Can I tune workloads?
62+
Yes — use --ckmm-iterations (e.g., 5_000_000 for measurable fuel) and JSON thresholds.
63+
Does --share upload my data?
64+
No uploads unless you explicitly make them. --share only exposes a temporary Gradio URL. Treat it as public.
65+
66+
Development & Tests
5267
pip install -r requirements.txt
68+
pytest -q
5369

54-
# run (auto-summarize UI, 100k iterations, choose a port)
55-
env PYTHONUNBUFFERED=1 python gradio_demo.py --summary --ckmm-iterations 100000 --server_port 7860
70+
pip install -r requirements.txt
71+
pytest -q
72+
73+
MIT © stuck-inadream
74+
75+
Roadmap & Contributions
76+
Add screenshot(s) of the UI (docs/screenshot.png)
77+
Pin dependencies in requirements.txt for CI stability
78+
CI improvements: multi-stage (lint then test) with pip cache
79+
Optional: package-ready entry point (pyproject.toml) for pipx run penguin-tester
5680

57-
``` ← closes the code block (type three backticks)
58-
MD ← closes the heredoc
81+
Contributions welcome! See CONTRIBUTING.md (to be added).
5982

60-
```
83+
Screenshot
84+
<img width="1234" height="750" alt="Screenshot 2025-09-21 at 9 28 02 AM" src="https://github.com/user-attachments/assets/3d0d0b21-539d-4f63-90b1-67b719130949" />

0 commit comments

Comments
 (0)