This commit is contained in:
@@ -520,6 +520,15 @@
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#dagpipe.graph--responsibilities" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Responsibilities
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@@ -586,42 +595,6 @@
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#dagpipe.graph.Graph.add_edge--add-directed-edge-from-src-to-dst" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Add directed edge from src to dst.
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#dagpipe.graph.Graph.add_edge--parameters" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Parameters
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#dagpipe.graph.Graph.add_edge--raises" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Raises
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#dagpipe.graph.Graph.add_edge--behavior" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Behavior
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@@ -906,6 +879,15 @@
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#dagpipe.graph--responsibilities" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Responsibilities
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@@ -972,42 +954,6 @@
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#dagpipe.graph.Graph.add_edge--add-directed-edge-from-src-to-dst" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Add directed edge from src to dst.
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#dagpipe.graph.Graph.add_edge--parameters" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Parameters
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#dagpipe.graph.Graph.add_edge--raises" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Raises
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#dagpipe.graph.Graph.add_edge--behavior" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Behavior
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@@ -1106,24 +1052,19 @@
|
||||
|
||||
<div class="doc doc-contents first">
|
||||
|
||||
<p>Defines DAG structure connecting Nodes.</p>
|
||||
<h3 id="dagpipe.graph--summary">Summary</h3>
|
||||
<p>Defines DAG structure connecting nodes.</p>
|
||||
<p>A <code>Graph</code> describes execution topology only. It does not execute nodes or manage
|
||||
<code>State</code>. Execution is handled by an <code>Engine</code>.</p>
|
||||
<hr />
|
||||
<h4 id="dagpipe.graph--summary">Summary</h4>
|
||||
<p>Graph describes execution topology only. It does not execute nodes or manage State.
|
||||
Execution is handled by Engine.</p>
|
||||
<h3 id="dagpipe.graph--responsibilities">Responsibilities</h3>
|
||||
<ul>
|
||||
<li>Multiple roots, branching, and merging support.</li>
|
||||
<li>Deterministic traversal based on topology.</li>
|
||||
<li>Graph is mutable during construction but treated as immutable at runtime.</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<details class="notes" open>
|
||||
<summary>Notes</summary>
|
||||
<p><strong>Responsibilities:</strong></p>
|
||||
<div class="language-text highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
|
||||
<span class="normal">2</span>
|
||||
<span class="normal">3</span></pre></div></td><td class="code"><div><pre><span></span><code>- Multiple roots, branching, and merging support.
|
||||
- Deterministic traversal based on topology.
|
||||
- Graph is mutable during construction but treated as immutable at runtime.
|
||||
</code></pre></div></td></tr></table></div>
|
||||
</details>
|
||||
|
||||
|
||||
<div class="doc doc-children">
|
||||
|
||||
@@ -1149,7 +1090,7 @@ Execution is handled by Engine.</p>
|
||||
<div class="doc doc-contents ">
|
||||
|
||||
|
||||
<p>Directed Acyclic Graph defining execution topology of Nodes.</p>
|
||||
<p>Directed Acyclic Graph defining execution topology of <code>Node</code> objects.</p>
|
||||
|
||||
|
||||
<details class="notes" open>
|
||||
@@ -1157,7 +1098,7 @@ Execution is handled by Engine.</p>
|
||||
<p><strong>Responsibilities:</strong></p>
|
||||
<div class="language-text highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
|
||||
<span class="normal">2</span></pre></div></td><td class="code"><div><pre><span></span><code>- Stores node connectivity and validates that the topology remains acyclic.
|
||||
- Structure determines how State flows between nodes during execution.
|
||||
- Structure determines how `State` flows between nodes during execution.
|
||||
</code></pre></div></td></tr></table></div>
|
||||
<p><strong>Guarantees:</strong></p>
|
||||
<div class="language-text highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
|
||||
@@ -1215,35 +1156,94 @@ Execution is handled by Engine.</p>
|
||||
|
||||
<div class="doc doc-contents ">
|
||||
|
||||
<h6 id="dagpipe.graph.Graph.add_edge--add-directed-edge-from-src-to-dst">Add directed edge from src to dst.</h6>
|
||||
<h6 id="dagpipe.graph.Graph.add_edge--parameters">Parameters</h6>
|
||||
<p>src : Node
|
||||
required: True
|
||||
source node</p>
|
||||
<p>Add a directed edge from <code>src</code> to <code>dst</code>.</p>
|
||||
|
||||
|
||||
<details class="dst-" open>
|
||||
<summary>Node</summary>
|
||||
<p>required: True
|
||||
destination node</p>
|
||||
</details> <hr />
|
||||
<h6 id="dagpipe.graph.Graph.add_edge--raises">Raises</h6>
|
||||
<p>TypeError
|
||||
if src or dst is not a Node</p>
|
||||
<p>ValueError
|
||||
if edge would create a cycle</p>
|
||||
<p>ValueError
|
||||
if src and dst are the same node</p>
|
||||
<hr />
|
||||
<h6 id="dagpipe.graph.Graph.add_edge--behavior">Behavior</h6>
|
||||
<ul>
|
||||
<li>validates node types</li>
|
||||
<li>prevents cycles</li>
|
||||
<li>registers nodes if not present</li>
|
||||
<li>updates parent and child mappings</li>
|
||||
<p><span class="doc-section-title">Parameters:</span></p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Default</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="doc-section-item">
|
||||
<td><code>src</code></td>
|
||||
<td>
|
||||
<code><a class="autorefs autorefs-internal" title="dagpipe.node.Node" href="../node/#dagpipe.node.Node">Node</a></code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>Source node.</p>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
<em>required</em>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="doc-section-item">
|
||||
<td><code>dst</code></td>
|
||||
<td>
|
||||
<code><a class="autorefs autorefs-internal" title="dagpipe.node.Node" href="../node/#dagpipe.node.Node">Node</a></code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>Destination node.</p>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
<em>required</em>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
||||
<p><span class="doc-section-title">Raises:</span></p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="doc-section-item">
|
||||
<td>
|
||||
<code>TypeError</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>If <code>src</code> or <code>dst</code> is not a <code>Node</code>.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="doc-section-item">
|
||||
<td>
|
||||
<code>ValueError</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>If the edge would create a cycle or if <code>src</code> and <code>dst</code> are common.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
||||
<details class="notes" open>
|
||||
<summary>Notes</summary>
|
||||
<ul>
|
||||
<li>Validates node types.</li>
|
||||
<li>Prevents cycles.</li>
|
||||
<li>Registers nodes if not present.</li>
|
||||
<li>Updates parent and child mappings.</li>
|
||||
</ul>
|
||||
<hr />
|
||||
|
||||
</details>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
@@ -1278,7 +1278,7 @@ destination node</p>
|
||||
<tr class="doc-section-item">
|
||||
<td><code>node</code></td>
|
||||
<td>
|
||||
<code><a class="autorefs autorefs-internal" title="dagpipe.node.Node" href="../dagpipe/node/#dagpipe.node.Node">Node</a></code>
|
||||
<code><a class="autorefs autorefs-internal" title="dagpipe.node.Node" href="../node/#dagpipe.node.Node">Node</a></code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
@@ -1349,7 +1349,7 @@ destination node</p>
|
||||
<tr class="doc-section-item">
|
||||
<td><code>node</code></td>
|
||||
<td>
|
||||
<code><a class="autorefs autorefs-internal" title="dagpipe.node.Node" href="../dagpipe/node/#dagpipe.node.Node">Node</a></code>
|
||||
<code><a class="autorefs autorefs-internal" title="dagpipe.node.Node" href="../node/#dagpipe.node.Node">Node</a></code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
@@ -1375,7 +1375,7 @@ destination node</p>
|
||||
<tbody>
|
||||
<tr class="doc-section-item">
|
||||
<td>
|
||||
<code><span title="typing.Tuple">Tuple</span>[<a class="autorefs autorefs-internal" title="dagpipe.node.Node" href="../dagpipe/node/#dagpipe.node.Node">Node</a>, ...]</code>
|
||||
<code><span title="typing.Tuple">Tuple</span>[<a class="autorefs autorefs-internal" title="dagpipe.node.Node" href="../node/#dagpipe.node.Node">Node</a>, ...]</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
@@ -1418,7 +1418,7 @@ Outgoing neighbors.</p>
|
||||
<tbody>
|
||||
<tr class="doc-section-item">
|
||||
<td>
|
||||
<code><span title="typing.Tuple">Tuple</span>[<a class="autorefs autorefs-internal" title="dagpipe.node.Node" href="../dagpipe/node/#dagpipe.node.Node">Node</a>, ...]</code>
|
||||
<code><span title="typing.Tuple">Tuple</span>[<a class="autorefs autorefs-internal" title="dagpipe.node.Node" href="../node/#dagpipe.node.Node">Node</a>, ...]</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
@@ -1464,7 +1464,7 @@ All registered nodes.</p>
|
||||
<tr class="doc-section-item">
|
||||
<td><code>node</code></td>
|
||||
<td>
|
||||
<code><a class="autorefs autorefs-internal" title="dagpipe.node.Node" href="../dagpipe/node/#dagpipe.node.Node">Node</a></code>
|
||||
<code><a class="autorefs autorefs-internal" title="dagpipe.node.Node" href="../node/#dagpipe.node.Node">Node</a></code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
@@ -1490,7 +1490,7 @@ All registered nodes.</p>
|
||||
<tbody>
|
||||
<tr class="doc-section-item">
|
||||
<td>
|
||||
<code><span title="typing.Tuple">Tuple</span>[<a class="autorefs autorefs-internal" title="dagpipe.node.Node" href="../dagpipe/node/#dagpipe.node.Node">Node</a>, ...]</code>
|
||||
<code><span title="typing.Tuple">Tuple</span>[<a class="autorefs autorefs-internal" title="dagpipe.node.Node" href="../node/#dagpipe.node.Node">Node</a>, ...]</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
@@ -1533,7 +1533,7 @@ Incoming neighbors.</p>
|
||||
<tbody>
|
||||
<tr class="doc-section-item">
|
||||
<td>
|
||||
<code><span title="typing.Tuple">Tuple</span>[<a class="autorefs autorefs-internal" title="dagpipe.node.Node" href="../dagpipe/node/#dagpipe.node.Node">Node</a>, ...]</code>
|
||||
<code><span title="typing.Tuple">Tuple</span>[<a class="autorefs autorefs-internal" title="dagpipe.node.Node" href="../node/#dagpipe.node.Node">Node</a>, ...]</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
|
||||
Reference in New Issue
Block a user