A comprehensive framework for building agents with Small Language Models
Project description
๐ค What is effGen?
effGen transforms Small Language Models into powerful AI agents. While most frameworks assume a massive LLM, effGen is optimized from the ground up for efficient, smaller models โ delivering fast, capable agents without the compute overhead โ while still supporting all major cloud providers when you want them.
from effgen import Agent, load_model
from effgen.core.agent import AgentConfig
from effgen.tools.builtin import Calculator, PythonREPL
# Load a small but mighty model
model = load_model("Qwen/Qwen2.5-1.5B-Instruct", quantization="4bit")
# Create an agent with tools
config = AgentConfig(
name="math_agent",
model=model,
tools=[Calculator(), PythonREPL()],
)
agent = Agent(config=config)
# Run a computation
result = agent.run("What is 24344 * 334?")
print(f"Answer: {result.output}")
9 cloud providers ย ยทย 4 local backends ย ยทย 66 built-in tools ย ยทย 9 presets ย ยทย 35 prompt templates ย ยทย image / audio / video
๐ฐ News & Updates
| Date | Update | |
|---|---|---|
| โจ | 5 Jul 2026 | v0.3.2 Released โ Usability, Robustness & Polish: structured output + cost gates + document input on the CLI (batch --schema, eval --fail-under, compare --optimize cost, run --file), clinical-grade PHI redaction with a phi preset, native web-search sources that never vanish, sampling controls (seed/frequency_penalty) that take effect, a server that returns real HTTP status on failure, provider/model/status-labeled /metrics with top-level alerting/SLO exports, batch that survives malformed rows with per-job cost, spreadsheet ingestion, the general preset on Gemini, and prompt-library input validation. No breaking changes. Changelog |
| โจ | 29 Jun 2026 | v0.3.1 Released โ Real-World Usability & Polish: grounded response.sources/.citations, reasoning models (gpt-5/o-series) finish token-heavy tasks, custom personas honored on every path, fail-closed multi-agent teams/workflows, an OpenAI-compatible server with no silent tool/embedding downgrades, one-call domain agents (LegalDomain().to_agent(...)), effgen run --json + auto-discovered tool plugins + deadlock-free sync run() over MCP, grammar-constrained local structured output, physical GPU memory in models status, the REPL sandbox toggle out of the model's hands, PDFs that ingest, and per-call latency with readable sub-cent costs. No breaking changes. Changelog |
| ๐ฏ | 19 Jun 2026 | v0.3.0 Released โ Stabilization & Hardening: fail-closed Agent.run() (no silent success; typed redacted errors; smart retries), a self-updating drift-aware model catalog (effgen models refresh), real GPU support (temperature=0, deadlock-free allocator), a fail-closed API server (forged-JWT rejected, secure CORS/metrics/RBAC/budget), hardened built-in tools (REPL timeout, one shared SSRF guard, path confinement, no unsafe pickle/eval), import effgen in ~20 ms, faster streaming + agent loop, a quiet scriptable CLI, and a live "thinking" UX. No breaking changes. Changelog |
๐ Earlier releases (v0.2.10 โ v0.0.1)
| Date | Update | |
|---|---|---|
| ๐ | 27 May 2026 | v0.2.10 Released: Security, Edge & DX โ secret scanning (gitleaks), SBOM (CycloneDX), pip-audit CI, sandboxed CodeExecutor (SubprocessSandbox + DockerSandbox), OAuth2/OIDC + RBAC + audit log, Docker + Helm, AWS Lambda (Mangum), Cloudflare Worker edge proxy, VSCode extension, Jupyter magics, live dashboard. Changelog |
| ๐ | 23 May 2026 | v0.2.9 Released: Observability & Reliability โ structured JSON logs + secret redaction, OTel samplers + canonical span spec, Prometheus histograms, SLO tracking, circuit breakers, bulkheads, jittered retries, chaos harness, fuzz suite, effgen loadtest CLI, Alertmanager rules. Changelog |
| ๐ผ๏ธ | 21 May 2026 | v0.2.8 Released: First-class multimodal input โ image, audio, and video across 6 providers (Gemini, OpenAI, Groq, Anthropic, Together, HF). New multimodal preset, MultimodalDescribeTool, unified Message content schema, 5 cookbook walkthroughs. Changelog |
| ๐ | 20 May 2026 | v0.2.7 Released: 31 prompt templates across 7 domains โ research, coding, data/SQL, legal, medical, creative, business โ with golden eval harness, interactive playground, and auto-generated gallery. Changelog |
| ๐ | 19 May 2026 | v0.2.6 Released: 14 new tools โ OCR, AudioTranscribe, ImageInfo, ImageCaption, PDF, DOCX, Excel, Weather, Geocode, Maps, EmailSMTP, EmailIMAP, SlackWebhook, DiscordWebhook. New presets: media, notify. 58+ built-in tools total. Changelog |
| ๐ | 18 May 2026 | v0.2.5 Released: 13 new free tools โ PubMed, ArXiv, SemanticScholar, RSS, News, YouTubeTranscript, YouTubeMetadata, Reddit, HackerNews, Translate, LanguageDetect, QRGenerate, QRRead. 44+ built-in tools total. Changelog |
| ๐ | 14 May 2026 | v0.2.4 Released: ModelRouter with CostBased/LatencyBased/FirstAvailable policies, transparent provider failover, cross-process SQLite rate-limit coordination, persistent cost tracker + effgen cost dashboard CLI. Changelog |
| ๐ | 4 May 2026 | v0.2.3 Released: 5 new cloud backends (Groq, Together AI, Fireworks, Replicate, HuggingFace Inference) โ 9 providers total. Unified ProviderRegistry, effgen doctor auth check, backend parity matrix. Changelog |
| ๐ | 28 Apr 2026 | v0.2.2 Released: Gemini 3.x/2.5/2.0 registry, thinking_budget, Google Search grounding, Files API, Gemini native tools (GoogleSearch, UrlContext, CodeExecution). Anthropic Claude 4.7 registry, extended thinking, prompt caching (cache_control), streaming polish, experimental native tools. Changelog |
| ๐ | 25 Apr 2026 | v0.2.1 Released: Cerebras backend (streaming, native tool-calling, rate-limit coordinator, cost tracking) + OpenAI gpt-5/gpt-5.4-nano/o-series with reasoning_effort, prompt caching, structured outputs v2, and OpenAI native tools (web_search, code_interpreter, file_search). Changelog |
| ๐ | 9 Apr 2026 | v0.2.0 Released: Major release โ native tool calling, guardrails, multi-agent orchestration, RAG pipeline, 31 tools, eval framework, production API server, MLX Apple Silicon support, Python & TypeScript SDKs. Changelog |
| ๐ | 8 Apr 2026 | MLX & Apple Silicon support merged (PR #4): Native Metal GPU acceleration via MLX & MLX-VLM backends, hardware detection, 5 Gradio GUI examples. pip install effgen[mlx] |
| ๐ง | 25 Mar 2026 | v0.1.3 Released: Verification hardening โ smarter loop detection, "skip the tool" prompting, model-aware token counting, sub-agent depth limits, circuit breaker persistence. Changelog |
| ๐ง | 12 Mar 2026 | v0.1.2 Released: Test-driven hardening โ 10 example agents, 19 bug fixes, cross-model compatibility matrix (11 models, 73% pass rate). Changelog |
| ๐ | 6 Mar 2026 | v0.1.1 Released: Stabilization โ fixed license/metadata consistency, improved error handling, added 6 examples, expanded test suite. Changelog |
| ๐ | 1 Mar 2026 | v0.1.0 Released: Major feature release โ 14 built-in tools, agent presets, plugin system, real streaming, memory integration, ACP/MCP protocols, CI/CD, and comprehensive test suite. Changelog |
| ๐ง | 3 Feb 2026 | v0.0.2 Released: vLLM backend fixes with automatic chat template support, GPU memory control, improved OOM error handling, and multi-model family compatibility |
| ๐ | 2 Feb 2026 | Preprint available: EffGen: Enabling Small Language Models as Capable Autonomous Agents |
| ๐ | 31 Jan 2026 | Initial release of effGen framework (v0.0.1) |
โก Installation
Requires Python 3.10 or newer. Tested on Python 3.10, 3.11, 3.12, 3.13, 3.14.
pip install effgen # from PyPI (recommended)
| Target | Command | What you get |
|---|---|---|
| ๐ Apple Silicon | pip install effgen[mlx] | Text models on Metal GPU |
| ๐ Apple Silicon (VLM) | pip install effgen[mlx-vlm] | Vision-language models on Metal GPU |
| ๐ NVIDIA / vLLM | pip install effgen[vllm] | High-throughput batch inference |
| ๐ Everything | pip install effgen[all] | vLLM + RAG + vector-DB + search + monitoring + โฆ |
โก Optional: flash-attn (NVIDIA GPUs only โ 2 steps)
flash-attn is not in [all] on purpose: its own setup.py imports torch before pip's isolated
build environment has torch installed (a well-known upstream bug), so bundling it would break
pip install effgen[all] for everyone. Install it in two steps instead:
pip install effgen[all] # step 1: gets torch + the rest
pip install flash-attn --no-build-isolation # step 2: reuses the torch from step 1
๐ง From source
git clone https://github.com/ctrl-gaurav/effGen.git
cd effGen
./install.sh # quick install
./install.sh --full # full install (includes vLLM + dev tools)
pip install -e . # manual editable install
See docs/installation.md for the full guide.
๐ Quick Start
|
๐ป Command line # Run a task
effgen run "What is the capital of France?"
# Interactive chat
effgen chat
# Start the API server
effgen serve --port 8000
# List presets ยท check health ยท wizard
effgen presets
effgen health
effgen
|
๐ Python API from effgen import Agent, load_model
from effgen.core.agent import AgentConfig
from effgen.tools.builtin import Calculator
model = load_model("Qwen/Qwen2.5-1.5B-Instruct",
quantization="4bit")
agent = Agent(config=AgentConfig(
name="calculator_agent",
model=model,
tools=[Calculator()],
system_prompt="You are a helpful math assistant.",
))
result = agent.run("Calculate 15% tip on $85.50")
print(result.output)
|
๐ Apple Silicon (MLX) quick start
from effgen import Agent, load_model
from effgen.core.agent import AgentConfig
from effgen.tools.builtin import Calculator
# Native Metal GPU, unified memory, no CPU-GPU transfer
model = load_model("LiquidAI/LFM2.5-1.2B-Instruct-MLX-8bit", engine="mlx")
agent = Agent(config=AgentConfig(name="mlx_agent", model=model, tools=[Calculator()]))
result = agent.run("What is sqrt(144) + 2^10?")
print(result.output)
โจ Features
|
๐ง |
๐ |
๐ก๏ธ |
๐ |
๐ฅ |
๐ผ๏ธ |
๐ญ |
๐ |
๐ What's new in v0.3.2 โ Usability, Robustness & Polish
v0.3.2 keeps sanding down the edges โ this time for a reliability engineer, a trust auditor, a security engineer, an ETL engineer, a clinical analyst, an SRE, a localizer, a CI gatekeeper, a non-technical operator, a game writer, a plugin author, a FinOps owner, and a document specialist. No new providers or subsystems โ the surfaces you already reach for are now more predictable, and every quiet trap now surfaces a clear, typed error. No breaking API changes โ every change is additive.
| Area | What changed |
|---|---|
| Structured output on the CLI | effgen batch --schema validates every row against a JSON Schema / Pydantic model; the output file is lossless (cost, tokens, parsed, failure reason); --temperature, --persona, --resume too. |
| CI accuracy gates | effgen eval --fail-under 0.8 drives the exit code, and --compare-baseline fails the build on a real regression. |
| Cost-aware selection | effgen compare --optimize cost adds a $/run column and picks the cheapest good-enough model. |
| Document & file input | effgen run --file report.pdf reads a PDF/DOCX/XLSX/text document or an image โ no Python needed. |
| Clinical-grade redaction | PHI redaction covers name/DOB/MRN/address/member-ID, custom_patterns, strict fail-closed mode, and a new phi preset. |
| Grounding that never vanishes | Native web search surfaces the URLs it searched even when the model answers without inline citations. |
| Sampling that takes effect | seed, frequency_penalty, presence_penalty, top_k reach the model; an unknown run() kwarg is now rejected. |
| A consistent server | A failed completion returns a real 4xx/5xx envelope instead of an HTTP 200 with the error as the answer. |
| Observability you alert on | /metrics carries provider/model/status labels; AlertWebhook/SLOTracker are exported top-level. |
| Resilient batch & intake | One malformed row no longer aborts the job (skipped + reported), spreadsheets ingest, and a folder ingest never silently drops a file. |
from effgen import PIIGuardrail, get_guardrail_preset
# Redaction that covers the labeled clinical identifiers, plus site-specific patterns.
g = PIIGuardrail(action="redact", custom_patterns=[(r"MRN[:#]\s*\d+", "[MRN REDACTED]")])
print(g.check("Jane Doe DOB: 1980-02-14 MRN: 55123").modified_content)
# "[NAME REDACTED] DOB: [DOB REDACTED] MRN: [MRN REDACTED]"
chain = get_guardrail_preset("phi") # redaction + fail-closed strict mode
effgen batch --input tickets.jsonl --output out.jsonl -m groq:llama-3.1-8b-instant --schema schema.json
effgen eval --suite cases.jsonl -m groq:llama-3.1-8b-instant --fail-under 0.9 # exit 1 if it drops
effgen compare --models "groq:llama-3.1-8b-instant,gemini:gemini-3.1-flash-lite" --suite cases.jsonl --optimize cost
effgen run "What was Q3 revenue?" --file report.pdf -m groq:llama-3.1-8b-instant
๐ฆ Previous releases โ v0.3.1 down to v0.2.0 (click to expand)
What's new in v0.3.1 โ Real-World Usability & Polish
Where v0.3.0 hardened the framework, v0.3.1 sands down the edges real professionals hit the moment they sit down with it. No new providers or subsystems โ the things you already reach for are now more predictable, measurable, and consistent. No breaking API changes โ every change is additive or makes a previously-silent failure surface a clear, typed error.
| Area | What changed |
|---|---|
| Traceable evidence | response.sources / .citations are populated from the URLs a run actually retrieved (and provider-native grounding) โ never from the model's prose. |
| Reasoning models | The gpt-5 family and o-series finish token-heavy tasks instead of returning an empty, billed result; length-truncation is grown and retried once, not three times. |
| Measurable results | cost_usd, token counts, and latency_ms land on every result (local stays cost-free); teams/workflows report summed cost; sub-cent costs show real digits. |
| Personas everywhere | A custom system_prompt now steers the direct, streaming, and native-tool paths โ not just text-ReAct. |
| Trustworthy orchestration | Collaborative teams fail closed, hierarchical teams route by the named worker, and a workflow never runs downstream of a failed node. |
| Consistent server | No silent client-tool drop (clear 400), embeddings reflect their real backend, a unified error envelope, and per-call cost. |
| One-call domains | LegalDomain().to_agent("gpt-5-nano") wires a domain's prompt, tools, and guardrails into a runnable agent. |
| Local-first truth | models status shows physical GPU memory, models info is cache-aware, local batch is thread-safe, and grammar-constrained JSON via effgen[grammar]. |
| Dependable automation | Sync Agent.run() no longer hangs on MCP tools, tool plugins auto-discover, and effgen run --json pipes clean JSON to stdout. |
| Hardened tools | The Python REPL sandbox toggle is out of the model's hands; the bash env scrub covers every credential; broader injection detection and credential-aware PII redaction. |
from effgen import create_agent, LegalDomain
# Grounded research: sources/citations come from the URLs the tools retrieved.
agent = create_agent("research", "openai:gpt-5-nano")
r = agent.run("What is the capital of France? Cite a source.")
print(r.text) # "...Paris (Source: https://en.wikipedia.org/wiki/Paris)."
print(r.sources) # ['https://en.wikipedia.org/wiki/Paris']
print(r.metadata["cost_usd"], r.metadata["latency_ms"])
# A knowledge domain becomes a runnable agent in one call.
legal = LegalDomain().to_agent("openai:gpt-5-nano")
print(legal.run("What does an NDA confidentiality clause protect?").text)
effgen run --json -q "What is 25 * 17?" | jq .output # pure-JSON stdout for CI
effgen models status # physical GPU memory; which card is free
What's new in v0.3.0 โ Stabilization & Hardening
effGen v0.3.0 made the framework production-safe from the inside out. No breaking API changes.
- Fail-closed
Agent.run()โ no silent success; typed, redacted errors; smarter retries and loop detection. - Self-updating, drift-aware model catalog โ
effgen models refreshreconciles the local snapshot against live provider lists (chat models only; never persistsft:ids). - Real GPU support โ deterministic
temperature=0, a deadlock-free allocator, clean multi-GPU use. - Fail-closed API server โ forged/expired/wrong-alg JWTs rejected; secure CORS, metrics, RBAC, and budget enforcement.
- Hardened built-in tools โ Python REPL timeout, one shared SSRF guard, path confinement, and no
unsafe
pickle/eval. - Faster & quieter โ
import effgenin ~20 ms, faster streaming + agent loop, a scriptable CLI, and a live "thinking" UX.
What's new in v0.2.9 โ Observability & Reliability
effGen v0.2.9 ships the full observability and reliability stack. All telemetry is async/non-blocking โ a failed export never fails inference.
Structured JSON logging with secret redaction. Every log line is a JSON object: {ts, level, module, event, attributes, trace_id, span_id}. The built-in Redactor strips OpenAI, Anthropic, Cerebras, Google, HF, Groq, Bearer, Slack, and Discord webhook patterns at the encoder โ no secret ever appears in a log file.
from effgen.observability import get_logger
log = get_logger(__name__)
log.event("model.call.started", provider="cerebras", model="gpt-oss-120b", cached_tokens=0)
# โ {"ts": "2026-05-23T...", "level": "INFO", "event": "model.call.started", ...}
Prometheus histograms + SLO tracking. effgen_model_call_latency_seconds, effgen_tool_call_latency_seconds, effgen_agent_iteration_latency_seconds, and effgen_tokens_total now expose histogram buckets at /metrics. SLOTracker maintains a rolling-window error budget and burn_rate() at /slo.
Configurable OTel samplers + canonical span spec. Choose AlwaysOn, AlwaysOff, TraceIdRatio(p), or RateLimited(per_second) in config. effgen/observability/spans.py is the single source of truth for every span attribute name.
Reliability primitives. Four layers now protect every adapter call:
| Primitive | Class | What it does |
|---|---|---|
| Timeouts | ReliabilityConfig |
model_call=60s, tool_call=30s, http=20s โ explicit on every httpx client |
| Retries | @retryable(Retry(...)) |
Jittered exponential backoff for 5xx / 429 / network errors; emits OTel events |
| Circuit breaker | CircuitBreaker |
CLOSED โ OPEN โ HALF_OPEN per provider; isolates misbehaving backends |
| Bulkhead | Bulkhead |
Per-provider concurrency + queue limit; prevents provider starvation |
Deterministic chaos harness. Inject NetworkTimeout, Http5xx, Http429, SlowResponse, PartialResponse, or MalformedJSON faults with Chaos(seed). Four canonical scenarios โ fallback on 5xx, Retry-After honoured, timeout fires cleanly, AllProvidersFailed โ all pass deterministically across 10 seeds.
Fuzz suite. Hypothesis runs 500 examples against all 66 BaseTool subclasses, random ContentPart message sequences, and the router's provider-availability logic. No unhandled exceptions, no secret leaks.
Load-testing CLI + Alertmanager rules.
# Run a 30-second load test (JSON report prints to stdout by default)
effgen loadtest --concurrency 10 --duration 30 --scenario fixed
# Or write the report to a file with --output
effgen loadtest --concurrency 10 --duration 30 --output report.json
# Integrate with Alertmanager
cp docs/observability/alert_rules.yaml /etc/prometheus/rules/effgen.yaml
See docs/observability/overview.md, docs/observability/metrics.md, and docs/observability/alerting.md.
What's new in v0.2.8 โ First-class multimodal (image, audio & video across 6 providers)
effGen v0.2.8 makes multimodal input a first-class citizen. Send images, audio clips, and short video to any vision-capable provider through a unified Message schema โ the adapter handles the translation, not your code.
Image input โ Gemini, OpenAI gpt-4o, Groq, Anthropic (code-only), Together, HF. Automatic resize/MIME validation via image_pre.py. Raises CapabilityNotSupportedError cleanly when the provider doesn't support vision.
Audio input โ Gemini native inline audio, OpenAI Whisper transcription + gpt-4o audio, HF Inference ASR. Auto-downsamples to 16 kHz mono; chunks files over provider max duration. Anthropic raises CapabilityNotSupportedError.
Video input โ Gemini native video for providers that accept raw video; frame-sampling fallback (ffmpeg) for all others. MissingSystemDependency with install hints when ffmpeg is absent.
Unified message schema โ TextPart, ImagePart, AudioPart, VideoPart form a typed ContentPart union. Message.content is always a List[ContentPart]; backwards-compatible string constructor still works.
multimodal preset โ create_agent("multimodal", model) wires Gemini Flash-Lite (primary) + OpenAI gpt-4o-mini (fallback) with ImageInfo, ImageCaption, OCR, AudioTranscribe, MultimodalDescribeTool, and the full tool suite.
5 cookbook walkthroughs โ image Q&A, audio transcribe + reason, video summarize, OCR + LLM structured extraction, chart reading from an image. All in docs/cookbook/.
from effgen import image_from, audio_from
from effgen.presets import create_agent
from effgen import load_model
model = load_model("gemini-3.1-flash-lite", provider="gemini")
agent = create_agent("multimodal", model)
# Image question โ pass media through inputs=
img = image_from("https://upload.wikimedia.org/wikipedia/commons/4/47/PNG_transparency_demonstration_1.png")
result = agent.run("What is in this image?", inputs=[img])
print(result.output)
# Audio transcription
aud = audio_from("/tmp/clip.mp3")
result = agent.run("Transcribe and summarize.", inputs=[aud])
effgen run --preset multimodal "Describe this image" --image /tmp/photo.jpg
python -c "from effgen.models.capabilities import Capability; print(Capability.vision)"
See docs/multimodal/overview.md and docs/cookbook/README.md.
What's new in v0.2.7 โ Prompt Library, Eval Harness & Interactive Playground
effGen v0.2.7 adds a curated, domain-organized Prompt Library with reusable templates, paired with a golden evaluation harness and an interactive playground CLI. See the full gallery.
Research โ literature review (zero-shot + CoT), paper summary, citation extraction, methodology critique. Coding โ code review, bug diagnosis, refactoring plan, test generation, docstring fill. Data / SQL โ NL-to-SQL with warnings, SQL explain, SQL optimize, data profile, ETL plan. Legal โ contract summary, clause classify, research brief. All templates include mandatory legal disclaimer. Medical โ symptom triage, drug interaction, medical literature synthesis. All templates include mandatory medical disclaimer. Creative โ story continuation (zero-shot + few-shot), poetry forms, character bio, world building. Business โ meeting summary, email draft (formal/casual), OKR generation, SWOT analysis, elevator pitch.
effgen prompts list
effgen prompts list --domain research
effgen prompts show research.literature_review.v1.cot
effgen prompts eval --domain coding --live --model gpt-oss-120b
effgen prompts playground
from effgen.prompts.library import registry
p = registry.get("data.sql_from_nl.v1")
sql_prompt = p.template(
schema_ddl="CREATE TABLE orders (id INT, customer TEXT, total FLOAT, created_at DATE)",
question="Total revenue per customer this month",
dialect="postgresql",
)
What's new in v0.2.6 โ 14 tools: OCR, audio, images, documents, geo/weather & comms
effGen v0.2.6 adds 14 new built-in tools across document, media, and communication categories, and two new presets (media, notify).
-
OCR โ
OCRTool(Tesseract local + OCR.space fallback;OCRBackendUnavailableraised with install instructions).import asyncio from effgen.tools.builtin.ocr import OCRTool result = asyncio.run(OCRTool().execute(operation="extract", image_path="/tmp/scan.png")) print(result.output["text"])
-
Audio Transcription โ
AudioTranscribeTool(faster-whisper local; HF Inference fallback; GPU auto-detected). -
Image Analysis โ
ImageInfoTool(Pillow metadata, zero network) +ImageCaptionTool(vision-capable model router). -
Document Parsing โ
PDFTool(pypdf + pdfplumber),DOCXTool(python-docx),ExcelTool(openpyxl + pandas). Added toresearchandgeneralpresets.import asyncio from effgen.tools.builtin.pdf import PDFTool result = asyncio.run(PDFTool().execute(operation="text", path="/tmp/paper.pdf"))
-
Geo / Weather โ
WeatherTool(Open-Meteo, free, no auth),GeocodeTool(Nominatim/OSM, 1 req/s),MapsTool(staticmap PNG renderer). -
Email & Webhooks โ
EmailSMTPTool,EmailIMAPTool,SlackWebhookTool,DiscordWebhookTool. All in the newnotifypreset. Webhook URLs are redacted in logs.
See the full tool gallery.
What's new in v0.2.5 โ 13 free tools: research, news, YouTube, social, translation & QR
effGen v0.2.5 adds 13 free, no-auth-required tools. All integrate with the research and general presets.
-
Academic Research โ
PubMedTool(NCBI, 3 ops, built-in rate limiting),ArXivTool(Atom feed + PDF download),SemanticScholarTool(search + citations + references).import asyncio from effgen.tools.builtin.arxiv import ArXivTool result = asyncio.run(ArXivTool().execute(operation="search", query="transformer attention", max_results=5))
-
News & RSS โ
RSSFeedTool(any RSS/Atom feed),NewsTool(BBC, Reuters, HN, NPR, etc. + optional NewsAPI.org key). -
YouTube โ
YouTubeTranscriptTool(captions without Google API key),YouTubeMetadataTool(via yt-dlp, public content only). -
Social Media โ
RedditTool(public JSON, no OAuth),HackerNewsTool(Firebase API, no auth). -
Translation & Language Detection โ
TranslateTool(LibreTranslate + offline argostranslate fallback),LanguageDetectTool(55+ languages, fully offline). -
QR Codes โ
QRGenerateTool(generate locally),QRReadTool(decode from image, with OpenCV fallback if zbar is unavailable).
See the full tool gallery.
What's new in v0.2.4 โ ModelRouter & Cost Optimizer
-
PolicyBasedRouterโ composable routing engine with three built-in policies. Pick the cheapest provider within your budget, the fastest under your SLA, or simply the first available.from effgen import PolicyBasedRouter, RoutingContext, CostBasedPolicy, LatencyBasedPolicy from effgen.models.capabilities import Capability router = PolicyBasedRouter(policies=[LatencyBasedPolicy(), CostBasedPolicy()]) ctx = RoutingContext( prompt_tokens_estimate=500, user_budget_usd=0.01, latency_budget_ms=3000, required_capabilities={Capability.chat}, ) decision = router.route(ctx) print(decision.chosen) # e.g., ProviderModelPair("cerebras", "gpt-oss-120b") print(decision.eliminated) # [(pair, reason), ...] โ fully explainable
-
Transparent failover โ
route_and_execute(ctx, fn)retries on rate-limits / 5xx / timeouts and moves to the next-best provider. Each hop fires aRouterEventto registered subscribers. -
Cross-process SQLite rate-limit coordination โ share a single rate-limit budget across multiple workers via
RateLimitCoordinator(SQLiteRateLimitStore(...))(WAL-mode, BEGIN IMMEDIATE). -
Persistent cost tracking +
effgen costCLI โ every API call persists to SQLite:effgen cost today # per-provider per-model table effgen cost week # rolling 7-day view effgen cost by-provider # lifetime totals effgen cost set-budget 1.0 # set $1/day cap (BudgetExceededError at 100%)
-
Fully explainable decisions + budget guard โ
RouterDecisionrecords every eliminated provider and why ("rate_limited","no_key","cost_exceeds_budget","latency_exceeds_sla"), and fails over to a free-tier provider when the budget is hit.
What's new in v0.2.3 โ 5 new cloud backends (9 providers total)
-
5 new cloud backends โ
GroqAdapter,TogetherAdapter,FireworksAdapter,ReplicateAdapter,HFInferenceAdapterโ each with streaming, native tools, rate-limit coordination, and cost tracking. 9 providers total.model = load_model("llama-3.1-8b-instant", provider="groq") model = load_model("Qwen/Qwen2.5-72B-Instruct", provider="hf")
-
Unified ProviderRegistry โ
list_providers(),list_models(provider),lookup(model_id)consolidated across all 9 adapters.AmbiguousModelErroron bare IDs shared across providers. -
effgen doctorโ new CLI command showing which providers have API keys configured. -
Backend parity matrix โ canonical agentic task ("(17 ร 23) + sqrt(144) = 403") runs identically across all providers; streaming and error surfaces verified uniform. See
docs/providers/parity.md. -
HuggingFace Router support โ
HFInferenceAdapterwith 124-model dynamic catalog,refresh_models()+check_drift(),ModelUnavailableErrorwithsuggest_alternatives(), and custom Inference Endpoint URL.
What's new in v0.2.2 โ Gemini & Anthropic depth
-
Gemini 3.x/2.5/2.0 + Gemma families โ full model registry with correct context windows, output limits, and feature flags; SDK migrated to
google-genai>=1.0.0. -
Gemini
thinking_budgetโ activate Gemini's internal reasoning withGenerationConfig(thinking_budget=8192, include_thoughts=True); thinking trace surfaces inModelResponse.metadata["thinking"]. -
Gemini grounding + Files API โ
GenerationConfig(grounding=True)injects Google Search;upload_file(path)passes PDFs/images to the model with a 2 GiB guard. -
Gemini native tools โ
GoogleSearchTool,GeminiUrlContextTool,GeminiCodeExecutionToolactivate server-side Gemini capabilities in any Agent. Parallel function calls handled automatically. -
Anthropic Claude 4.7, extended thinking, prompt caching โ full Claude 4.x registry;
GenerationConfig.thinkingfor extended reasoning;mark_cached()+AgentConfig.cache_system_prompt/cache_toolsforcache_control; cache tokens surfaced in usage.
What's new in v0.2.1 โ Cerebras + OpenAI reasoning
-
Cerebras backend โ the models the live API currently serves (
gpt-oss-120b,zai-glm-4.7) with streaming, native function-calling, automatic RPM/TPM/RPD/TPD rate-limit coordination, and per-call cost tracking.pip install effgen[cerebras]and setCEREBRAS_API_KEY. Runeffgen models refresh --provider cerebrasto pick up catalog changes.from effgen import load_model model = load_model("gpt-oss-120b", provider="cerebras")
-
OpenAI gpt-5 / gpt-5.4-nano / o-series reasoning models โ full registry coverage with
reasoning_effort(minimal/low/medium/high) andmax_reasoning_tokensonGenerationConfig. Reasoning payloads are routed only to reasoning-capable models. -
OpenAI prompt caching surfacing โ
cached_input_tokensexposed onModelResponse.usage;AgentConfig.stable_system_prompt=Truekeeps the system prompt anchored at position 0 to maximize OpenAI's automatic โฅ1024-token prefix cache hit rate. -
Structured outputs v2 โ
OpenAIAdapter.generate_structured()with strict JSON Schema;to_openai_schema(pydantic_model)inlines$refs and forcesadditionalProperties: false; refusals raiseModelRefusalError. -
OpenAI native tools โ
OpenAIWebSearchTool,OpenAICodeInterpreterTool,OpenAIFileSearchToolroute through OpenAI's Responses API and compose with effGen's local tools in the same agent.ToolIncompatibleErrorfires at Agent init when paired with a non-OpenAI model.
What's new in v0.2.0 โ the big one
-
Native Tool Calling โ Qwen, Llama, Mistral models use built-in function calling instead of text parsing. Set
tool_calling_mode="native"or"hybrid". Structured JSON/Pydantic output validation included. -
Guardrails & Safety โ PII detection, prompt injection blocking, toxicity filtering, tool permissions. One-liner:
get_guardrail_preset("strict"). -
Production RAG Pipeline โ Ingest PDF/DOCX/HTML/Markdown, semantic+BM25 hybrid search, reranking, inline citations.
create_agent("rag", model, knowledge_base="./docs/"). -
Production API Server โ OpenAI-compatible
/v1/chat/completions, request queuing, agent pooling, multi-tenancy, API keys. Drop-in OpenAI replacement with local SLMs. -
Apple Silicon Native โ MLX & MLX-VLM backends for M1/M2/M3/M4. Metal GPU acceleration, unified memory.
pip install effgen[mlx].
๐ฏ Agent Presets
Get started instantly with ready-to-use agent configurations:
from effgen import load_model
from effgen.presets import create_agent
model = load_model("Qwen/Qwen2.5-3B-Instruct", quantization="4bit")
# One-line agent creation
math_agent = create_agent("math", model) # Calculator + PythonREPL
research_agent = create_agent("research", model) # WebSearch + URLFetch + Wikipedia + academic
coding_agent = create_agent("coding", model) # CodeExecutor + PythonREPL + FileOps + Bash
general_agent = create_agent("general", model) # Broad built-in tool suite
rag_agent = create_agent("rag", model, knowledge_base="./docs/") # RAG pipeline
minimal_agent = create_agent("minimal", model) # Direct inference, no tools
# CLI preset support
effgen run --preset math "What is sqrt(144)?"
effgen run --preset research "Tell me about quantum computing"
9 presets:
mathยทresearchยทcodingยทgeneralยทragยทminimalยทmultimodalยทnotifyยทmedia
๐ ๏ธ Built-in Tools (66)
|
๐ข |
๐ |
๐ป |
๐ |
๐ |
๐ |
๐ฏ |
|
๐ฅ๏ธ |
๐ค๏ธ |
๐ |
๐ |
๐ |
๐ |
๐ |
|
๐ฌ |
๐ |
๐ |
๐ก |
๐ฐ |
โถ๏ธ |
๐ฌ |
|
๐ค |
๐ฅ |
๐ |
๐ |
๐ฑ |
๐ท |
โฆ |
Browse quickstart snippets for all 66 tools in the full tool gallery.
๐ Prompt Library
effGen ships a curated catalog of 35 reusable prompt templates across 8 domains, each with a golden evaluation test and CLI access. Browse the full gallery.
| Domain | Templates | Variants |
|---|---|---|
| Research | 5 | zero-shot, CoT, structured, tool-augmented |
| Coding | 5 | zero-shot, CoT, structured, few-shot, tool-augmented |
| Data / SQL | 5 | zero-shot, CoT, structured, few-shot, tool-augmented |
| Legal | 3 | zero-shot, structured, tool-augmented |
| Medical | 3 | structured, tool-augmented |
| Creative | 5 | zero-shot, CoT, structured, few-shot |
| Business | 5 | zero-shot, CoT, structured, few-shot |
effgen prompts list # browse all 35 templates
effgen prompts show research.paper_summary.v1 # inspect a template
effgen prompts eval # run golden eval (no model needed)
effgen prompts playground # interactive REPL
from effgen.prompts.library import registry
# Get and render a template
p = registry.get("coding.code_review.v1")
prompt = p.template(code="def add(a, b): return a + b", language="python")
# Search templates
cot_prompts = registry.search(variant="cot")
sql_prompts = registry.search(domain="data")
Legal and medical templates enforce a mandatory non-advice disclaimer in every rendered output, verified by unit tests.
๐ค Multi-Model Support
effGen supports 9 cloud inference providers + 4 local backends, tested across 11+ model families:
| Backend | Platform | Install | Best For |
|---|---|---|---|
| MLX | Apple Silicon (M1/M2/M3/M4) | effgen[mlx] |
Native Metal GPU, unified memory, 4/8-bit quantization |
| MLX-VLM | Apple Silicon | effgen[mlx-vlm] |
Vision-Language models (Qwen2-VL, LLaVA, Phi-3 Vision, 30+ architectures) |
| vLLM | NVIDIA GPU | effgen[vllm] |
High-throughput batch inference |
| Transformers | Any (CPU/GPU) | (bundled) | Universal compatibility, local models |
| OpenAI | Cloud API | (bundled) | gpt-5/gpt-5.4/o-series, reasoning_effort, structured outputs, native tools |
| Anthropic | Cloud API | (bundled) | Claude 4.7/4.x, extended thinking, prompt caching, native tools |
| Google Gemini | Cloud API | (bundled) | Gemini 3.x/2.5/2.0, thinking_budget, grounding, Files API, native tools |
| Cerebras | Cloud API | effgen[cerebras] |
live models (gpt-oss-120b, zai-glm-4.7), ultra-low latency |
| Groq | Cloud API | effgen[groq] |
16 models (llama-3.3-70b, mixtral, qwen3-32b), ultra-fast free-tier inference |
| Together AI | Cloud API | effgen[together] |
130+-model catalog (llama, deepseek, qwen, mistral), per-model pricing |
| Fireworks | Cloud API | effgen[fireworks] |
80 chat models (54 tool-capable), serverless + dedicated |
| Replicate | Cloud API | effgen[replicate] |
38 models, async run-poll, SSE streaming, compute-second billing |
| HuggingFace | Cloud API | effgen[hf] |
124-model HF Router catalog, custom Inference Endpoints, free serverless tier |
from effgen import load_model, Agent
from effgen.core.agent import AgentConfig
from effgen.tools.builtin import Calculator
# Any of the 9 cloud providers
model = load_model("llama-3.1-8b-instant", provider="groq") # Groq
# model = load_model("meta-llama/Llama-3.3-70B-Instruct-Turbo", provider="together")
# model = load_model("Qwen/Qwen2.5-72B-Instruct", provider="hf")
agent = Agent(config=AgentConfig(name="agent", model=model, tools=[Calculator()]))
result = agent.run("What is (17 * 23) + sqrt(144)?")
print(result.output) # โ 403
effgen doctor # see which provider API keys are configured
Top Recommended Models
| Model | Size | Compatibility |
|---|---|---|
| LFM2.5-1.2B-Instruct-MLX-8bit | 1.2B | Apple Silicon optimized, fast agentic |
| Qwen2.5-1.5B-Instruct | 1.5B | 10/10 agents pass |
| Qwen2.5-3B-Instruct | 3B | 10/10 agents pass (recommended default) |
| Phi-4-mini-instruct | 3.8B | 10/10 agents pass |
| Qwen3-1.7B | 1.7B | 9.5/10 |
| Qwen2.5-7B-Instruct | 7B | 9/10 |
| Llama-3.2-3B-Instruct | 3B | 8.5/10 |
Full matrix with 11 models ร 10 agents: compatibility_matrix.md
๐ Examples
|
๐ค Core agents python examples/basic/qa_agent.py # Q&A agent (no tools)
python examples/basic/calculator_agent.py # Math: Calculator + PythonREPL
python examples/tools/multi_tool_agent.py # Simple multi-tool
python examples/tools/advanced_multi_tool_agent.py # 5 tools + fallback chains
python examples/tools/file_operations_agent.py # File read/write/search
python examples/tools/coding_agent.py # Code execution + iteration
python examples/advanced/conversational_agent.py # Multi-turn memory
python examples/advanced/advanced_streaming_agent.py # Streaming w/ callbacks
python examples/advanced/data_processing_agent.py # JSON & data pipelines
python examples/advanced/multi_agent_pipeline.py # Multi-agent orchestration
python examples/advanced/error_recovery_agent.py # Error-handling patterns
โก Quick-start agents python examples/basic/basic_agent.py # Basic (Transformers)
python examples/basic/basic_agent_vllm.py # Basic (vLLM, 5-10ร faster)
python examples/plugins_presets/preset_agents.py # Ready-to-use presets
python examples/plugins_presets/plugin_example.py # Custom tool plugins
python examples/web_retrieval/web_agent.py # Web search agent
python examples/web_retrieval/retrieval_agent.py # RAG retrieval
python examples/web_retrieval/weather_agent.py # Weather (Open-Meteo, free)
python examples/web_retrieval/streaming_agent.py # Simple streaming
python examples/web_retrieval/memory_agent.py # Simple multi-turn memory
|
๐ผ๏ธ GUI applications (Gradio) python examples/basic/chat_gui_mlx.py # MLX streaming chat (:7860)
python examples/basic/agent_viz_mlx.py # Reasoning + code editor (:7860)
python examples/basic/tool_builder_gui.py # Build custom tools (:7863)
python examples/basic/tool_tester_gui.py # Browse/test all 66 tools (:7864)
๐ Apple Silicon (MLX) python examples/basic/basic_agent_mlx.py # Basic MLX agent + calculator
python examples/basic/chat_gui_mlx.py --autoload # Chat GUI, auto model load
python examples/basic/agent_viz_mlx.py --autoload # Visualizer, auto model load
|
๐ See examples/compatibility_matrix.md for model compatibility across all agents.
๐ More code examples (multi-tool, streaming, memory, RAG)
Multi-Tool Agent
from effgen import Agent, load_model
from effgen.core.agent import AgentConfig
from effgen.tools.builtin import Calculator, WebSearch, PythonREPL
model = load_model("Qwen/Qwen2.5-3B-Instruct")
config = AgentConfig(
name="research_agent",
model=model,
tools=[Calculator(), WebSearch(), PythonREPL()],
system_prompt="You are a research assistant.",
)
agent = Agent(config=config)
result = agent.run("Search for the population of Tokyo and calculate what percentage it is of Japan's total population")
Streaming
from effgen import Agent, load_model
from effgen.core.agent import AgentConfig
from effgen.tools.builtin import Calculator
model = load_model("Qwen/Qwen2.5-3B-Instruct", quantization="4bit")
agent = Agent(config=AgentConfig(
name="stream_demo", model=model,
tools=[Calculator()], enable_streaming=True,
))
for token in agent.stream("What is 2 + 2?"):
print(token, end="", flush=True)
Memory (Multi-Turn)
agent = Agent(config=AgentConfig(
name="memory_demo", model=model,
tools=[], enable_memory=True,
))
agent.run("My name is Alice and I'm working on quantum computing.")
result = agent.run("What's my name and what am I working on?")
# โ "Your name is Alice and you're working on quantum computing."
Retrieval Agent (RAG)
from effgen.tools.builtin import Retrieval
retrieval_tool = Retrieval(knowledge_base_path="./docs")
config = AgentConfig(name="qa_agent", model=model, tools=[retrieval_tool])
agent = Agent(config=config)
result = agent.run("What does the documentation say about configuration?")
๐ Deployment
effGen ships production-ready deployment recipes for every major target.
|
๐ณ Docker โ multi-stage build, non-root user, read-only FS, docker build -f deploy/docker/Dockerfile -t effgen .
docker run -p 8000:8000 --env-file .env effgen
curl http://localhost:8000/health
โ Kubernetes / Helm โ Deployment, Service, Ingress, NetworkPolicy, PDB, HPA (scales on CPU + helm lint deploy/k8s/helm/effgen/
helm install effgen deploy/k8s/helm/effgen/
|
ฮป AWS Lambda โ Mangum adapter over the FastAPI app. Cold start < 3 s; warm call < 100 ms. SAM template included. See cd deploy/aws_lambda
sam build && sam deploy --guided
โ Cloudflare Worker โ thin edge proxy for CORS, Bearer-JWT auth, and KV-backed rate limiting. See cd deploy/cloudflare
wrangler deploy # staging: wrangler deploy --env staging
|
๐ท Developer Experience
|
VS Code Extension Prompt-template completion, inline "Run" code lens, and hover docs from the effGen registry. See cd tools/vscode-effgen
npm ci && npm run compile
|
Jupyter Magics %load_ext effgen.jupyter
%effgen_chat "What is 17 * 23?"
%%effgen_agent general
Summarise the top HackerNews
stories and rank by interest.
%effgen_metrics
See |
Live Dashboard Real-time SPA at EFFGEN_DEV_MODE=1 effgen serve --port 8000
open http://localhost:8000/dashboard
|
๐ Security
|
๐ณ |
๐ก๏ธ |
๐ |
โก |
Secret scanning. Gitleaks pre-commit hook + CI workflow (secret-scan.yml) catch secrets before they reach the repo:
pip install pre-commit && pre-commit install
Sandboxed code execution. CodeExecutor defaults to SubprocessSandbox (rootless user-namespace, network blocked, isolated /tmp) or DockerSandbox when Docker is available. To opt out (not recommended):
EFFGEN_SANDBOX_BACKEND=off effgen run ... # a loud warning is emitted
API server auth. Protect the server with OAuth2/OIDC (Auth0, Keycloak, Cognito โ any OIDC provider):
export EFFGEN_OIDC_ISSUER=https://your-tenant.auth0.com/
export EFFGEN_OIDC_CLIENT_ID=your-client-id
export EFFGEN_OIDC_JWKS_URI=https://your-tenant.auth0.com/.well-known/jwks.json
effgen serve --port 8000
๐ See SECURITY.md for policies and vulnerability reporting, plus
docs/server/auth.md,docs/server/rbac.md, anddocs/server/audit.md.
๐ Citation
If you use effGen in your research, please cite our paper:
@software{srivastava2026effgen,
title={effGen: Enabling Small Language Models as Capable Autonomous Agents},
author={Gaurav Srivastava and Aafiya Hussain and Chi Wang and Yingyan Celine Lin and Xuan Wang},
year={2026},
eprint={2602.00887},
archivePrefix={arXiv},
primaryClass={cs.CL},
url={https://arxiv.org/abs/2602.00887},
}
๐ Links & License
Licensed under the Apache License 2.0 โ see LICENSE for details.
Made with โค๏ธ for the AI community
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file effgen-0.3.2.tar.gz.
File metadata
- Download URL: effgen-0.3.2.tar.gz
- Upload date:
- Size: 1.5 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.9.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
22429455361b28aa719222814494bc27a5cbc0cbc993648a43d4521febe199d7
|
|
| MD5 |
3922cfcc8edb1f6b9e9d319f8bf796d5
|
|
| BLAKE2b-256 |
5eb7ca3b230d52fc4096a9df24ac47684102ad458c277a528f0b710b9ae8fdf6
|
File details
Details for the file effgen-0.3.2-py3-none-any.whl.
File metadata
- Download URL: effgen-0.3.2-py3-none-any.whl
- Upload date:
- Size: 1.3 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.9.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
041d5ed4096076a55dc57721abe13105481d7b7ab175a36c70c4a2ed683146af
|
|
| MD5 |
b5840d0506af90785afb8a1eac95f962
|
|
| BLAKE2b-256 |
aaeae388c57db05c65d93f78324f54da7d7f12c708f073b39a0decb2f592ed16
|