Tonic commited on
Commit
67341ab
·
unverified ·
1 Parent(s): 40aa8de

Add architecture section to README

Browse files

Added architecture section detailing Vertical Slice Architecture and its components.

Signed-off-by: Tonic <[email protected]>

Files changed (1) hide show
  1. .github/README.md +15 -18
.github/README.md CHANGED
@@ -81,7 +81,14 @@ Add this to your `claude_desktop_config.json`:
81
  - `analyze_hypothesis`: Secure statistical analysis using Modal sandboxes.
82
 
83
 
84
- ## Deep Research Flows
 
 
 
 
 
 
 
85
 
86
  - iterativeResearch
87
  - deepResearch
@@ -89,6 +96,7 @@ Add this to your `claude_desktop_config.json`:
89
 
90
  ### Iterative Research
91
 
 
92
  sequenceDiagram
93
  participant IterativeFlow
94
  participant ThinkingAgent
@@ -121,10 +129,12 @@ sequenceDiagram
121
  JudgeHandler-->>IterativeFlow: should_continue
122
  end
123
  end
 
124
 
125
 
126
  ### Deep Research
127
 
 
128
  sequenceDiagram
129
  actor User
130
  participant GraphOrchestrator
@@ -159,8 +169,10 @@ sequenceDiagram
159
  end
160
 
161
  GraphOrchestrator->>User: AsyncGenerator[AgentEvent]
 
162
 
163
  ### Research Team
 
164
  Critical Deep Research Agent
165
 
166
  ## Development
@@ -177,22 +189,7 @@ uv run pytest
177
  make check
178
  ```
179
 
180
- ## Architecture
181
-
182
- DeepCritical uses a Vertical Slice Architecture:
183
-
184
- 1. **Search Slice**: Retrieving evidence from PubMed, ClinicalTrials.gov, and bioRxiv.
185
- 2. **Judge Slice**: Evaluating evidence quality using LLMs.
186
- 3. **Orchestrator Slice**: Managing the research loop and UI.
187
-
188
- Built with:
189
- - **PydanticAI**: For robust agent interactions.
190
- - **Gradio**: For the streaming user interface.
191
- - **PubMed, ClinicalTrials.gov, bioRxiv**: For biomedical data.
192
- - **MCP**: For universal tool access.
193
- - **Modal**: For secure code execution.
194
-
195
- ## Team
196
 
197
  - The-Obstacle-Is-The-Way
198
  - MarioAderman
@@ -200,4 +197,4 @@ Built with:
200
 
201
  ## Links
202
 
203
- - [GitHub Repository](https://github.com/The-Obstacle-Is-The-Way/DeepCritical-1)
 
81
  - `analyze_hypothesis`: Secure statistical analysis using Modal sandboxes.
82
 
83
 
84
+
85
+ ## Architecture
86
+
87
+ DeepCritical uses a Vertical Slice Architecture:
88
+
89
+ 1. **Search Slice**: Retrieving evidence from PubMed, ClinicalTrials.gov, and bioRxiv.
90
+ 2. **Judge Slice**: Evaluating evidence quality using LLMs.
91
+ 3. **Orchestrator Slice**: Managing the research loop and UI.
92
 
93
  - iterativeResearch
94
  - deepResearch
 
96
 
97
  ### Iterative Research
98
 
99
+ ```mermaid
100
  sequenceDiagram
101
  participant IterativeFlow
102
  participant ThinkingAgent
 
129
  JudgeHandler-->>IterativeFlow: should_continue
130
  end
131
  end
132
+ ```
133
 
134
 
135
  ### Deep Research
136
 
137
+ ```mermaid
138
  sequenceDiagram
139
  actor User
140
  participant GraphOrchestrator
 
169
  end
170
 
171
  GraphOrchestrator->>User: AsyncGenerator[AgentEvent]
172
+ ```
173
 
174
  ### Research Team
175
+
176
  Critical Deep Research Agent
177
 
178
  ## Development
 
189
  make check
190
  ```
191
 
192
+ ## Join Us
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
193
 
194
  - The-Obstacle-Is-The-Way
195
  - MarioAderman
 
197
 
198
  ## Links
199
 
200
+ - [GitHub Repository](https://github.com/The-Obstacle-Is-The-Way/DeepCritical-1)