From fece990995e9b6f0049d78483a9d39dd42e4d175 Mon Sep 17 00:00:00 2001 From: Andrey Golovanov Date: Wed, 6 Aug 2025 16:19:32 +0100 Subject: [PATCH] preparing v0.8.0 --- docs/getting-started/installation.md | 2 +- docs/reference/api-full.md | 12 ++++++------ ngraph/blueprints.py | 2 +- ngraph/lib/flow_policy.py | 4 ++-- ngraph/monte_carlo/results.py | 4 ++-- ngraph/traffic_demand.py | 2 +- ngraph/workflow/network_stats.py | 2 +- 7 files changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/getting-started/installation.md b/docs/getting-started/installation.md index fdab98f..4b94d99 100644 --- a/docs/getting-started/installation.md +++ b/docs/getting-started/installation.md @@ -52,7 +52,7 @@ To exit the JupyterLab server, press `Ctrl+C` in the terminal where the server i **Prerequisites:** -- Python 3.9 or higher installed on your machine. +- Python 3.11 or higher installed on your machine. !!! note diff --git a/docs/reference/api-full.md b/docs/reference/api-full.md index 44174b1..40f2bfd 100644 --- a/docs/reference/api-full.md +++ b/docs/reference/api-full.md @@ -10,7 +10,7 @@ For a curated, example-driven API guide, see **[api.md](api.md)**. > - **[CLI Reference](cli.md)** - Command-line interface > - **[DSL Reference](dsl.md)** - YAML syntax guide -**Generated from source code on:** July 29, 2025 at 17:52 UTC +**Generated from source code on:** August 06, 2025 at 16:18 UTC **Modules auto-discovered:** 53 @@ -88,7 +88,7 @@ Args: optional "blueprints" + "network". Returns: - Network: The fully expanded Network object with all nodes and links. + Network: The expanded Network object with all nodes and links. --- @@ -1198,7 +1198,7 @@ Attributes: demand (float): The total demand volume (default=0.0). demand_placed (float): The portion of this demand that has been placed so far. flow_policy_config (Optional[FlowPolicyConfig]): The routing/placement policy config. - flow_policy (Optional[FlowPolicy]): A fully constructed FlowPolicy instance. + flow_policy (Optional[FlowPolicy]): A constructed FlowPolicy instance. If provided, it overrides flow_policy_config. mode (str): Expansion mode for generating sub-demands. attrs (Dict[str, Any]): Additional arbitrary attributes. @@ -2452,7 +2452,7 @@ Attributes: Workflow step for basic node and link statistics. -Computes and stores comprehensive network statistics including node/link counts, +Computes and stores network statistics including node/link counts, capacity distributions, cost distributions, and degree distributions. Supports optional exclusion simulation and disabled entity handling. @@ -2745,7 +2745,7 @@ Attributes: **Methods:** - `export_summary(self) -> 'Dict[str, Any]'` - - Export comprehensive summary for serialization. + - Export summary for serialization. - `flow_keys(self) -> 'List[str]'` - Get list of all flow keys in results. - `get_envelope(self, flow_key: 'str') -> 'CapacityEnvelope'` @@ -2815,7 +2815,7 @@ Attributes: - `component_impact_distribution(self) -> 'pd.DataFrame'` - Get component impact distribution as DataFrame. - `export_summary(self) -> 'Dict[str, Any]'` - - Export comprehensive summary for serialization. + - Export summary for serialization. - `flow_keys(self) -> 'List[str]'` - Get list of all flow keys in results. - `get_failure_pattern_summary(self) -> 'pd.DataFrame'` diff --git a/ngraph/blueprints.py b/ngraph/blueprints.py index 25766ce..3552e86 100644 --- a/ngraph/blueprints.py +++ b/ngraph/blueprints.py @@ -78,7 +78,7 @@ def expand_network_dsl(data: Dict[str, Any]) -> Network: optional "blueprints" + "network". Returns: - Network: The fully expanded Network object with all nodes and links. + Network: The expanded Network object with all nodes and links. """ # 1) Parse blueprint definitions blueprint_map: Dict[str, Blueprint] = {} diff --git a/ngraph/lib/flow_policy.py b/ngraph/lib/flow_policy.py index 2e2d841..fe9d89c 100644 --- a/ngraph/lib/flow_policy.py +++ b/ngraph/lib/flow_policy.py @@ -351,7 +351,7 @@ def _reoptimize_flow( Args: flow_graph: The network graph. - flow_index: The key identifying the flow to re-optimize. + flow_index: The key identifying the flow to update. headroom: Additional volume to accommodate on the new path. Returns: @@ -453,7 +453,7 @@ def place_demand( f"Maximum iteration limit ({self.max_total_iterations}) exceeded in place_demand." ) - # If the flow can accept more volume, attempt to create or re-optimize. + # If the flow can accept more volume, attempt to create or update. if ( target_flow_volume - flow.placed_flow >= base.MIN_FLOW and not self.static_paths diff --git a/ngraph/monte_carlo/results.py b/ngraph/monte_carlo/results.py index f3304a2..e3365d5 100644 --- a/ngraph/monte_carlo/results.py +++ b/ngraph/monte_carlo/results.py @@ -126,7 +126,7 @@ def get_failure_pattern_summary(self) -> pd.DataFrame: return pd.DataFrame(data) def export_summary(self) -> Dict[str, Any]: - """Export comprehensive summary for serialization. + """Export summary for serialization. Returns: Dictionary with all results data in serializable format @@ -364,7 +364,7 @@ def get_failure_pattern_summary(self) -> pd.DataFrame: return pd.DataFrame(data) def export_summary(self) -> Dict[str, Any]: - """Export comprehensive summary for serialization. + """Export summary for serialization. Returns: Dictionary with all results data in serializable format diff --git a/ngraph/traffic_demand.py b/ngraph/traffic_demand.py index f753d4d..f651999 100644 --- a/ngraph/traffic_demand.py +++ b/ngraph/traffic_demand.py @@ -18,7 +18,7 @@ class TrafficDemand: demand (float): The total demand volume (default=0.0). demand_placed (float): The portion of this demand that has been placed so far. flow_policy_config (Optional[FlowPolicyConfig]): The routing/placement policy config. - flow_policy (Optional[FlowPolicy]): A fully constructed FlowPolicy instance. + flow_policy (Optional[FlowPolicy]): A constructed FlowPolicy instance. If provided, it overrides flow_policy_config. mode (str): Expansion mode for generating sub-demands. attrs (Dict[str, Any]): Additional arbitrary attributes. diff --git a/ngraph/workflow/network_stats.py b/ngraph/workflow/network_stats.py index 994791a..1009381 100644 --- a/ngraph/workflow/network_stats.py +++ b/ngraph/workflow/network_stats.py @@ -1,6 +1,6 @@ """Workflow step for basic node and link statistics. -Computes and stores comprehensive network statistics including node/link counts, +Computes and stores network statistics including node/link counts, capacity distributions, cost distributions, and degree distributions. Supports optional exclusion simulation and disabled entity handling.