burtenshaw commited on
Commit
e3fb778
·
1 Parent(s): 1e5db01

add readme

Browse files
Files changed (1) hide show
  1. README.md +12 -84
README.md CHANGED
@@ -1,84 +1,12 @@
1
- # AI Agent Builder with SmolaGents
2
-
3
- This application allows you to build AI agents using the SmolaGents library from Hugging Face. You can select tools from Hugging Face Hub collections and Spaces, and interact with your agent through a chat interface.
4
-
5
- ## Features
6
-
7
- - Add tools from Hugging Face Hub collections
8
- - Add tools from Hugging Face Spaces
9
- - Chat with your agent in an interactive interface
10
- - Customize the model used for your agent
11
- - Regenerate responses if needed
12
-
13
- ## Installation
14
-
15
- 1. Make sure you have Python 3.11 or higher installed
16
- 2. Install the required dependencies:
17
-
18
- ```bash
19
- pip install -r requirements.txt
20
- ```
21
-
22
- ## Usage
23
-
24
- 1. Run the application:
25
-
26
- ```bash
27
- python app.py
28
- ```
29
-
30
- 2. Open your browser and navigate to the URL displayed in the terminal (usually http://127.0.0.1:7860)
31
-
32
- 3. Configure your agent:
33
- - Select a model (default is Qwen/Qwen2.5-Coder-32B-Instruct)
34
- - Add at least one tool from Hugging Face Hub collections or Spaces
35
- - Click "Create Agent"
36
-
37
- 4. Chat with your agent in the chat interface
38
- - Type your message and press Enter
39
- - Use the "Regenerate Response" button if you want a different answer
40
- - Use "Clear Chat" to start a new conversation
41
-
42
- ## Adding Tools
43
-
44
- ### Hugging Face Hub Collections
45
- Enter the collection slug for a tool collection from Hugging Face Hub.
46
- Example: `huggingface-tools/diffusion-tools-6630bb19a942c2306a2cdb6f`
47
-
48
- ### Hugging Face Spaces
49
- Enter the space ID for a Gradio app on Hugging Face Spaces.
50
- Example: `black-forest-labs/FLUX.1-schnell`
51
-
52
- This allows you to use any Gradio app on Hugging Face Spaces as a tool for your agent.
53
-
54
- ## Example Spaces to Try
55
-
56
- ### Image Generation Spaces
57
- - `black-forest-labs/FLUX.1-schnell`: Text-to-image generation
58
- - `stabilityai/stable-diffusion-xl-base-1.0`: High-quality image generation
59
-
60
- ### Text Analysis Spaces
61
- - `sentence-transformers/text-similarity`: Compare text similarity
62
- - `facebook/bart-large-mnli`: Text classification
63
-
64
- ### Other Useful Spaces
65
- - `spaces/jxnl/instructor-xl`: Generate structured data
66
- - `spaces/fffiloni/text-to-speech`: Convert text to speech
67
-
68
- ## Troubleshooting
69
-
70
- If you encounter issues with the Space tool not being recognized, make sure:
71
- 1. You've entered the correct Space ID
72
- 2. The Space has a Gradio interface
73
- 3. The Space is publicly accessible
74
-
75
- ## Requirements
76
-
77
- - gradio>=5.15.0
78
- - smolagents>=1.10.0
79
- - huggingface_hub
80
-
81
- ## Note
82
-
83
- For some tools and models, you may need to set up API keys as environment variables. For example:
84
- - `HF_TOKEN` for Hugging Face Hub access
 
1
+ ---
2
+ title: Agent Builder
3
+ emoji: 🔥
4
+ colorFrom: yellow
5
+ colorTo: green
6
+ sdk: gradio
7
+ sdk_version: 5.20.0
8
+ app_file: app.py
9
+ pinned: false
10
+ ---
11
+
12
+ Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference