From 83592834940754d1cd18c98a78b88adc8b9e3243 Mon Sep 17 00:00:00 2001
From: Aymeric Roucher <69208727+aymeric-roucher@users.noreply.github.com>
Date: Mon, 10 Feb 2025 14:04:12 +0100
Subject: [PATCH] Add small readme to open Deep Research (#581)

Co-authored-by: Albert Villanova del Moral <8515462+albertvillanova@users.noreply.github.com>
---
 examples/open_deep_research/README.md         | 22 +++++++++++++++++++
 examples/open_deep_research/run.py            |  1 +
 .../visual_vs_text_browser.ipynb              |  9 ++++++++
 3 files changed, 32 insertions(+)
 create mode 100644 examples/open_deep_research/README.md

diff --git a/examples/open_deep_research/README.md b/examples/open_deep_research/README.md
new file mode 100644
index 0000000..d2b86ad
--- /dev/null
+++ b/examples/open_deep_research/README.md
@@ -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!"
+```
\ No newline at end of file
diff --git a/examples/open_deep_research/run.py b/examples/open_deep_research/run.py
index b5d047c..4e0ae62 100644
--- a/examples/open_deep_research/run.py
+++ b/examples/open_deep_research/run.py
@@ -108,6 +108,7 @@ def main():
         ArchiveSearchTool(browser),
         TextInspectorTool(model, text_limit),
     ]
+
     text_webbrowser_agent = ToolCallingAgent(
         model=model,
         tools=WEB_TOOLS,
diff --git a/examples/open_deep_research/visual_vs_text_browser.ipynb b/examples/open_deep_research/visual_vs_text_browser.ipynb
index 2eece88..9bb4ee8 100644
--- a/examples/open_deep_research/visual_vs_text_browser.ipynb
+++ b/examples/open_deep_research/visual_vs_text_browser.ipynb
@@ -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,