Skip to content

romilly/llama-4-researcher

 
 

Repository files navigation

LlamaResearcher🔍

Turn topics into essays in seconds!

If you find LlamaResearcher userful, please consider to donate and support the project:

GitHub Sponsors Badge

LlamaResearcher Logo

LlamaResearcher is your friendly research companion built on top of Llama 4, powered by Groq, LinkUp, LlamaIndex, Gradio, FastAPI and Redis.

Install and launch🚀

Required: Docker and docker compose

The first step, common to both the Docker and the source code setup approaches, is to clone the repository and access it:

git clone https://github.com/AstraBert/llama-4-researcher.git
cd llama-4-researcher

Once there, you can follow this approach

mv .env.example .env
  • Or do it manually:
docker compose up -f compose.local.yaml llama_redis -d
docker compose up -f compose.local.yaml llama_app -d

You will see the application running on http://localhost:8000 and you will be able to use it. Depending on your connection and on your hardware, the set up might take some time (up to 15 mins to set up) - but this is only for the first time your run it!

How it works

Database services

  • Redis is used for API rate limiting control

Workflow

workflow

  • Your request is first deemed safe or not by a guardi model, llama-3-8b-guard provided by Groq
  • If the prompt is safe, we proceed by routing it to the ResearcherAgent, which is a function calling agent
  • The ResearcherAgent first expands the query into three sub-queries, that will be used for web search
  • The web is deep-searched for every sub-query with LinkUp
  • The information retrieved from the web is evaluated for relevancy against the original user prompt
  • Once the agent gathered all the information, it writes the final essay and it returns it to the user

Contributing

Contributions are always welcome! Follow the contributions guidelines reported here.

License and rights of usage

The software is provided under MIT license.

About

Turn topics into essays in seconds!

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 97.1%
  • Shell 1.7%
  • Dockerfile 1.2%