Skip to content

Commit be94612

Browse files
Update Open Deep Research's README.md (huggingface#763)
Co-authored-by: Aymeric Roucher <[email protected]>
1 parent 023bab2 commit be94612

File tree

1 file changed

+25
-12
lines changed

1 file changed

+25
-12
lines changed

examples/open_deep_research/README.md

+25-12
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,38 @@
11
# Open Deep Research
22

3-
Welcome to this open replication of [OpenAI's Deep Research](https://openai.com/index/introducing-deep-research/)!
3+
Welcome to this open replication of [OpenAI's Deep Research](https://openai.com/index/introducing-deep-research/)! This agent attempts to replicate OpenAI's model and achieve similar performance on research tasks.
44

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

7-
This agent achieves 55% pass@1 on GAIA validation set, vs 67% for Deep Research.
7+
8+
This agent achieves **55% pass@1** on the GAIA validation set, compared to **67%** for the original Deep Research.
89

910
## Setup
1011

11-
### Installation
12+
To get started, follow the steps below:
1213

13-
To install it, first run
14-
```bash
15-
pip install -r requirements.txt
16-
```
14+
### Clone the repository
1715

18-
And install smolagents dev version
1916
```bash
20-
pip install -e ../../.[dev]
17+
git clone https://github.com/huggingface/smolagents.git
18+
cd smolagents/examples/open_deep_research
2119
```
2220

23-
### Environment variables
21+
### Install dependencies
22+
23+
Run the following command to install the required dependencies from the `requirements.txt` file:
24+
25+
```bash
26+
pip install -r requirements.txt
27+
```
28+
29+
### Install the development version of `smolagents`
30+
31+
```bash
32+
pip install -e ../../.[dev]
33+
```
34+
35+
### Set up environment variables
2436

2537
The agent uses the `GoogleSearchTool` for web search, which requires an environment variable with the corresponding API key, based on the selected provider:
2638
- `SERPAPI_API_KEY` for SerpApi: [Sign up here to get a key](https://serpapi.com/users/sign_up)
@@ -33,9 +45,10 @@ For example, to use the default `o1` model, you need to set the `OPENAI_API_KEY`
3345
> [!WARNING]
3446
> The use of the default `o1` model is restricted to tier-3 access: https://help.openai.com/en/articles/10362446-api-access-to-o1-and-o3-mini
3547
48+
3649
## Usage
3750

3851
Then you're good to go! Run the run.py script, as in:
3952
```bash
4053
python run.py --model-id "o1" "Your question here!"
41-
```
54+
```

0 commit comments

Comments
 (0)