github-actions[bot] commited on
Commit
bcb9c4f
Β·
1 Parent(s): c895509

Update README for HF Space

Browse files
Files changed (1) hide show
  1. README.md +36 -119
README.md CHANGED
@@ -1,138 +1,55 @@
1
- # Agentic Market Research Orchestrator
2
-
3
- [![Python 3.12](https://img.shields.io/badge/python-3.12-blue.svg)](https://www.python.org/downloads/release/python-3120/)
4
- [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
5
- [![Code Style: Ruff](https://img.shields.io/badge/code%20style-ruff-000000.svg)](https://github.com/astral-sh/ruff)
6
- [![Docker](https://img.shields.io/badge/docker-%230db7ed.svg?style=flat&logo=docker&logoColor=white)](https://www.docker.com/)
7
- [![Hugging Face Spaces](https://img.shields.io/badge/%F0%9F%A4%97%20Hugging%20Face-Spaces-blue)](https://huggingface.co/spaces/pkgprateek/agentic-market-research)
8
-
9
- > **Enterprise-grade multi-agent system for automated competitive intelligence.**
10
- > Delivers comprehensive market research reports in 15 minutes at <1% of the cost of traditional methods.
11
-
12
  ---
13
 
14
- ## πŸš€ Overview
15
-
16
- The **Agentic Market Research Orchestrator** is a sophisticated AI system designed to automate the labor-intensive process of competitive market analysis. By orchestrating a team of specialized AI agents, it transforms a simple company name into a strategic intelligence report, covering SWOT analysis, competitor landscape, and market positioning.
17
-
18
- **Key Value Proposition:**
19
- * **Speed:** Reduces research time from 20+ hours to ~15 minutes (80x faster).
20
- * **Cost Efficiency:** Lowers cost from ~$3,000 to $0.50-$2.00 per report (1500x cheaper).
21
- * **Scalability:** Standardized, reproducible outputs suitable for high-volume analysis.
22
-
23
- ## πŸ—οΈ Architecture
24
-
25
- The system utilizes a **LangGraph** state machine to coordinate three specialized agents, ensuring a robust and fault-tolerant workflow.
26
-
27
- ```mermaid
28
- graph LR
29
- Input[User Input] --> Research[Research Agent]
30
- Research --> Analysis[Analysis Agent]
31
- Analysis --> Writer[Writer Agent]
32
- Writer --> Report[Final Intelligence Report]
33
-
34
- Research -.->|Tavily API| Web[Live Web Search]
35
- Analysis -.->|LLM| Inference[Contextual Analysis]
36
- Writer -.->|LLM| Formatting[Markdown Generation]
37
-
38
- style Research fill:#e1f5fe,stroke:#01579b
39
- style Analysis fill:#fff3e0,stroke:#ef6c00
40
- style Writer fill:#f3e5f5,stroke:#7b1fa2
41
- ```
42
-
43
- ### Agent Roles
44
- 1. **Research Agent:** Executes targeted web searches using Tavily API to gather raw data on competitors, pricing, and features.
45
- 2. **Analysis Agent:** Synthesizes raw data into structured insights, performing SWOT and gap analysis.
46
- 3. **Writer Agent:** Compiles insights into a professional, citation-backed Markdown report.
47
-
48
- ## πŸ› οΈ Tech Stack
49
-
50
- * **Orchestration:** [LangGraph](https://langchain-ai.github.io/langgraph/) (State management & coordination)
51
- * **LLM Integration:** [OpenRouter](https://openrouter.ai/) (Access to Claude 3.5 Sonnet, GPT-4o, etc.)
52
- * **Search:** [Tavily AI](https://tavily.com/) (Optimized for LLM research)
53
- * **Backend:** [FastAPI](https://fastapi.tiangolo.com/) (Async REST API)
54
- * **Frontend:** [Gradio](https://www.gradio.app/) (Interactive UI)
55
- * **Infrastructure:** Docker & Docker Compose
56
-
57
- ## ⚑ Quick Start
58
-
59
- ### Prerequisites
60
- * Python 3.12+
61
- * Docker (optional)
62
- * API Keys: OpenRouter, Tavily
63
-
64
- ### Local Installation
65
-
66
- 1. **Clone the repository:**
67
- ```bash
68
- git clone https://github.com/pkgprateek/agentic-market-research.git
69
- cd agentic-market-research
70
- ```
71
-
72
- 2. **Set up environment:**
73
- ```bash
74
- python -m venv venv
75
- source venv/bin/activate
76
- pip install uv && uv pip install -r requirements.txt
77
- ```
78
-
79
- 3. **Configure credentials:**
80
- ```bash
81
- cp .env.example .env
82
- # Edit .env with your OPENROUTER_API_KEY and TAVILY_API_KEY
83
- ```
84
-
85
- 4. **Run the application:**
86
- ```bash
87
- # Run
88
- python src/ui/app.py
89
- # Open http://localhost:7860
90
- ```
91
-
92
- ### Docker Deployment
93
 
94
- ```bash
95
- docker-compose up --build
96
- ```
97
 
98
- ## πŸ§ͺ Testing & Quality Assurance
99
 
100
- This project maintains high code quality standards with comprehensive testing and linting.
101
 
102
- ## Testing
 
 
 
 
 
103
 
104
- Run the full test suite (Linting, Type Checking, Unit & Integration Tests):
105
 
106
- ```bash
107
- ./scripts/run_all_tests.sh
108
- ```
109
 
110
- Or run individually:
 
 
111
 
112
- ```bash
113
- ruff check src/ tests/ # Linting
114
- mypy src/ # Type Checking
115
- pytest tests/unit/ -v # Unit Tests
116
- pytest tests/integration/ -v # Integration Tests
117
- ```
118
 
119
- ## πŸ“Š Performance Metrics
120
 
121
- | Metric | Manual Analyst | Agentic Orchestrator | Improvement |
122
- | :--- | :--- | :--- | :--- |
123
- | **Time to Report** | 20 Hours | 15 Minutes | **80x** |
124
- | **Cost per Report** | ~$3,000 | ~$1.50 | **2000x** |
125
- | **Consistency** | Variable | High | **Standardized** |
126
 
127
- ## 🀝 Contributing
128
 
129
- Contributions are welcome! Please feel free to submit a Pull Request.
130
 
131
- ## πŸ“„ License
 
 
 
132
 
133
- This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
134
 
135
  ---
136
 
137
- **Built by Prateek Kumar Goel**
138
- [GitHub](https://github.com/pkgprateek) | [LinkedIn](https://linkedin.com/in/pkgprateek)
 
1
+ ---
2
+ title: Agentic Market Research
3
+ emoji: πŸ”
4
+ colorFrom: blue
5
+ colorTo: purple
6
+ sdk: docker
7
+ sdk_version: "5.0.0"
8
+ app_file: src/ui/app.py
9
+ pinned: false
 
 
10
  ---
11
 
12
+ # Agentic Market Research
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
13
 
14
+ Multi-agent AI system for automated competitive intelligence. 80x faster than manual research.
 
 
15
 
16
+ ## What It Does
17
 
18
+ Enter any company or product name β†’ Get comprehensive market intelligence report in 15 minutes.
19
 
20
+ **Includes:**
21
+ - Competitor landscape analysis
22
+ - SWOT assessment
23
+ - Market positioning
24
+ - Strategic recommendations
25
+ - Professional citations
26
 
27
+ ## How It Works
28
 
29
+ Three specialized AI agents work in sequence:
 
 
30
 
31
+ 1. **Research Agent** - Web search + data gathering
32
+ 2. **Analysis Agent** - SWOT + competitive analysis
33
+ 3. **Writer Agent** - Professional report generation
34
 
35
+ Powered by LangGraph orchestration with real-time cost tracking.
 
 
 
 
 
36
 
37
+ ## Cost
38
 
39
+ - Free tier (Grok): $0.00
40
+ - Production (Claude 4.5): $1-2 per analysis
 
 
 
41
 
42
+ vs $3,000 for manual research.
43
 
44
+ ## Technology
45
 
46
+ - LangGraph for multi-agent coordination
47
+ - OpenRouter for LLM access (400+ models)
48
+ - Tavily API for web search
49
+ - FastAPI + Gradio deployment
50
 
51
+ **Source code:** [github.com/pkgprateek/agentic-market-research](https://github.com/pkgprateek/agentic-market-research)
52
 
53
  ---
54
 
55
+ Built by **Prateek Kumar Goel**