Skip to content

Commit 0f14a45

Browse files
Deployed 8e69cdc to dev with MkDocs 1.6.1 and mike 2.2.0
1 parent 6c0e2d5 commit 0f14a45

10 files changed

Lines changed: 1036 additions & 866 deletions

File tree

dev/changelog/index.html

Lines changed: 220 additions & 24 deletions
Large diffs are not rendered by default.

dev/cli/commands/index.html

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2902,16 +2902,16 @@ <h4 id="examples">Examples<a class="headerlink" href="#examples" title="Permanen
29022902
<h4 id="generated-output">Generated Output<a class="headerlink" href="#generated-output" title="Permanent link">&para;</a></h4>
29032903
<div class="language-text highlight"><pre><span></span><code><span id="__span-5-1"><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a>📁 agents/helper_bot
29042904
</span><span id="__span-5-2"><a id="__codelineno-5-2" name="__codelineno-5-2" href="#__codelineno-5-2"></a>├── 📄 __init__.py
2905-
</span><span id="__span-5-3"><a id="__codelineno-5-3" name="__codelineno-5-3" href="#__codelineno-5-3"></a>├── 📄 graph.py
2906-
</span><span id="__span-5-4"><a id="__codelineno-5-4" name="__codelineno-5-4" href="#__codelineno-5-4"></a>├── 📄 nodes.py
2905+
</span><span id="__span-5-3"><a id="__codelineno-5-3" name="__codelineno-5-3" href="#__codelineno-5-3"></a>├── 📄 agent.py
2906+
</span><span id="__span-5-4"><a id="__codelineno-5-4" name="__codelineno-5-4" href="#__codelineno-5-4"></a>├── 📄 llm.py
29072907
</span><span id="__span-5-5"><a id="__codelineno-5-5" name="__codelineno-5-5" href="#__codelineno-5-5"></a>├── 📄 config.py
29082908
</span><span id="__span-5-6"><a id="__codelineno-5-6" name="__codelineno-5-6" href="#__codelineno-5-6"></a>├── 📄 prompts.json
29092909
</span><span id="__span-5-7"><a id="__codelineno-5-7" name="__codelineno-5-7" href="#__codelineno-5-7"></a>├── 📄 langgraph.json
29102910
</span><span id="__span-5-8"><a id="__codelineno-5-8" name="__codelineno-5-8" href="#__codelineno-5-8"></a>├── 📄 .env.example
29112911
</span><span id="__span-5-9"><a id="__codelineno-5-9" name="__codelineno-5-9" href="#__codelineno-5-9"></a>└── 📄 README.md
29122912
</span><span id="__span-5-10"><a id="__codelineno-5-10" name="__codelineno-5-10" href="#__codelineno-5-10"></a>
29132913
</span><span id="__span-5-11"><a id="__codelineno-5-11" name="__codelineno-5-11" href="#__codelineno-5-11"></a>🚀 What&#39;s next?
2914-
</span><span id="__span-5-12"><a id="__codelineno-5-12" name="__codelineno-5-12" href="#__codelineno-5-12"></a> 1. Edit helper_bot/nodes.py with your logic
2914+
</span><span id="__span-5-12"><a id="__codelineno-5-12" name="__codelineno-5-12" href="#__codelineno-5-12"></a> 1. Edit helper_bot/agent.py with your logic
29152915
</span><span id="__span-5-13"><a id="__codelineno-5-13" name="__codelineno-5-13" href="#__codelineno-5-13"></a> 2. agentomatic run to start
29162916
</span><span id="__span-5-14"><a id="__codelineno-5-14" name="__codelineno-5-14" href="#__codelineno-5-14"></a> 3. agentomatic test helper_bot to test
29172917
</span><span id="__span-5-15"><a id="__codelineno-5-15" name="__codelineno-5-15" href="#__codelineno-5-15"></a> 4. Open http://localhost:8000/docs for API docs
@@ -3126,8 +3126,8 @@ <h4 id="example-output_1">Example Output<a class="headerlink" href="#example-out
31263126
</span><span id="__span-23-5"><a id="__codelineno-23-5" name="__codelineno-23-5" href="#__codelineno-23-5"></a>
31273127
</span><span id="__span-23-6"><a id="__codelineno-23-6" name="__codelineno-23-6" href="#__codelineno-23-6"></a>📁 my_chatbot/
31283128
</span><span id="__span-23-7"><a id="__codelineno-23-7" name="__codelineno-23-7" href="#__codelineno-23-7"></a>├── 📄 __init__.py (1,245 bytes)
3129-
</span><span id="__span-23-8"><a id="__codelineno-23-8" name="__codelineno-23-8" href="#__codelineno-23-8"></a>├── 📄 graph.py (2,891 bytes)
3130-
</span><span id="__span-23-9"><a id="__codelineno-23-9" name="__codelineno-23-9" href="#__codelineno-23-9"></a>├── 📄 nodes.py (3,456 bytes)
3129+
</span><span id="__span-23-8"><a id="__codelineno-23-8" name="__codelineno-23-8" href="#__codelineno-23-8"></a>├── 📄 agent.py (2,891 bytes)
3130+
</span><span id="__span-23-9"><a id="__codelineno-23-9" name="__codelineno-23-9" href="#__codelineno-23-9"></a>├── 📄 llm.py (890 bytes)
31313131
</span><span id="__span-23-10"><a id="__codelineno-23-10" name="__codelineno-23-10" href="#__codelineno-23-10"></a>├── 📄 config.py (512 bytes)
31323132
</span><span id="__span-23-11"><a id="__codelineno-23-11" name="__codelineno-23-11" href="#__codelineno-23-11"></a>├── 📄 prompts.json (678 bytes)
31333133
</span><span id="__span-23-12"><a id="__codelineno-23-12" name="__codelineno-23-12" href="#__codelineno-23-12"></a>├── 📄 tools.py (1,024 bytes)
@@ -3136,7 +3136,7 @@ <h4 id="example-output_1">Example Output<a class="headerlink" href="#example-out
31363136
</span><span id="__span-23-15"><a id="__codelineno-23-15" name="__codelineno-23-15" href="#__codelineno-23-15"></a>
31373137
</span><span id="__span-23-16"><a id="__codelineno-23-16" name="__codelineno-23-16" href="#__codelineno-23-16"></a>╭── __init__.py ──────────────────────────────────╮
31383138
</span><span id="__span-23-17"><a id="__codelineno-23-17" name="__codelineno-23-17" href="#__codelineno-23-17"></a>│ from agentomatic import AgentManifest │
3139-
</span><span id="__span-23-18"><a id="__codelineno-23-18" name="__codelineno-23-18" href="#__codelineno-23-18"></a>│ from .graph import get_graph
3139+
</span><span id="__span-23-18"><a id="__codelineno-23-18" name="__codelineno-23-18" href="#__codelineno-23-18"></a>│ from .agent import MyChatbotAgent
31403140
</span><span id="__span-23-19"><a id="__codelineno-23-19" name="__codelineno-23-19" href="#__codelineno-23-19"></a>│ │
31413141
</span><span id="__span-23-20"><a id="__codelineno-23-20" name="__codelineno-23-20" href="#__codelineno-23-20"></a>│ manifest = AgentManifest( │
31423142
</span><span id="__span-23-21"><a id="__codelineno-23-21" name="__codelineno-23-21" href="#__codelineno-23-21"></a>│ name=&quot;my_chatbot&quot;, │
@@ -3205,12 +3205,13 @@ <h3 id="agentomatic-optimize"><code>agentomatic optimize</code><a class="headerl
32053205
</span><span id="__span-26-12"><a id="__codelineno-26-12" name="__codelineno-26-12" href="#__codelineno-26-12"></a> --target-score FLOAT Stop when this avg score is reached [default: 0.9]
32063206
</span><span id="__span-26-13"><a id="__codelineno-26-13" name="__codelineno-26-13" href="#__codelineno-26-13"></a> --rewrite-llm TEXT LLM for prompt rewriting
32073207
</span><span id="__span-26-14"><a id="__codelineno-26-14" name="__codelineno-26-14" href="#__codelineno-26-14"></a> --eval-llm TEXT LLM for evaluation grading
3208-
</span><span id="__span-26-15"><a id="__codelineno-26-15" name="__codelineno-26-15" href="#__codelineno-26-15"></a> --llm TEXT Default fallback LLM [default: ollama/mistral:7b]
3209-
</span><span id="__span-26-16"><a id="__codelineno-26-16" name="__codelineno-26-16" href="#__codelineno-26-16"></a> --patience INT Early stopping patience [default: 3]
3210-
</span><span id="__span-26-17"><a id="__codelineno-26-17" name="__codelineno-26-17" href="#__codelineno-26-17"></a> --prompt TEXT Initial system prompt (overrides prompts.json)
3211-
</span><span id="__span-26-18"><a id="__codelineno-26-18" name="__codelineno-26-18" href="#__codelineno-26-18"></a> --no-report Skip generating HTML report
3212-
</span><span id="__span-26-19"><a id="__codelineno-26-19" name="__codelineno-26-19" href="#__codelineno-26-19"></a> --apply Auto-save the best-performing prompt
3213-
</span><span id="__span-26-20"><a id="__codelineno-26-20" name="__codelineno-26-20" href="#__codelineno-26-20"></a> --host TEXT Platform API base URL [default: http://localhost:8000]
3208+
</span><span id="__span-26-15"><a id="__codelineno-26-15" name="__codelineno-26-15" href="#__codelineno-26-15"></a> --llm TEXT Default fallback LLM (env: AGENTOMATIC_TASK_MODEL /
3209+
</span><span id="__span-26-16"><a id="__codelineno-26-16" name="__codelineno-26-16" href="#__codelineno-26-16"></a> LLM__MODEL; else ollama/mistral:7b)
3210+
</span><span id="__span-26-17"><a id="__codelineno-26-17" name="__codelineno-26-17" href="#__codelineno-26-17"></a> --patience INT Early stopping patience [default: 3]
3211+
</span><span id="__span-26-18"><a id="__codelineno-26-18" name="__codelineno-26-18" href="#__codelineno-26-18"></a> --prompt TEXT Initial system prompt (overrides prompts.json)
3212+
</span><span id="__span-26-19"><a id="__codelineno-26-19" name="__codelineno-26-19" href="#__codelineno-26-19"></a> --no-report Skip generating HTML report
3213+
</span><span id="__span-26-20"><a id="__codelineno-26-20" name="__codelineno-26-20" href="#__codelineno-26-20"></a> --apply Auto-save the best-performing prompt
3214+
</span><span id="__span-26-21"><a id="__codelineno-26-21" name="__codelineno-26-21" href="#__codelineno-26-21"></a> --host TEXT Platform API base URL [default: http://localhost:8000]
32143215
</span></code></pre></div>
32153216
<h4 id="optimization-strategies">Optimization Strategies<a class="headerlink" href="#optimization-strategies" title="Permanent link">&para;</a></h4>
32163217
<table>

dev/getting-started/quickstart/index.html

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2683,9 +2683,9 @@ <h2 id="2-scaffold-your-first-agent">2. Scaffold Your First Agent<a class="heade
26832683
</span></code></pre></div>
26842684
<p>This creates a self-contained agent package under <code>agents/</code>:</p>
26852685
<div class="language-text highlight"><pre><span></span><code><span id="__span-7-1"><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a>agents/my_chatbot/
2686-
</span><span id="__span-7-2"><a id="__codelineno-7-2" name="__codelineno-7-2" href="#__codelineno-7-2"></a>├── __init__.py # Optional Python package init
2687-
</span><span id="__span-7-3"><a id="__codelineno-7-3" name="__codelineno-7-3" href="#__codelineno-7-3"></a>├── agent.py # REQUIRED: Contains your BaseGraphAgent subclass
2688-
</span><span id="__span-7-4"><a id="__codelineno-7-4" name="__codelineno-7-4" href="#__codelineno-7-4"></a>├── config.py # Pydantic configuration (model, temperature, etc.)
2686+
</span><span id="__span-7-2"><a id="__codelineno-7-2" name="__codelineno-7-2" href="#__codelineno-7-2"></a>├── __init__.py # AgentManifest card
2687+
</span><span id="__span-7-3"><a id="__codelineno-7-3" name="__codelineno-7-3" href="#__codelineno-7-3"></a>├── agent.py # REQUIRED: BaseGraphAgent subclass
2688+
</span><span id="__span-7-4"><a id="__codelineno-7-4" name="__codelineno-7-4" href="#__codelineno-7-4"></a>├── llm.py # Stack-aware LLM helpers
26892689
</span><span id="__span-7-5"><a id="__codelineno-7-5" name="__codelineno-7-5" href="#__codelineno-7-5"></a>├── prompts.json # Versioned system and user prompt templates
26902690
</span><span id="__span-7-6"><a id="__codelineno-7-6" name="__codelineno-7-6" href="#__codelineno-7-6"></a>├── langgraph.json # LangGraph Studio local settings
26912691
</span><span id="__span-7-7"><a id="__codelineno-7-7" name="__codelineno-7-7" href="#__codelineno-7-7"></a>├── .env.example # Environment variables blueprint
@@ -2702,7 +2702,7 @@ <h2 id="2-scaffold-your-first-agent">2. Scaffold Your First Agent<a class="heade
27022702
</thead>
27032703
<tbody>
27042704
<tr>
2705-
<td><code>basic</code></td>
2705+
<td><code>basic</code> / <code>class</code></td>
27062706
<td>Minimal class-based agent (recommended) — quick start</td>
27072707
</tr>
27082708
<tr>
@@ -2715,7 +2715,15 @@ <h2 id="2-scaffold-your-first-agent">2. Scaffold Your First Agent<a class="heade
27152715
</tr>
27162716
<tr>
27172717
<td><code>full</code></td>
2718-
<td>All features: class agent with config, schemas, api, tools, prompts</td>
2718+
<td>All features: class agent with config, schemas, train/eval</td>
2719+
</tr>
2720+
<tr>
2721+
<td><code>coordinator</code></td>
2722+
<td>Orchestrator that routes to specialists</td>
2723+
</tr>
2724+
<tr>
2725+
<td><code>pipeline</code></td>
2726+
<td>Multi-step YAML workflow</td>
27192727
</tr>
27202728
<tr>
27212729
<td><code>deepagent</code></td>
@@ -2727,11 +2735,15 @@ <h2 id="2-scaffold-your-first-agent">2. Scaffold Your First Agent<a class="heade
27272735
</tr>
27282736
<tr>
27292737
<td><code>legacy_dict</code></td>
2730-
<td>Legacy functional agent — <code>__init__.py</code> with <code>manifest</code> + <code>node_fn</code></td>
2738+
<td>Legacy functional agent — <code>manifest</code> + <code>node_fn</code></td>
27312739
</tr>
27322740
<tr>
27332741
<td><code>plugin</code></td>
2734-
<td>ML Model Plugin — wrap classical ML models with REST endpoints</td>
2742+
<td>ML Model Plugin with REST endpoints</td>
2743+
</tr>
2744+
<tr>
2745+
<td><code>endpoint</code> / <code>connection</code> / <code>ingestion</code> / <code>extraction</code></td>
2746+
<td>Ops / RAG building blocks</td>
27352747
</tr>
27362748
</tbody>
27372749
</table>

dev/guide/class-agents/index.html

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -927,10 +927,10 @@
927927
</li>
928928

929929
<li class="md-nav__item">
930-
<a href="#savepath-load_compiledpath" class="md-nav__link">
930+
<a href="#savepath-loadpath-load_compiledpath" class="md-nav__link">
931931
<span class="md-ellipsis">
932932

933-
save(path) / load_compiled(path)
933+
save(path) / load(path) / load_compiled(path)
934934

935935
</span>
936936
</a>
@@ -2763,10 +2763,10 @@
27632763
</li>
27642764

27652765
<li class="md-nav__item">
2766-
<a href="#savepath-load_compiledpath" class="md-nav__link">
2766+
<a href="#savepath-loadpath-load_compiledpath" class="md-nav__link">
27672767
<span class="md-ellipsis">
27682768

2769-
save(path) / load_compiled(path)
2769+
save(path) / load(path) / load_compiled(path)
27702770

27712771
</span>
27722772
</a>
@@ -3752,15 +3752,16 @@ <h3 id="evaluatedataset-metrics"><code>evaluate(dataset, metrics)</code><a class
37523752
</span><span id="__span-16-10"><a id="__codelineno-16-10" name="__codelineno-16-10" href="#__codelineno-16-10"></a><span class="c1"># Scores:</span>
37533753
</span><span id="__span-16-11"><a id="__codelineno-16-11" name="__codelineno-16-11" href="#__codelineno-16-11"></a><span class="c1"># exact_key_match: 0.900</span>
37543754
</span></code></pre></div>
3755-
<h3 id="savepath-load_compiledpath"><code>save(path)</code> / <code>load_compiled(path)</code><a class="headerlink" href="#savepath-load_compiledpath" title="Permanent link">&para;</a></h3>
3756-
<p>Persist and restore the compiled state:</p>
3757-
<div class="language-python highlight"><pre><span></span><code><span id="__span-17-1"><a id="__codelineno-17-1" name="__codelineno-17-1" href="#__codelineno-17-1"></a><span class="c1"># Save</span>
3758-
</span><span id="__span-17-2"><a id="__codelineno-17-2" name="__codelineno-17-2" href="#__codelineno-17-2"></a><span class="n">agent</span><span class="o">.</span><span class="n">save</span><span class="p">(</span><span class="s2">&quot;compiled/summarizer_v1&quot;</span><span class="p">)</span>
3759-
</span><span id="__span-17-3"><a id="__codelineno-17-3" name="__codelineno-17-3" href="#__codelineno-17-3"></a><span class="c1"># Creates: config.json, metadata.json, evaluation_history.json</span>
3760-
</span><span id="__span-17-4"><a id="__codelineno-17-4" name="__codelineno-17-4" href="#__codelineno-17-4"></a>
3761-
</span><span id="__span-17-5"><a id="__codelineno-17-5" name="__codelineno-17-5" href="#__codelineno-17-5"></a><span class="c1"># Load into a fresh instance</span>
3762-
</span><span id="__span-17-6"><a id="__codelineno-17-6" name="__codelineno-17-6" href="#__codelineno-17-6"></a><span class="n">fresh</span> <span class="o">=</span> <span class="n">MyAgent</span><span class="p">(</span><span class="n">llm</span><span class="o">=</span><span class="n">my_llm</span><span class="p">)</span>
3763-
</span><span id="__span-17-7"><a id="__codelineno-17-7" name="__codelineno-17-7" href="#__codelineno-17-7"></a><span class="n">fresh</span><span class="o">.</span><span class="n">load_compiled</span><span class="p">(</span><span class="s2">&quot;compiled/summarizer_v1&quot;</span><span class="p">)</span>
3755+
<h3 id="savepath-loadpath-load_compiledpath"><code>save(path)</code> / <code>load(path)</code> / <code>load_compiled(path)</code><a class="headerlink" href="#savepath-loadpath-load_compiledpath" title="Permanent link">&para;</a></h3>
3756+
<p>Persists compiled config, metadata, evaluation reports, and the Keras-style
3757+
<code>History</code> from the last <code>fit()</code> (<code>fit_history.json</code>). <code>load()</code> is an alias of
3758+
<code>load_compiled()</code>:</p>
3759+
<div class="language-python highlight"><pre><span></span><code><span id="__span-17-1"><a id="__codelineno-17-1" name="__codelineno-17-1" href="#__codelineno-17-1"></a><span class="n">agent</span><span class="o">.</span><span class="n">save</span><span class="p">(</span><span class="s2">&quot;compiled/summarizer_v1&quot;</span><span class="p">)</span>
3760+
</span><span id="__span-17-2"><a id="__codelineno-17-2" name="__codelineno-17-2" href="#__codelineno-17-2"></a><span class="c1"># Creates: config.json, metadata.json, evaluation_history.json, fit_history.json</span>
3761+
</span><span id="__span-17-3"><a id="__codelineno-17-3" name="__codelineno-17-3" href="#__codelineno-17-3"></a>
3762+
</span><span id="__span-17-4"><a id="__codelineno-17-4" name="__codelineno-17-4" href="#__codelineno-17-4"></a><span class="n">fresh</span> <span class="o">=</span> <span class="n">MyAgent</span><span class="p">(</span><span class="n">llm</span><span class="o">=</span><span class="n">my_llm</span><span class="p">)</span>
3763+
</span><span id="__span-17-5"><a id="__codelineno-17-5" name="__codelineno-17-5" href="#__codelineno-17-5"></a><span class="n">fresh</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s2">&quot;compiled/summarizer_v1&quot;</span><span class="p">)</span> <span class="c1"># or load_compiled(...)</span>
3764+
</span><span id="__span-17-6"><a id="__codelineno-17-6" name="__codelineno-17-6" href="#__codelineno-17-6"></a><span class="k">assert</span> <span class="n">fresh</span><span class="o">.</span><span class="n">history</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span>
37643765
</span></code></pre></div>
37653766
<details class="example">
37663767
<summary>Full ML Workflow</summary>

0 commit comments

Comments
 (0)