serverdaun commited on
Commit
7301bb7
Β·
1 Parent(s): ac640bc

add README.md with project overview, features, usage instructions, tech stack, and setup guide

Browse files
Files changed (1) hide show
  1. README.md +51 -0
README.md CHANGED
@@ -0,0 +1,51 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Deep Research
2
+
3
+ **Deep Research** is an AI-powered research assistant that helps users investigate complex topics by generating clarifying questions, planning web searches, and synthesizing detailed markdown reports.
4
+
5
+ ## Features
6
+
7
+ - **Clarification**: Asks targeted questions to refine the research query.
8
+ - **Planning**: Suggests up to five web searches to address the query.
9
+ - **Web Search**: Summarizes web results for each planned search.
10
+ - **Report Generation**: Produces a comprehensive markdown report with a summary and follow-up questions.
11
+ - **Interactive UI**: Simple Gradio interface for end-to-end research.
12
+
13
+ ## Usage
14
+
15
+ 1. **Input your research topic** in the UI.
16
+ 2. **Answer clarifying questions** (if any).
17
+ 3. **Run the research** to receive a detailed report.
18
+
19
+ ## Tech Stack
20
+
21
+ - Python, Gradio
22
+ - [openai-agents](https://pypi.org/project/openai-agents/) (for agent orchestration)
23
+ - Async/await for non-blocking operations
24
+
25
+ ## File Overview
26
+
27
+ - `main.py` β€” Gradio UI and app entry point
28
+ - `research_manager.py` β€” Orchestrates the research workflow
29
+ - `research_agent.py` β€” Core agent logic and tool coordination
30
+ - `clarifier.py` β€” Generates clarifying questions
31
+ - `planner.py` β€” Plans web search queries
32
+ - `web_search.py` β€” Summarizes web search results
33
+ - `report_generator.py` β€” Creates the final markdown report
34
+
35
+ ## Setup (with [uv](https://github.com/astral-sh/uv))
36
+
37
+ 1. **Install Python 3.12** (if not already installed).
38
+ 2. **Install [uv](https://github.com/astral-sh/uv):**
39
+ ```sh
40
+ pip install uv
41
+ ```
42
+ 3. **Install dependencies:**
43
+ ```sh
44
+ uv pip install -r pyproject.toml
45
+ ```
46
+ 4. **Run the app:**
47
+ ```sh
48
+ uv pip run python src/main.py
49
+ ```
50
+
51
+ The app will launch a Gradio interface in your browser.