lite-deep-researcher

Python 3.12+ License: MIT

Come from Open Source, Back to Open Source

lite-deep-researcher is a community-driven AI automation framework that builds upon the incredible work of the open source community. Our goal is to combine language models with specialized tools for tasks like web search, crawling, and Python code execution, while giving back to the community that made this possible.

Quick Start

# Clone the repository
git clone https://github.com/hetaoBackend/lite-deep-researcher.git
cd lite-deep-researcher

# Install dependencies, uv will take care of the python interpreter and venv creation
uv sync

# Configure .env
cp .env.example .env

# Configure config.yaml
cp config.yaml.example config.yaml

# Run the project
uv run main.py

Development

Testing

Run the test suite:

# Run all tests
make test

# Run specific test file
pytest tests/integration/test_workflow.py

# Run with coverage
make coverage

Code Quality

# Run linting
make lint

# Format code
make format

Architecture

lite-deep-researcher implements a modular multi-agent system architecture designed for automated research and code analysis. The system is built on LangGraph, enabling a flexible state-based workflow where components communicate through a well-defined message passing system.

Architecture Diagram

The system employs a streamlined workflow with the following components:

  1. Coordinator: The entry point that manages the workflow lifecycle

    • Initiates the research process based on user input
    • Delegates tasks to the planner when appropriate
    • Acts as the primary interface between the user and the system
  2. Planner: Strategic component for task decomposition and planning

    • Analyzes research objectives and creates structured execution plans
    • Determines if enough context is available or if more research is needed
    • Manages the research flow and decides when to generate the final report
  3. Research Team: A collection of specialized agents that execute the plan:

    • Researcher: Conducts web searches and information gathering using tools like Tavily and web crawling
    • Coder: Handles code analysis, execution, and technical tasks using Python REPL and Bash tools Each agent has access to specific tools optimized for their role and operates within the LangGraph framework
  4. Reporter: Final stage processor for research outputs

    • Aggregates findings from the research team
    • Processes and structures the collected information
    • Generates comprehensive research reports

Examples

The following examples demonstrate the capabilities of lite-deep-researcher:

Research Reports

  1. What is MCP? - A comprehensive analysis of the term "MCP" across multiple contexts

    • Explores Model Context Protocol in AI, Monocalcium Phosphate in chemistry, and Micro-channel Plate in electronics
    • View full report
  2. Bitcoin Price Fluctuations - Analysis of recent Bitcoin price movements

    • Examines market trends, regulatory influences, and technical indicators
    • Provides recommendations based on historical data
    • View full report
  3. What is LLM? - An in-depth exploration of Large Language Models

    • Discusses architecture, training, applications, and ethical considerations
    • View full report

To run these examples or create your own research reports, you can use the following commands:

# Run with a specific query
uv run main.py "What factors are influencing AI adoption in healthcare?"

# Run with custom planning parameters
uv run main.py --max_plan_iterations 3 "How does quantum computing impact cryptography?"

# Or run interactively
uv run main.py

# View all available options
uv run main.py --help

Command Line Arguments

The application supports several command-line arguments to customize its behavior:

  • query: The research query to process (can be multiple words)
  • --max_plan_iterations: Maximum number of planning cycles (default: 1)
  • --max_step_num: Maximum number of steps in a research plan (default: 3)
  • --debug: Enable detailed debug logging

License

This project is open source and available under the MIT License.

Acknowledgments

Special thanks to all the open source projects and contributors that make lite-deep-researcher possible. We stand on the shoulders of giants.

In particular, we want to express our deep appreciation for:

  • LangChain for their exceptional framework that powers our LLM interactions and chains
  • LangGraph for enabling our sophisticated multi-agent orchestration

These amazing projects form the foundation of lite-deep-researcher and demonstrate the power of open source collaboration.

Description
No description provided
Readme MIT 5.8 MiB
Languages
TypeScript 64.4%
Python 30.3%
CSS 3.2%
JavaScript 1.2%
Dockerfile 0.4%
Other 0.4%