coredipper commited on
Commit
90566a9
·
verified ·
1 Parent(s): 65a5a38

docs: improve README with usage instructions

Browse files
Files changed (2) hide show
  1. README.md +13 -8
  2. requirements.txt +1 -1
README.md CHANGED
@@ -11,15 +11,20 @@ license: mit
11
  short_description: Recover structured data from malformed LLM output
12
  ---
13
 
14
- # Operon Chaperone — Interactive Demo
15
 
16
- Try the Chaperone's multi-strategy cascade for recovering structured data from malformed LLM output:
17
 
18
- 1. **STRICT** Direct JSON parse, no modifications
19
- 2. **EXTRACTION** — Find JSON in markdown blocks, XML tags, or bare objects
20
- 3. **LENIENT** — Type coercion (e.g., `"42"` → `42`)
21
- 4. **REPAIR** — Fix trailing commas, single quotes, Python literals, unquoted keys
22
 
23
- Paste broken JSON, pick a target schema, and watch the cascade recover it.
 
 
24
 
25
- [GitHub](https://github.com/coredipper/operon) | [Paper](https://github.com/coredipper/operon/tree/main/article)
 
 
 
 
 
 
 
11
  short_description: Recover structured data from malformed LLM output
12
  ---
13
 
14
+ # 🧬 Operon Chaperone
15
 
16
+ Recover structured data from malformed LLM output using a multi-strategy cascade -- like protein chaperones refolding misfolded proteins.
17
 
18
+ ## What to Try
 
 
 
19
 
20
+ 1. Open the **Input & Parse** tab, select a schema from the **Target Schema** dropdown (e.g. FunctionCall), paste broken JSON into the input box, and click **Parse** to watch the cascade recover it.
21
+ 2. Toggle individual strategies on or off (STRICT, EXTRACTION, LENIENT, REPAIR) to see which one succeeds for different kinds of malformation.
22
+ 3. Switch to the **Batch Examples** tab and click **Run All Examples** to see the cascade handle trailing commas, single quotes, markdown-wrapped JSON, and more in one pass.
23
 
24
+ ## How It Works
25
+
26
+ The Chaperone tries four folding strategies in order -- strict parsing, extraction from wrappers, lenient type coercion, and structural repair -- stopping at the first success. This mirrors how biological chaperones apply progressively stronger refolding forces to recover functional protein structure.
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,3 +1,3 @@
1
  gradio>=4.0
2
  pydantic>=2.0
3
- operon-ai>=0.14.0
 
1
  gradio>=4.0
2
  pydantic>=2.0
3
+ operon-ai>=0.15.0