civerson916 commited on
Commit
ba6958a
·
verified ·
1 Parent(s): 1db3394

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +47 -1
README.md CHANGED
@@ -31,7 +31,7 @@ Achieving 30 points for the certification was relatively easy with the template
31
  * Response Times
32
  * Reliability
33
 
34
- [![App Platorm](images/submit_answers.jpg)](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
 
@@ -41,4 +41,50 @@ 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
  Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
31
  * Response Times
32
  * Reliability
33
 
34
+ [![HF Space Screenshot](images/submit_answers.jpg)](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
 
 
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
+ [![Leaderboard Screenshot](images/langfuse.jpg)](https://huggingface.co/learn/agents-course/unit4/hands-on)
45
+
46
+ [![Leaderboard Screenshot](images/leaderboard.jpg)]
47
+
48
+ ## Getting Started
49
+
50
+ To get a local copy up and running follow these simple steps.
51
+
52
+ ### Prerequisites
53
+
54
+ * python
55
+ * pip
56
+ * git
57
+
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
+ 4. Enter your API keys in a `.env` or set them as follows
70
+ ```sh
71
+ OPENROUTER_API_KEY = 'ENTER YOUR API'
72
+ GEMINI_API_KEY = 'ENTER YOUR API'
73
+ SERPER_API_KEY = 'ENTER YOUR API'
74
+ LANGFUSE_PUBLIC_KEY = 'ENTER YOUR API'
75
+ LANGFUSE_SECRET_KEY = 'ENTER YOUR API'
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
82
+ git remote -v # confirm the changes
83
+ ```
84
+
85
+ <p align="right">(<a href="#readme-top">back to top</a>)</p>
86
+
87
+
88
+
89
+
90
  Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference