normalised expansion modes to "combine" and "pairwise"

Author: networmix

docs/reference/api-full.md

@@ -12,7 +12,7 @@ Quick links:
 - [CLI Reference](cli.md)
 - [DSL Reference](dsl.md)
 
-Generated from source code on: August 09, 2025 at 03:28 UTC
+Generated from source code on: August 09, 2025 at 04:04 UTC
 
 Modules auto-discovered: 59
 
@@ -1688,11 +1688,11 @@ per-demand `FlowPolicy` instances.
 
 Manage expansion and placement of traffic demands on a `Network`.
 
-This class:
+ This class:
 
   1) Builds (or rebuilds) a StrictMultiDiGraph from the given Network.
-  2) Expands each TrafficDemand into one or more Demand objects based
-     on a configurable 'mode' (e.g., 'combine' or 'full_mesh').
+   2) Expands each TrafficDemand into one or more Demand objects based
+      on a configurable 'mode' ("combine" or "pairwise").
   3) Each Demand is associated with a FlowPolicy, which handles how flows
      are placed (split across paths, balancing, etc.).
   4) Provides methods to place all demands incrementally with optional
@@ -1707,7 +1707,7 @@ In particular:
       demand's `source_path` and `sink_path`). A single Demand is created
       from the pseudo-source to the pseudo-sink, with the full volume.
 
-- 'full_mesh' mode:
+- 'pairwise' mode:
 - All matched sources form one group, all matched sinks form another group.
 
       A separate Demand is created for each (src_node, dst_node) pair,
@@ -1788,7 +1788,7 @@ Attributes:
         ``flow_policy`` is not provided.
     flow_policy: Concrete policy instance. If set, it overrides
         ``flow_policy_config``.
-    mode: Expansion mode, e.g. ``"combine"`` or ``"full_mesh"``.
+    mode: Expansion mode, ``"combine"`` or ``"pairwise"``.
     attrs: Arbitrary user metadata.
     id: Unique identifier assigned at initialization.
 
@@ -2362,7 +2362,7 @@ YAML Configuration Example:
         name: "capacity_envelope_monte_carlo"  # Optional: Custom name for this step
         source_path: "^datacenter/.*"          # Regex pattern for source node groups
         sink_path: "^edge/.*"                  # Regex pattern for sink node groups
-        mode: "combine"                        # "combine" or "pairwise" flow analysis
+         mode: "combine"                        # "combine" or "pairwise" flow analysis
         failure_policy: "random_failures"      # Optional: Named failure policy to use
         iterations: 1000                       # Number of Monte-Carlo trials
         parallelism: 4                         # Number of parallel worker processes

docs/reference/dsl.md

@@ -355,14 +355,14 @@ traffic_matrix_set:
       source_path: "^dc1/.*"
       sink_path: "^dc2/.*"
       demand: 500
-      mode: "full_mesh"          # Distributed demand
+      mode: "pairwise"           # Distributed demand
       priority: 2
 ```
 
 **Traffic Modes:**
 
 - `combine`: Single aggregate flow between source and sink groups
-- `full_mesh`: Individual flows between all source-sink node pairs
+- `pairwise`: Individual flows between all source-sink node pairs
 
 **Flow Policies:**
 

ngraph/demand/manager/manager.py

@@ -58,11 +58,11 @@ class TrafficResult(NamedTuple):
 class TrafficManager:
     """Manage expansion and placement of traffic demands on a `Network`.
 
-    This class:
+     This class:
 
       1) Builds (or rebuilds) a StrictMultiDiGraph from the given Network.
-      2) Expands each TrafficDemand into one or more Demand objects based
-         on a configurable 'mode' (e.g., 'combine' or 'full_mesh').
+       2) Expands each TrafficDemand into one or more Demand objects based
+          on a configurable 'mode' ("combine" or "pairwise").
       3) Each Demand is associated with a FlowPolicy, which handles how flows
          are placed (split across paths, balancing, etc.).
       4) Provides methods to place all demands incrementally with optional
@@ -75,7 +75,7 @@ class TrafficManager:
           demand's `source_path` and `sink_path`). A single Demand is created
           from the pseudo-source to the pseudo-sink, with the full volume.
 
-      - 'full_mesh' mode:
+       - 'pairwise' mode:
         * All matched sources form one group, all matched sinks form another group.
           A separate Demand is created for each (src_node, dst_node) pair,
           skipping self-pairs. The total volume is split evenly across the pairs.
@@ -156,9 +156,9 @@ def expand_demands(self) -> None:
                 self._expand_combine(demands_of_td, td, src_groups, snk_groups)
                 expanded.extend(demands_of_td)
                 self._td_to_demands[td.id] = demands_of_td
-            elif td.mode == "full_mesh":
+            elif td.mode == "pairwise":
                 demands_of_td: List[Demand] = []
-                self._expand_full_mesh(demands_of_td, td, src_groups, snk_groups)
+                self._expand_pairwise(demands_of_td, td, src_groups, snk_groups)
                 expanded.extend(demands_of_td)
                 self._td_to_demands[td.id] = demands_of_td
             else:
@@ -450,14 +450,14 @@ def _expand_combine(
             )
         )
 
-    def _expand_full_mesh(
+    def _expand_pairwise(
         self,
         expanded: List[Demand],
         td: TrafficDemand,
         src_groups: Dict[str, List[Node]],
         snk_groups: Dict[str, List[Node]],
     ) -> None:
-        """Expand a single demand using the ``full_mesh`` mode.
+        """Expand a single demand using the ``pairwise`` mode.
 
         Creates one `Demand` for each valid source-destination pair (excluding
         self-pairs) and splits total volume evenly across pairs.

ngraph/demand/spec.py

@@ -26,7 +26,7 @@ class TrafficDemand:
             ``flow_policy`` is not provided.
         flow_policy: Concrete policy instance. If set, it overrides
             ``flow_policy_config``.
-        mode: Expansion mode, e.g. ``"combine"`` or ``"full_mesh"``.
+        mode: Expansion mode, ``"combine"`` or ``"pairwise"``.
         attrs: Arbitrary user metadata.
         id: Unique identifier assigned at initialization.
     """

ngraph/failure/manager/manager.py

@@ -1289,7 +1289,7 @@ def run_demand_placement_monte_carlo(
                     "source_path": demand.source_path,
                     "sink_path": demand.sink_path,
                     "demand": demand.demand,
-                    "mode": getattr(demand, "mode", "full_mesh"),
+                    "mode": getattr(demand, "mode", "pairwise"),
                     "flow_policy_config": getattr(demand, "flow_policy_config", None),
                     "priority": getattr(demand, "priority", 0),
                 }

ngraph/monte_carlo/functions.py

@@ -107,7 +107,7 @@ def demand_placement_analysis(
             source_path=config["source_path"],
             sink_path=config["sink_path"],
             demand=config["demand"],
-            mode=config.get("mode", "full_mesh"),
+            mode=config.get("mode", "pairwise"),
             flow_policy_config=config.get("flow_policy_config"),
             priority=config.get("priority", 0),
         )

ngraph/workflow/capacity_envelope_analysis.py

@@ -15,7 +15,7 @@
         name: "capacity_envelope_monte_carlo"  # Optional: Custom name for this step
         source_path: "^datacenter/.*"          # Regex pattern for source node groups
         sink_path: "^edge/.*"                  # Regex pattern for sink node groups
-        mode: "combine"                        # "combine" or "pairwise" flow analysis
+         mode: "combine"                        # "combine" or "pairwise" flow analysis
         failure_policy: "random_failures"      # Optional: Named failure policy to use
         iterations: 1000                       # Number of Monte-Carlo trials
         parallelism: 4                         # Number of parallel worker processes

tests/demand/test_spec.py

@@ -43,7 +43,7 @@ def test_custom_assignment_including_policy_config() -> None:
         demand=42.5,
         demand_placed=10.0,
         attrs={"description": "test"},
-        mode="full_mesh",
+        mode="pairwise",
         flow_policy_config=FlowPolicyConfig.SHORTEST_PATHS_ECMP,
     )
 
@@ -53,5 +53,5 @@ def test_custom_assignment_including_policy_config() -> None:
     assert demand.demand == 42.5
     assert demand.demand_placed == 10.0
     assert demand.attrs == {"description": "test"}
-    assert demand.mode == "full_mesh"
+    assert demand.mode == "pairwise"
     assert demand.flow_policy_config == FlowPolicyConfig.SHORTEST_PATHS_ECMP

tests/integration/scenario_4.yaml

@@ -251,7 +251,7 @@ traffic_matrix_set:
     - source_path: "dc1_pod[ab]_rack.*/servers/.*"
       sink_path: "dc1_pod[ab]_rack.*/servers/.*"
       demand: 5.0 # 5 Gb/s east-west traffic
-      mode: "full_mesh"
+      mode: "pairwise"
       attrs:
         traffic_type: "east_west"
 
@@ -268,7 +268,7 @@ traffic_matrix_set:
     - source_path: "dc1_poda_rack1/servers/srv-[1-4]"
       sink_path: "dc1_poda_rack1/servers/srv-[1-4]"
       demand: 20.0 # 20 Gb/s HPC collective communication
-      mode: "full_mesh"
+      mode: "pairwise"
       attrs:
         traffic_type: "hpc_collective"
 

tests/integration/test_scenario_4.py

@@ -313,7 +313,7 @@ def test_traffic_matrix_configuration(self, helper):
         for demand in default_matrix:
             assert hasattr(demand, "attrs")
             if demand.attrs.get("traffic_type") == "east_west":
-                assert demand.mode == "full_mesh"
+                assert demand.mode == "pairwise"
             elif demand.attrs.get("traffic_type") == "inter_dc":
                 assert demand.mode == "combine"