tool template

huggingface_spaces_tool_template.md

@@ -0,0 +1,96 @@
+# Hugging Face Spaces Tool Template for Agents
+
+- a quick tribute to [Aymeric](https://huggingface.co/m-ric) for this simple but effective exapmle of how to build and serve agents using Hugging Face spaces
+- check out the documentation here for more information on the transformers implementation of the [Agent Class](https://huggingface.co/docs/transformers/main_classes/agent)
+- capturing the entire repo so that the overall structure and content of the repo is clear
+
+### File: README.md
+**Type:** txt
+**Size:** 247 bytes
+**Created:** 2025-01-22 19:08:45 UTC
+**Modified:** 2025-01-22 19:08:45 UTC
+#### Content:
+```
+---
+title: Text To Image
+emoji: 👀
+colorFrom: blue
+colorTo: indigo
+sdk: gradio
+sdk_version: 4.29.0
+app_file: app.py
+pinned: false
+tags:
+- tool
+---
+
+Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+
+```
+
+### File: app.py
+**Type:** python
+**Size:** 114 bytes
+**Created:** 2025-01-22 19:08:45 UTC
+**Modified:** 2025-01-22 19:08:45 UTC
+#### Content:
+```
+from transformers import launch_gradio_demo
+from tool import TextToImageTool
+
+launch_gradio_demo(TextToImageTool)
+
+```
+
+### File: requirements.txt
+**Type:** txt
+**Size:** 26 bytes
+**Created:** 2025-01-22 19:08:45 UTC
+**Modified:** 2025-01-22 19:08:45 UTC
+#### Content:
+```
+huggingface_hub
+smolagents
+```
+
+### File: tool.py
+**Type:** python
+**Size:** 635 bytes
+**Created:** 2025-01-22 19:08:45 UTC
+**Modified:** 2025-01-22 19:08:45 UTC
+#### Content:
+```
+from smolagents import Tool
+from huggingface_hub import InferenceClient
+
+
+class TextToImageTool(Tool):
+    description = "This tool creates an image according to a prompt, which is a text description."
+    name = "image_generator"
+    inputs = {"prompt": {"type": "string", "description": "The image generator prompt. Don't hesitate to add details in the prompt to make the image look better, like 'high-res, photorealistic', etc."}}
+    output_type = "image"
+    model_sdxl = "black-forest-labs/FLUX.1-schnell"
+    client = InferenceClient(model_sdxl)
+
+
+    def forward(self, prompt):
+        return self.client.text_to_image(prompt)
+
+```
+
+### File: tool_config.json
+**Type:** json
+**Size:** 414 bytes
+**Created:** 2025-01-22 19:08:45 UTC
+**Modified:** 2025-01-22 19:08:45 UTC
+#### Content:
+```
+{
+  "description": "This is a tool that creates an image according to a prompt, which is a text description.",
+  "inputs": "{'prompt': {'type': 'string', 'description': \"The image generator prompt. Don't hesitate to add details in the prompt to make the image look better, like 'high-res, photorealistic', etc.\"}}",
+  "name": "image_generator",
+  "output_type": "image",
+  "tool_class": "tool.TextToImageTool"
+}
+
+```