Update README.md
Browse files
README.md
CHANGED
@@ -33,6 +33,8 @@ Achieving 30 points for the certification was relatively easy with the template
|
|
33 |
|
34 |
[](https://huggingface.co/spaces/civerson916/Final_Assignment_Template)
|
35 |
|
|
|
|
|
36 |
Beyond what looks like a smolagents guided tour, you can find the following in this repo...
|
37 |
|
38 |
* Research agent armed with Google search via [Serper](https://serper.dev/) and both Audo and Video Understanding via [Gemini](https://ai.google.dev/gemini-api/docs/)video-understanding)
|
@@ -41,9 +43,6 @@ Beyond what looks like a smolagents guided tour, you can find the following in t
|
|
41 |
* [Pydantic](https://docs.pydantic.dev/latest/) settings for type safety, centralized, and encapsulated config.
|
42 |
* Basic parallel agent task execution, compatible with [Gradio](https://www.gradio.app/), no extra abstractions.
|
43 |
|
44 |
-
[](https://huggingface.co/learn/agents-course/unit4/hands-on)
|
45 |
-
|
46 |
-
[]
|
47 |
|
48 |
## Getting Started
|
49 |
|
@@ -58,15 +57,12 @@ To get a local copy up and running follow these simple steps.
|
|
58 |
### Installation
|
59 |
|
60 |
1. Get an API key for the following services: [OpenRouter](https://openrouter.ai/), [Gemini](https://ai.google.dev/gemini-api/docs/api-key), [Serper](https://serper.dev/), and [Langfuse](https://langfuse.com/). The HF username and space are only used when submitting answers for evaluation, but must be present to startup. If you run this in your own HF space, these will already be set for you.
|
61 |
-
2. Clone the repo
|
62 |
```sh
|
63 |
git clone https://github.com/civerson/smolagents-gaia-final.git
|
64 |
-
```
|
65 |
-
3. Install the packages
|
66 |
-
```sh
|
67 |
pip install -r requirements.txt
|
68 |
```
|
69 |
-
|
70 |
```sh
|
71 |
OPENROUTER_API_KEY = 'ENTER YOUR API'
|
72 |
GEMINI_API_KEY = 'ENTER YOUR API'
|
@@ -76,6 +72,10 @@ To get a local copy up and running follow these simple steps.
|
|
76 |
USERNAME = 'ENTER YOUR HF USERNAME'
|
77 |
SPACE_ID = 'ENTER YOUR HF SPACE'
|
78 |
```
|
|
|
|
|
|
|
|
|
79 |
5. Change git remote url to avoid accidental pushes to base project
|
80 |
```sh
|
81 |
git remote set-url origin github_username/repo_name
|
|
|
33 |
|
34 |
[](https://huggingface.co/spaces/civerson916/Final_Assignment_Template)
|
35 |
|
36 |
+
[](https://huggingface.co/learn/agents-course/unit4/hands-on)
|
37 |
+
|
38 |
Beyond what looks like a smolagents guided tour, you can find the following in this repo...
|
39 |
|
40 |
* Research agent armed with Google search via [Serper](https://serper.dev/) and both Audo and Video Understanding via [Gemini](https://ai.google.dev/gemini-api/docs/)video-understanding)
|
|
|
43 |
* [Pydantic](https://docs.pydantic.dev/latest/) settings for type safety, centralized, and encapsulated config.
|
44 |
* Basic parallel agent task execution, compatible with [Gradio](https://www.gradio.app/), no extra abstractions.
|
45 |
|
|
|
|
|
|
|
46 |
|
47 |
## Getting Started
|
48 |
|
|
|
57 |
### Installation
|
58 |
|
59 |
1. Get an API key for the following services: [OpenRouter](https://openrouter.ai/), [Gemini](https://ai.google.dev/gemini-api/docs/api-key), [Serper](https://serper.dev/), and [Langfuse](https://langfuse.com/). The HF username and space are only used when submitting answers for evaluation, but must be present to startup. If you run this in your own HF space, these will already be set for you.
|
60 |
+
2. Clone the repo and install packages
|
61 |
```sh
|
62 |
git clone https://github.com/civerson/smolagents-gaia-final.git
|
|
|
|
|
|
|
63 |
pip install -r requirements.txt
|
64 |
```
|
65 |
+
3. Enter your API keys in a `.env` or set them as follows
|
66 |
```sh
|
67 |
OPENROUTER_API_KEY = 'ENTER YOUR API'
|
68 |
GEMINI_API_KEY = 'ENTER YOUR API'
|
|
|
72 |
USERNAME = 'ENTER YOUR HF USERNAME'
|
73 |
SPACE_ID = 'ENTER YOUR HF SPACE'
|
74 |
```
|
75 |
+
4. Run the app
|
76 |
+
```sh
|
77 |
+
python app.py
|
78 |
+
```
|
79 |
5. Change git remote url to avoid accidental pushes to base project
|
80 |
```sh
|
81 |
git remote set-url origin github_username/repo_name
|