Skip to content

Commit

Permalink
Add small readme to open Deep Research (#581)
Browse files Browse the repository at this point in the history
Co-authored-by: Albert Villanova del Moral <[email protected]>
  • Loading branch information
aymeric-roucher and albertvillanova authored Feb 10, 2025
1 parent 75fe8cd commit 8359283
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 0 deletions.
22 changes: 22 additions & 0 deletions examples/open_deep_research/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Open Deep Research

Welcome to this open replication of [OpenAI's Deep Research](https://openai.com/index/introducing-deep-research/)!

Read more about this implementation's goal and methods [in our blog post](https://huggingface.co/blog/open-deep-research).

This agent achieves 55% pass@1 on GAIA validation set, vs 67% for Deep Research.

To install it, first run
```bash
pip install -r requirements.txt
```

And install smolagents dev version
```bash
pip install -e .[dev]
```

Then you're good to go! Run the run.py script, as in:
```bash
python --model-id "o1" --question "Your question here!"
```
1 change: 1 addition & 0 deletions examples/open_deep_research/run.py
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,7 @@ def main():
ArchiveSearchTool(browser),
TextInspectorTool(model, text_limit),
]

text_webbrowser_agent = ToolCallingAgent(
model=model,
tools=WEB_TOOLS,
Expand Down
9 changes: 9 additions & 0 deletions examples/open_deep_research/visual_vs_text_browser.ipynb
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
{
"cells": [
{
"cell_type": "markdown",
"metadata": {},
"source": [
"# Compare a text-based vs a vision-based browser\n",
"\n",
"Warning: this notebook is experimental, it probably won't work out of the box!"
]
},
{
"cell_type": "code",
"execution_count": null,
Expand Down

0 comments on commit 8359283

Please sign in to comment.