designfailure commited on
Commit
d5a3914
·
verified ·
1 Parent(s): 358834b

Add README with run instructions

Browse files
Files changed (1) hide show
  1. README.md +47 -0
README.md ADDED
@@ -0,0 +1,47 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # agents-md-agent — "Hub Scout"
2
+
3
+ An agent whose entire instruction set lives in one human-readable file,
4
+ `AGENTS.md`. The code (`app.py`) is just the wiring: it loads `AGENTS.md`
5
+ verbatim as the system prompt and gives the model two tools that hit the
6
+ real Hugging Face Hub. Edit `AGENTS.md` and the agent's behavior changes —
7
+ no code changes. This is the "author markdown, push, it's live" pattern.
8
+
9
+ ## Run locally
10
+
11
+ ```bash
12
+ git clone https://huggingface.co/datasets/designfailure/agents-md-agent
13
+ cd agents-md-agent
14
+ pip install -r requirements.txt
15
+
16
+ export HF_TOKEN=hf_... # token with Inference Providers access
17
+ python app.py # opens http://127.0.0.1:7860
18
+ ```
19
+
20
+ Override the model with `AGENT_MODEL=<repo id>` (any tool-capable chat model
21
+ available through Inference Providers).
22
+
23
+ ## Tools the agent can call
24
+
25
+ - `search_hf_models(query, limit, task)` — keyword search over the Hub, ranked by likes
26
+ - `get_model_stats(repo_id)` — downloads, likes, last-modified for one repo
27
+
28
+ ## Try asking it
29
+
30
+ - "Find me a small chat model that runs on a laptop CPU."
31
+ - "What's the most downloaded sentence-embedding model right now?"
32
+ - "How actively used is Qwen/Qwen2.5-72B-Instruct?"
33
+
34
+ ## Portability
35
+
36
+ `agent.json` follows the deepagents project layout, so the same `AGENTS.md`
37
+ drops straight into the `deepagents` harness or `deepagents deploy` (which
38
+ needs a LangSmith key) without rewrites. The full file layout this expects:
39
+
40
+ ```
41
+ agents-md-agent/
42
+ agent.json # name, description, model (deepagents convention)
43
+ AGENTS.md # the agent's entire instruction set — the point of the project
44
+ app.py # Gradio wiring: system prompt = AGENTS.md, two real tools
45
+ requirements.txt
46
+ README.md
47
+ ```