leifh commited on
Commit
e0248f8
·
1 Parent(s): da6afb9
Files changed (1) hide show
  1. README.md +13 -54
README.md CHANGED
@@ -1,54 +1,13 @@
1
- # Open Deep Research
2
-
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.
4
-
5
- Read more about this implementation's goal and methods in our [blog post](https://huggingface.co/blog/open-deep-research).
6
-
7
-
8
- This agent achieves **55% pass@1** on the GAIA validation set, compared to **67%** for the original Deep Research.
9
-
10
- ## Setup
11
-
12
- To get started, follow the steps below:
13
-
14
- ### Clone the repository
15
-
16
- ```bash
17
- git clone https://github.com/huggingface/smolagents.git
18
- cd smolagents/examples/open_deep_research
19
- ```
20
-
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
36
-
37
- The agent uses the `GoogleSearchTool` for web search, which requires an environment variable with the corresponding API key, based on the selected provider:
38
- - `SERPAPI_API_KEY` for SerpApi: [Sign up here to get a key](https://serpapi.com/users/sign_up)
39
- - `SERPER_API_KEY` for Serper: [Sign up here to get a key](https://serper.dev/signup)
40
-
41
- Depending on the model you want to use, you may need to set environment variables.
42
- For example, to use the default `o1` model, you need to set the `OPENAI_API_KEY` environment variable.
43
- [Sign up here to get a key](https://platform.openai.com/signup).
44
-
45
- > [!WARNING]
46
- > 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
47
-
48
-
49
- ## Usage
50
-
51
- Then you're good to go! Run the run.py script, as in:
52
- ```bash
53
- python run.py --model-id "o1" "Your question here!"
54
- ```
 
1
+ ---
2
+ title: Demoagentsetup
3
+ emoji: 🚀
4
+ colorFrom: pink
5
+ colorTo: red
6
+ sdk: gradio
7
+ sdk_version: 5.26.0
8
+ app_file: app.py
9
+ pinned: false
10
+ license: mit
11
+ ---
12
+
13
+ Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference