@@ -12,7 +12,7 @@ Quick links:
1212- [ CLI Reference] ( cli.md )
1313- [ DSL Reference] ( dsl.md )
1414
15- Generated from source code on: August 15, 2025 at 04:00 UTC
15+ Generated from source code on: August 15, 2025 at 11:31 UTC
1616
1717Modules auto-discovered: 72
1818
@@ -2451,22 +2451,22 @@ convenience to run both.
24512451
24522452## ngraph.workflow.analysis.capacity_matrix
24532453
2454- Capacity matrix analysis for MaxFlow results .
2454+ Capacity matrix analysis.
24552455
2456- Consumes `` flow_results `` from a MaxFlow step and builds a node->node capacity
2457- matrix using the maximum placed value observed per pair across iterations
2458- (capacity ceiling under the tested failure set). Provides statistics and a
2459- heatmap for quick visual inspection.
2456+ Consumes ` flow_results ` (from MaxFlow step). Builds node→node capacity matrix
2457+ using the * maximum placed value observed* per pair across iterations (i.e., the
2458+ capacity ceiling under the tested failure set). Provides stats and a heatmap.
24602459
24612460### CapacityMatrixAnalyzer
24622461
2463- Analyze max-flow capacities into matrices, statistics, and plots.
2462+ Analyze max-flow capacities into matrices/ statistics/ plots.
24642463
24652464** Methods:**
24662465
2467- - ` analyze(self, results: 'dict [str, Any]', **kwargs) -> 'dict [str, Any]' ` - Compute capacity matrix for a MaxFlow step .
2466+ - ` analyze(self, results: 'Dict [str, Any]', **kwargs) -> 'Dict [str, Any]' ` - Return analysis outputs for a given results document .
24682467- ` analyze_and_display(self, results: 'dict[str, Any]', **kwargs) -> 'None' ` - Analyze results and render them in notebook format.
2469- - ` display_analysis(self, analysis: 'dict[str, Any]', **kwargs) -> 'None' ` - Render capacity matrix statistics and heatmap.
2468+ - ` analyze_and_display_step(self, results: 'Dict[str, Any]', **kwargs) -> 'None' ` - Analyze and render capacity matrix for a single workflow step.
2469+ - ` display_analysis(self, analysis: 'Dict[str, Any]', **kwargs) -> 'None' ` - Render analysis outputs in notebook format.
24702470- ` get_description(self) -> 'str' ` - Return a concise description of the analyzer purpose.
24712471
24722472---
@@ -2628,8 +2628,8 @@ Includes bindings for ``NetworkStats``, ``MaximumSupportedDemand``,
26282628High-level summary analyzer for results documents.
26292629
26302630Provides quick counts of steps and basic categorisation by presence of
2631- `` flow_results `` in the new schema. Also contains convenience helpers for
2632- `` NetworkStats `` sections.
2631+ `` flow_results `` in the new schema. Also contains a small helper for
2632+ `` NetworkStats `` sections aimed at notebook usage .
26332633
26342634### SummaryAnalyzer
26352635
0 commit comments