Rajan Sharma commited on
Commit
eb149cf
·
verified ·
1 Parent(s): e2dfc2b

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +25 -34
README.md CHANGED
@@ -1,35 +1,26 @@
1
- # Clarity Ops — Two-Phase Medical Analytics Engine
2
-
3
- This repo implements a universal, scenario-agnostic medical analytics workflow:
4
-
5
- 1) **Phase 1: Clarification Questions** (<=5, grouped by category)
6
- 2) **Phase 2: Structured Analysis** (schema-validated, unit-checked, math-verified, policy-aligned)
7
-
8
- The engine never invents data. If inputs are missing/ambiguous, it asks for clarifications first.
9
-
10
- ## Quick start
11
-
12
- 1. Populate a scenario in `/packs/<scenario>/` (see `/packs/mdsi` as an example).
13
- 2. (Optional) Put known answers to clarifications in `clarifications.json`.
14
- 3. Run the pipeline (pseudo-call in your orchestration):
15
- - `run_two_phase.run_clarityops("packs/mdsi")`
16
- 4. Review the final JSON. It passes:
17
- - JSON Schema validation
18
- - Unit/range checks
19
- - Math consistency
20
- - Policy/constraints adherence
21
- 5. (Optional) Compare against `/packs/<scenario>/expected.json` with the rule-based grader.
22
-
23
- ## Folder overview
24
- - `/core`: Global medical rules (units, ranges, privacy)
25
- - `/prompts`: System + two-phase user template
26
- - `/schemas`: Output schema for Phase 2
27
- - `/validators`: Hard guardrails (schema/units/math/policy)
28
- - `/graders`: Rule-based grader for gold answers
29
- - `/pipeline`: Two-phase orchestration
30
- - `/packs/<scenario>`: Scenario Pack (inputs, constraints, schema selection, rubric, expected)
31
-
32
- ## Notes
33
- - This repo shows reference Python code for validators and pipeline. Hook the prompts into your LLM runner of choice.
34
- - All numbers are examples unless your scenario pack provides them.
35
 
 
1
+ # ClarityOps (LLM-Only)
2
+
3
+ ClarityOps runs fully inside an LLM chat:
4
+ 1) User pastes a scenario and optionally attaches data files (CSV/XLSX/PDF).
5
+ 2) **Phase 1**: ClarityOps reads everything and asks up to 5 grouped clarification questions.
6
+ 3) User answers in the chat.
7
+ 4) **Phase 2**: ClarityOps produces a validated, structured analysis.
8
+
9
+ No external code, servers, or UI — all interaction is conversational.
10
+
11
+ ## How to use (operator playbook)
12
+
13
+ **Turn 1 (User):** Paste the scenario using `/prompts/user_scenario_template.txt`. Attach any files.
14
+
15
+ **Turn 2 (Model):** ClarityOps returns **Phase 1: Clarification Questions** (≤5, grouped). It stops and waits.
16
+
17
+ **Turn 3 (User):** Reply using `/prompts/answer_clarifications_template.txt`.
18
+
19
+ **Turn 4 (Model):** ClarityOps returns **Phase 2: Structured Analysis** in the exact format from `/prompts/phase2_format.txt`.
20
+
21
+ ### Notes
22
+ - The **system prompt** (`/prompts/system_master.txt`) enforces the two-phase behavior, numerical transparency, units, and medical guardrails.
23
+ - The **schema** (`/schemas/phase2_output.schema.json`) is provided as a reference shape that the model mirrors in Phase 2. (The LLM follows it; there’s no external validator.)
24
+ - The **guardrails** (`/policies/medical_guardrails.md`) define units, ranges, privacy, and recommendation style.
25
+
 
 
 
 
 
 
 
 
 
26