docs: improve README with usage instructions
Browse files- README.md +9 -7
- requirements.txt +1 -1
README.md
CHANGED
|
@@ -13,16 +13,18 @@ short_description: Epistemic stagnation detection via Bayesian surprise
|
|
| 13 |
|
| 14 |
# 🧠 Epistemic Stagnation Monitor
|
| 15 |
|
| 16 |
-
|
| 17 |
|
| 18 |
-
##
|
| 19 |
|
| 20 |
-
|
| 21 |
-
|
| 22 |
-
|
| 23 |
|
| 24 |
## How It Works
|
| 25 |
|
| 26 |
-
|
| 27 |
|
| 28 |
-
|
|
|
|
|
|
|
|
|
| 13 |
|
| 14 |
# 🧠 Epistemic Stagnation Monitor
|
| 15 |
|
| 16 |
+
Detect when an agent gets stuck repeating itself by combining embedding novelty and perplexity into a single "epiplexity" score -- like neural habituation signaling that a brain region has stopped learning.
|
| 17 |
|
| 18 |
+
## What to Try
|
| 19 |
|
| 20 |
+
1. Select a preset from the **Preset** dropdown (e.g. "Gradual stagnation" or "Sudden loop") and click **Run Monitor** to see how the epiplexity score evolves and health status transitions from HEALTHY through STAGNANT to CRITICAL.
|
| 21 |
+
2. Adjust the **Alpha** slider to change the mix between embedding novelty and perplexity, then re-run to see how it affects detection sensitivity.
|
| 22 |
+
3. Try the "Recovery" preset to see how the monitor detects stagnation and then recovers when novel messages resume.
|
| 23 |
|
| 24 |
## How It Works
|
| 25 |
|
| 26 |
+
The EpiplexityMonitor embeds each message and compares it to a sliding window. Epiplexity combines embedding novelty with normalized perplexity -- when this score stays below the threshold for too long, the monitor flags stagnation, triggering healing interventions.
|
| 27 |
|
| 28 |
+
## Learn More
|
| 29 |
+
|
| 30 |
+
[GitHub](https://github.com/coredipper/operon) | [PyPI](https://pypi.org/project/operon-ai/) | [Paper](https://github.com/coredipper/operon/tree/main/article)
|
requirements.txt
CHANGED
|
@@ -1,2 +1,2 @@
|
|
| 1 |
gradio>=4.0
|
| 2 |
-
operon-ai>=0.
|
|
|
|
| 1 |
gradio>=4.0
|
| 2 |
+
operon-ai>=0.15.0
|