Spaces:
Running
Running
| <html lang="en"> | |
| <head> | |
| <meta charset="UTF-8"> | |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> | |
| <meta name="description" content="SLM Math Agent: Specialized arithmetic reasoning model. Handles math formulations, algebraic simplifications, and steps through complex equations offline."> | |
| <link rel="canonical" href="https://www.slmagents.ai/math_agent.html"> | |
| <title>SLM Math Agent | Documentation</title> | |
| <link rel="stylesheet" href="style.css"> | |
| </head> | |
| <body> | |
| <header> | |
| <div class="container nav-container"> | |
| <div style="display: flex; align-items: center; gap: 10px;"> | |
| <button class="sidebar-toggle" onclick="toggleSidebar()"> | |
| <svg width="24" height="24" fill="none" stroke="currentColor" stroke-width="2" viewBox="0 0 24 24"> | |
| <path stroke-linecap="round" stroke-linejoin="round" d="M4 6h16M4 12h16M4 18h16"/> | |
| </svg> | |
| </button> | |
| <a href="index.html" class="logo"> | |
| <div class="logo-icon"> | |
| <svg width="18" height="18" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2.5" stroke-linecap="round" stroke-linejoin="round"> | |
| <path d="M12 2L2 7l10 5 10-5-10-5zM2 17l10 5 10-5M2 12l10 5 10-5"/> | |
| </svg> | |
| </div> | |
| <span>SLM Agents</span> | |
| </a> | |
| </div> | |
| <nav> | |
| <ul> | |
| <li><a href="index.html">Home</a></li> | |
| <li class="dropdown"> | |
| <a class="dropdown-trigger"> | |
| Frameworks | |
| <svg width="12" height="12" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="3" stroke-linecap="round" stroke-linejoin="round"><path d="M6 9l6 6 6-6"/></svg> | |
| </a> | |
| <div class="dropdown-content"> | |
| <a href="orchestrator.html">Orchestrator Docs</a> | |
| <a href="rag.html">RAG Docs</a> | |
| <a href="summarizer.html">Summarizer Docs</a> | |
| <a href="sql.html">Text-to-SQL Docs</a> | |
| <a href="cli.html">CLI Agent Docs</a> | |
| <a href="code_interpreter.html">Code Interpreter Docs</a> | |
| <a href="git_repo_manager.html">Git Repo Manager Docs</a> | |
| <a href="json_cleaner.html">JSON Cleaner Docs</a> | |
| <a href="document_parser.html">Document Parser Docs</a> | |
| <a href="vision_parser.html">Vision Parser Docs</a> | |
| <a href="web_agent.html">Web Agent Docs</a> | |
| <a href="web_scraper.html">Web Scraper Docs</a> | |
| <a href="search_orchestrator.html">Search Orchestrator Docs</a> | |
| </div> | |
| </li> | |
| <li><a href="playground.html">Playground</a></li> | |
| <li><a href="index.html#upcoming">Roadmap</a></li> | |
| <li><a href="https://huggingface.co/spaces/spcv/slm-agents" class="btn-hf-nav" target="_blank" style="display: flex; align-items: center; gap: 6px; padding: 7px 14px; border-radius: 8px; background: #fef3c7; border: 1px solid #f59e0b; color: #b45309; font-weight: 700; text-decoration: none; font-size: 0.85rem; transition: all 0.2s;">🤗 Hugging Face Space</a></li> | |
| </ul> | |
| </nav> | |
| </div> | |
| </header> | |
| <div class="layout-container"> | |
| <aside class="sidebar" id="sidebar"> | |
| <div class="sidebar-group"> | |
| <div class="sidebar-group-title">Active Libraries</div> | |
| <ul class="sidebar-list" id="sidebar-active-list"></ul> | |
| </div> | |
| </aside> | |
| <main class="main-content"> | |
| <div class="doc-content-wrapper"> | |
| <section class="doc-section" style="margin-top: 0;"> | |
| <div class="breadcrumb" style="font-size: 0.85rem; color: #475569; margin-bottom: 1rem; font-weight: 600;"><a href="index.html" style="color: #4f46e5; text-decoration: none;">Home</a> <span style="margin: 0 6px;">›</span> <span style="color: #0f172a;">SLM Math Agent</span></div> | |
| <div class="badge-pill">📐 Symbolic Algebra solver</div> | |
| <h1 style="font-size: 2.25rem; color: #0f172a; font-weight: 800; margin-bottom: 0.75rem;">SLM Math Agent</h1> | |
| <p style="font-size: 1.05rem; color: #334155; line-height: 1.65; font-weight: 500; margin: 0;">Specialized arithmetic reasoning model. Handles math formulations, algebraic simplifications, and steps through complex equations offline.</p> | |
| </section> | |
| <nav class="doc-nav"> | |
| <a href="#overview">Overview</a> | |
| <a href="#install"> | |
| <a href="#git">Git Checkout</a>Installation</a> | |
| <a href="#config">Configuration API</a> | |
| <a href="#performance">Performance</a> | |
| </nav> | |
| <section class="doc-section" id="overview"> | |
| <h2>🚀 Overview & Capabilities</h2> | |
| <p>Specialized arithmetic reasoning model. Handles math formulations, algebraic simplifications, and steps through complex equations offline.</p> | |
| <h3 style="margin-top: 1.5rem; font-size: 1.15rem; color: #0f172a; font-weight: 700;">Key Features</h3> | |
| <ul> | |
| <li><strong>Symbolic algebra calculator mapping using local SymPy</strong></li> | |
| <li><strong>Parses equations and graphs steps to final result</strong></li> | |
| <li><strong>Verifies intermediate steps to prevent math hallucinations</strong></li> | |
| <li><strong>Optimized math tokens prompt training templates</strong></li> | |
| </ul> | |
| </section> | |
| <section class="doc-section" id="install"> | |
| <h2>💻 Installation</h2> | |
| <p>Install the local CPU-optimized package using pip:</p> | |
| <div class="code-panel" style="max-width:100%"> | |
| <div class="code-header"><div class="code-dots"><div class="code-dot"></div><div class="code-dot"></div><div class="code-dot"></div></div><div class="code-title">Terminal</div></div> | |
| <div class="code-content" style="display:block;padding:1.5rem"> | |
| <pre><code><span class="comment"># Install local CPU-optimized package</span> | |
| pip install slm-math</code></pre> | |
| </div> | |
| </div> | |
| </section> | |
| <!-- GIT CHECKOUT --> | |
| <section class="doc-section" id="git"> | |
| <h2>🐙 Checkout from GitHub</h2> | |
| <p>Clone only this agent's folder from the monorepo using Git sparse-checkout — no need to download the full repository:</p> | |
| <h3 style="font-size: 1.05rem; color: #0f172a; font-weight: 700; margin-top: 1.5rem; margin-bottom: 0.75rem;">Option 1 — Sparse Checkout (Recommended)</h3> | |
| <div class="code-panel" style="max-width:100%; background: #0f172a; border: 1px solid #1e293b; border-radius: 14px; overflow: hidden; margin: 1rem 0; box-shadow: 0 16px 40px rgba(15, 23, 42, 0.12);"> | |
| <div class="code-header" style="background: #1e293b; padding: 10px 16px; display: flex; align-items: center; justify-content: space-between; border-bottom: 1px solid #334155;"> | |
| <div class="code-dots"><div class="code-dot"></div><div class="code-dot"></div><div class="code-dot"></div></div> | |
| <div class="code-title" style="color: #94a3b8; font-weight: 700; font-size: 0.8rem; font-family: 'JetBrains Mono', monospace;">Terminal — Git Sparse Checkout</div> | |
| </div> | |
| <div class="code-content" style="display:block; padding: 1.25rem 1.5rem; background: #0f172a;"> | |
| <pre style="margin:0; background:#0f172a; color:#f8fafc; font-family:'JetBrains Mono',monospace; font-size:0.88rem; border:none; box-shadow:none; padding:0; line-height: 1.75;"><span style="color:#64748b;"># 1. Create and enter a new directory</span> | |
| <span style="color:#34d399;">$</span> <span style="color:#c084fc; font-weight:700;">mkdir</span> <span style="color:#38bdf8;">slm_math</span> <span style="color:#94a3b8;">&&</span> <span style="color:#c084fc; font-weight:700;">cd</span> <span style="color:#38bdf8;">slm_math</span> | |
| <span style="color:#64748b;"># 2. Initialise empty git repo and add remote</span> | |
| <span style="color:#34d399;">$</span> <span style="color:#c084fc; font-weight:700;">git init</span> | |
| <span style="color:#34d399;">$</span> <span style="color:#c084fc; font-weight:700;">git remote add origin</span> <span style="color:#38bdf8;">https://github.com/t00114218-stack/SLMAgents.git</span> | |
| <span style="color:#64748b;"># 3. Enable sparse-checkout and set target folder</span> | |
| <span style="color:#34d399;">$</span> <span style="color:#c084fc; font-weight:700;">git sparse-checkout init</span> <span style="color:#94a3b8;">--cone</span> | |
| <span style="color:#34d399;">$</span> <span style="color:#c084fc; font-weight:700;">git sparse-checkout set</span> <span style="color:#38bdf8;">slm_math</span> | |
| <span style="color:#64748b;"># 4. Pull only that agent's source</span> | |
| <span style="color:#34d399;">$</span> <span style="color:#c084fc; font-weight:700;">git pull origin</span> <span style="color:#38bdf8;">main</span></pre> | |
| </div> | |
| </div> | |
| <h3 style="font-size: 1.05rem; color: #0f172a; font-weight: 700; margin-top: 2rem; margin-bottom: 0.75rem;">Option 2 — Full Repository Clone</h3> | |
| <div class="code-panel" style="max-width:100%; background: #0f172a; border: 1px solid #1e293b; border-radius: 14px; overflow: hidden; margin: 1rem 0;"> | |
| <div class="code-header" style="background: #1e293b; padding: 10px 16px; display: flex; align-items: center; justify-content: space-between; border-bottom: 1px solid #334155;"> | |
| <div class="code-dots"><div class="code-dot"></div><div class="code-dot"></div><div class="code-dot"></div></div> | |
| <div class="code-title" style="color: #94a3b8; font-weight: 700; font-size: 0.8rem; font-family: 'JetBrains Mono', monospace;">Terminal — Full Clone</div> | |
| </div> | |
| <div class="code-content" style="display:block; padding: 1.25rem 1.5rem; background: #0f172a;"> | |
| <pre style="margin:0; background:#0f172a; color:#f8fafc; font-family:'JetBrains Mono',monospace; font-size:0.88rem; border:none; box-shadow:none; padding:0; line-height: 1.75;"><span style="color:#34d399;">$</span> <span style="color:#c084fc; font-weight:700;">git clone</span> <span style="color:#38bdf8;">https://github.com/t00114218-stack/SLMAgents.git</span> | |
| <span style="color:#34d399;">$</span> <span style="color:#c084fc; font-weight:700;">cd</span> <span style="color:#38bdf8;">SLMAgents/slm_math</span></pre> | |
| </div> | |
| </div> | |
| <p style="margin-top: 1.25rem; font-size: 0.9rem; color: #475569; background: #f8fafc; border: 1px solid #cbd5e1; border-radius: 10px; padding: 1rem 1.25rem;"> | |
| 💡 <strong>Tip:</strong> After checkout, install the package locally with <code style="background: #eef2ff; color: #4f46e5; border: 1px solid #c7d2fe; padding: 2px 8px; border-radius: 5px; font-weight: 700;">pip install -e ./slm_math</code> to run in editable mode without publishing to PyPI. | |
| </p> | |
| </section> | |
| <section class="doc-section" id="config"> | |
| <h2>⚙️ Configuration API</h2> | |
| <h3>Constructor Parameters</h3> | |
| <p>Instantiate <code>SLMMathAgent</code> with performance options:</p> | |
| <table class="param-table"> | |
| <thead> | |
| <tr><th>Parameter</th><th>Type / Default</th><th>Description</th></tr> | |
| </thead> | |
| <tbody> | |
| <tr><td>model_path</td><td>str | None</td><td>Explicit path to ONNX model weights. If omitted, downloads standard checkpoints.</td></tr> | |
| <tr><td>cache_dir</td><td>str | None</td><td>Directory to store model weights offline. Defaults to <code>~/.cache/slm-math/</code>. Also settable via <span class="env-tag">SLM_MATH_AGENT_CACHE_DIR</span>.</td></tr> | |
| <tr><td>n_threads</td><td>int | 4</td><td>CPU thread count for ONNX inference. Optimize for CPU core count. Also settable via <span class="env-tag">SLM_MATH_AGENT_N_THREADS</span>.</td></tr> | |
| </tbody> | |
| </table> | |
| <h3>Methods</h3> | |
| <table class="param-table"> | |
| <thead> | |
| <tr><th>Method Signature</th><th>Return Type</th><th>Description</th></tr> | |
| </thead> | |
| <tbody> | |
| <tr><td><code>solve(equation_text, system_prompt=None, user_input=None)</code></td><td><code>dict</code></td><td>Steps through equation parameters to simplify, expand, or integrate math queries.</td></tr> | |
| </tbody> | |
| </table> | |
| <h3>Method Parameters (Execution Customization)</h3> | |
| <p>All main execution methods accept optional system routing parameters:</p> | |
| <table class="param-table"> | |
| <thead> | |
| <tr><th>Parameter</th><th>Type / Default</th><th>Description</th></tr> | |
| </thead> | |
| <tbody> | |
| <tr><td>system_prompt</td><td>str | None</td><td>Optional custom system prompt instruction to override the default system template response parameters.</td></tr> | |
| <tr><td>user_input</td><td>str | None</td><td>Optional additional user-supplied target text variables or contextual keys.</td></tr> | |
| </tbody> | |
| </table> | |
| <h3>Quick Start</h3> | |
| <pre><code class="language-python">from slm_math import SLMMathAgent | |
| agent = SLMMathAgent() | |
| steps = agent.solve( | |
| "integrate x^2 from 0 to 3", | |
| system_prompt="Limit decimal rounding to 2 places", | |
| user_input="Render steps in latex format" | |
| ) | |
| print(steps)</code></pre> | |
| </section> | |
| <section class="doc-section" id="env-vars"> | |
| <h2>Environment Variables</h2> | |
| <p>Configure agent parameters globally using environment values:</p> | |
| <table class="param-table"> | |
| <thead> | |
| <tr><th>Environment Variable</th><th>Default</th><th>Purpose</th></tr> | |
| </thead> | |
| <tbody> | |
| <tr><td>SLM_MATH_AGENT_N_THREADS</td><td>4</td><td>Sets CPU inference execution threads.</td></tr> | |
| <tr><td>SLM_MATH_AGENT_CACHE_DIR</td><td>~/.cache/slm-math/</td><td>Default directory to store downloaded ONNX weights.</td></tr> | |
| </tbody> | |
| </table> | |
| </section> | |
| <section class="doc-section" id="performance"> | |
| <h2>CPU Performance Tuning</h2> | |
| <p>To run the <code>SLMMathAgent</code> engine efficiently on CPU under 1.5 GB memory footprint:</p> | |
| <ul> | |
| <li><strong>Match Threads to Core Count:</strong> Set <code>n_threads</code> or <code>SLM_MATH_AGENT_N_THREADS</code> to match the physical CPU core count.</li> | |
| <li><strong>Sequential Processing:</strong> Avoid concurrent processing when batch files are large.</li> | |
| <li><strong>Garbage Collection:</strong> Clear variables and run <code>gc.collect()</code> to release model RAM blocks after execution.</li> | |
| </ul> | |
| </section> | |
| <section class="doc-section"> | |
| <h2>Verified Input & Output Logs</h2> | |
| <p>Diagnostic execution console response running locally on CPU:</p> | |
| <div class="tip-box" style="background: rgba(30, 41, 59, 0.7); border: 1px solid rgba(255, 255, 255, 0.08);"> | |
| <pre><code style="color: #38bdf8; font-family: monospace; font-size: 0.9rem; line-height: 1.5; display: block; white-space: pre-wrap;">→ INPUT: | |
| "integrate x^2 from 0 to 3" | |
| ← OUTPUT: | |
| { | |
| 'equation': 'integrate(x^2, 0, 3)', | |
| 'result': '9' | |
| }</code></pre> | |
| </div> | |
| </section> | |
| <footer style="margin-top: 3rem; text-align: center; border-top: 1px solid #cbd5e1; padding-top: 2rem; color: #475569; font-size: 0.9rem; font-weight: 500;"> | |
| <p>© 2026 SLM Agents. Built with Apache 2.0 Permissive Open Source License.</p> | |
| </footer> | |
| </div> | |
| </main> | |
| </div> | |
| <script src="app.js"></script> | |
| </body> | |
| </html> | |