Remove if not specified parts from ref doc

Author: FlorentinD

graphdatascience/procedure_surface/api/articulationpoints_endpoints.py

@@ -205,13 +205,10 @@ def estimate(
             The graph to be used in the estimation. Provided either as a Graph object or a configuration dictionary for the projection.
         relationship_types : Optional[List[str]], default=None
             The relationship types used to select relationships for this algorithm run.
-            If not specified, all relationship types are considered.
         node_labels : Optional[List[str]], default=None
             The node labels used to select nodes for this algorithm run.
-            If not specified, all node labels are considered.
         concurrency : Optional[Any], default=None
             The number of concurrent threads used for the estimation.
-            If not specified, uses the default concurrency level.
 
         Returns
         -------

graphdatascience/procedure_surface/api/betweenness_endpoints.py

@@ -42,7 +42,7 @@ def mutate(
         mutate_property : str
             The property name to store the betweenness centrality score for each node
         sampling_size : Optional[int], default=None
-            The number of nodes to use for sampling. If not specified, all nodes are used
+            The number of nodes to use for sampling.
         sampling_seed : Optional[int], default=None
             The seed value for sampling randomization
         relationship_types : Optional[List[str]], default=None
@@ -91,7 +91,7 @@ def stats(
         G : Graph
             The graph to run the algorithm on
         sampling_size : Optional[int], default=None
-            The number of nodes to use for sampling. If not specified, all nodes are used
+            The number of nodes to use for sampling.
         sampling_seed : Optional[int], default=None
             The seed value for sampling randomization
         relationship_types : Optional[List[str]], default=None
@@ -140,7 +140,7 @@ def stream(
         G : Graph
             The graph to run the algorithm on
         sampling_size : Optional[int], default=None
-            The number of nodes to use for sampling. If not specified, all nodes are used
+            The number of nodes to use for sampling.
         sampling_seed : Optional[int], default=None
             The seed value for sampling randomization
         relationship_types : Optional[List[str]], default=None
@@ -193,7 +193,7 @@ def write(
         write_property : str
             The property name to store the betweenness centrality score for each node
         sampling_size : Optional[int], default=None
-            The number of nodes to use for sampling. If not specified, all nodes are used
+            The number of nodes to use for sampling.
         sampling_seed : Optional[int], default=None
             The seed value for sampling randomization
         relationship_types : Optional[List[str]], default=None

graphdatascience/procedure_surface/api/celf_endpoints.py

@@ -51,13 +51,11 @@ def mutate(
         monte_carlo_simulations : Optional[int], default=None
             The number of Monte-Carlo simulations.
         random_seed : Optional[Any], default=None
-            Random seed for reproducible results. If not specified, uses a random seed.
+            Random seed for reproducible results.
         relationship_types : Optional[List[str]], default=None
             The relationship types used to select relationships for this algorithm run.
-            If not specified, all relationship types are considered.
         node_labels : Optional[List[str]], default=None
             The node labels used to select nodes for this algorithm run.
-            If not specified, all node labels are considered.
         sudo : Optional[bool], default=None
             Override memory estimation limits. Use with caution as this can lead to
             memory issues if the estimation is significantly wrong.
@@ -67,7 +65,6 @@ def mutate(
             The username to attribute the procedure run to
         concurrency : Optional[Any], default=None
             The number of concurrent threads used for the algorithm execution.
-            If not specified, uses the default concurrency level.
         job_id : Optional[Any], default=None
             An identifier for the job that can be used for monitoring and cancellation
 
@@ -108,13 +105,11 @@ def stats(
         monte_carlo_simulations : Optional[int], default=None
             The number of Monte-Carlo simulations.
         random_seed : Optional[Any], default=None
-            Random seed for reproducible results. If not specified, uses a random seed.
+            Random seed for reproducible results.
         relationship_types : Optional[List[str]], default=None
             The relationship types used to select relationships for this algorithm run.
-            If not specified, all relationship types are considered.
         node_labels : Optional[List[str]], default=None
             The node labels used to select nodes for this algorithm run.
-            If not specified, all node labels are considered.
         sudo : Optional[bool], default=None
             Override memory estimation limits. Use with caution as this can lead to
             memory issues if the estimation is significantly wrong.
@@ -124,7 +119,6 @@ def stats(
             The username to attribute the procedure run to
         concurrency : Optional[Any], default=None
             The number of concurrent threads used for the algorithm execution.
-            If not specified, uses the default concurrency level.
         job_id : Optional[Any], default=None
             An identifier for the job that can be used for monitoring and cancellation
 
@@ -165,13 +159,11 @@ def stream(
         monte_carlo_simulations : Optional[int], default=None
             The number of Monte-Carlo simulations.
         random_seed : Optional[Any], default=None
-            Random seed for reproducible results. If not specified, uses a random seed.
+            Random seed for reproducible results.
         relationship_types : Optional[List[str]], default=None
             The relationship types used to select relationships for this algorithm run.
-            If not specified, all relationship types are considered.
         node_labels : Optional[List[str]], default=None
             The node labels used to select nodes for this algorithm run.
-            If not specified, all node labels are considered.
         sudo : Optional[bool], default=None
             Override memory estimation limits. Use with caution as this can lead to
             memory issues if the estimation is significantly wrong.
@@ -181,7 +173,6 @@ def stream(
             The username to attribute the procedure run to
         concurrency : Optional[Any], default=None
             The number of concurrent threads used for the algorithm execution.
-            If not specified, uses the default concurrency level.
         job_id : Optional[Any], default=None
             An identifier for the job that can be used for monitoring and cancellation
 
@@ -227,13 +218,11 @@ def write(
         monte_carlo_simulations : Optional[int], default=None
             The number of Monte-Carlo simulations.
         random_seed : Optional[Any], default=None
-            Random seed for reproducible results. If not specified, uses a random seed.
+            Random seed for reproducible results.
         relationship_types : Optional[List[str]], default=None
             The relationship types used to select relationships for this algorithm run.
-            If not specified, all relationship types are considered.
         node_labels : Optional[List[str]], default=None
             The node labels used to select nodes for this algorithm run.
-            If not specified, all node labels are considered.
         sudo : Optional[bool], default=None
             Override memory estimation limits. Use with caution as this can lead to
             memory issues if the estimation is significantly wrong.
@@ -243,12 +232,10 @@ def write(
             The username to attribute the procedure run to
         concurrency : Optional[Any], default=None
             The number of concurrent threads used for the algorithm execution.
-            If not specified, uses the default concurrency level.
         job_id : Optional[Any], default=None
             An identifier for the job that can be used for monitoring and cancellation
         write_concurrency : Optional[Any], default=None
             The number of concurrent threads used during the write phase.
-            If not specified, uses the same value as concurrency.
 
         Returns
         -------
@@ -287,16 +274,13 @@ def estimate(
         monte_carlo_simulations : Optional[int], default=None
             The number of Monte-Carlo simulations.
         random_seed : Optional[Any], default=None
-            Random seed for reproducible results. If not specified, uses a random seed.
+            Random seed for reproducible results.
         relationship_types : Optional[List[str]], default=None
             The relationship types used to select relationships for this algorithm run.
-            If not specified, all relationship types are considered.
         node_labels : Optional[List[str]], default=None
             The node labels used to select nodes for this algorithm run.
-            If not specified, all node labels are considered.
         concurrency : Optional[Any], default=None
             The number of concurrent threads used for the estimation.
-            If not specified, uses the default concurrency level.
 
         Returns
         -------

graphdatascience/procedure_surface/api/closeness_endpoints.py

@@ -46,10 +46,8 @@ def mutate(
             Use the improved Wasserman-Faust formula for closeness computation.
         relationship_types : Optional[List[str]], default=None
             The relationship types used to select relationships for this algorithm run.
-            If not specified, all relationship types are considered.
         node_labels : Optional[List[str]], default=None
             The node labels used to select nodes for this algorithm run.
-            If not specified, all node labels are considered.
         sudo : Optional[bool], default=None
             Override memory estimation limits. Use with caution as this can lead to
             memory issues if the estimation is significantly wrong.
@@ -59,7 +57,6 @@ def mutate(
             The username to attribute the procedure run to
         concurrency : Optional[Any], default=None
             The number of concurrent threads used for the algorithm execution.
-            If not specified, uses the default concurrency level.
         job_id : Optional[Any], default=None
             An identifier for the job that can be used for monitoring and cancellation
 
@@ -94,10 +91,8 @@ def stats(
             Use the improved Wasserman-Faust formula for closeness computation.
         relationship_types : Optional[List[str]], default=None
             The relationship types used to select relationships for this algorithm run.
-            If not specified, all relationship types are considered.
         node_labels : Optional[List[str]], default=None
             The node labels used to select nodes for this algorithm run.
-            If not specified, all node labels are considered.
         sudo : Optional[bool], default=None
             Override memory estimation limits. Use with caution as this can lead to
             memory issues if the estimation is significantly wrong.
@@ -107,7 +102,6 @@ def stats(
             The username to attribute the procedure run to
         concurrency : Optional[Any], default=None
             The number of concurrent threads used for the algorithm execution.
-            If not specified, uses the default concurrency level.
         job_id : Optional[Any], default=None
             An identifier for the job that can be used for monitoring and cancellation
 
@@ -142,10 +136,8 @@ def stream(
             Use the improved Wasserman-Faust formula for closeness computation.
         relationship_types : Optional[List[str]], default=None
             The relationship types used to select relationships for this algorithm run.
-            If not specified, all relationship types are considered.
         node_labels : Optional[List[str]], default=None
             The node labels used to select nodes for this algorithm run.
-            If not specified, all node labels are considered.
         sudo : Optional[bool], default=None
             Override memory estimation limits. Use with caution as this can lead to
             memory issues if the estimation is significantly wrong.
@@ -155,7 +147,6 @@ def stream(
             The username to attribute the procedure run to
         concurrency : Optional[Any], default=None
             The number of concurrent threads used for the algorithm execution.
-            If not specified, uses the default concurrency level.
         job_id : Optional[Any], default=None
             An identifier for the job that can be used for monitoring and cancellation
 
@@ -195,10 +186,8 @@ def write(
             Use the improved Wasserman-Faust formula for closeness computation.
         relationship_types : Optional[List[str]], default=None
             The relationship types used to select relationships for this algorithm run.
-            If not specified, all relationship types are considered.
         node_labels : Optional[List[str]], default=None
             The node labels used to select nodes for this algorithm run.
-            If not specified, all node labels are considered.
         sudo : Optional[bool], default=None
             Override memory estimation limits. Use with caution as this can lead to
             memory issues if the estimation is significantly wrong.
@@ -208,12 +197,10 @@ def write(
             The username to attribute the procedure run to
         concurrency : Optional[Any], default=None
             The number of concurrent threads used for the algorithm execution.
-            If not specified, uses the default concurrency level.
         job_id : Optional[Any], default=None
             An identifier for the job that can be used for monitoring and cancellation
         write_concurrency : Optional[Any], default=None
             The number of concurrent threads used during the write phase.
-            If not specified, uses the default write concurrency level.
 
         Returns
         -------

graphdatascience/procedure_surface/api/closeness_harmonic_endpoints.py

@@ -43,10 +43,8 @@ def mutate(
             The property name to store the harmonic closeness centrality score for each node
         relationship_types : Optional[List[str]], default=None
             The relationship types used to select relationships for this algorithm run.
-            If not specified, all relationship types are considered.
         node_labels : Optional[List[str]], default=None
             The node labels used to select nodes for this algorithm run.
-            If not specified, all node labels are considered.
         sudo : Optional[bool], default=None
             Override memory estimation limits. Use with caution as this can lead to
             memory issues if the estimation is significantly wrong.
@@ -56,7 +54,6 @@ def mutate(
             The username to attribute the procedure run to
         concurrency : Optional[Any], default=None
             The number of concurrent threads used for the algorithm execution.
-            If not specified, uses the default concurrency level.
         job_id : Optional[Any], default=None
             An identifier for the job that can be used for monitoring and cancellation
 
@@ -88,10 +85,8 @@ def stats(
             The graph to run the algorithm on
         relationship_types : Optional[List[str]], default=None
             The relationship types used to select relationships for this algorithm run.
-            If not specified, all relationship types are considered.
         node_labels : Optional[List[str]], default=None
             The node labels used to select nodes for this algorithm run.
-            If not specified, all node labels are considered.
         sudo : Optional[bool], default=None
             Override memory estimation limits. Use with caution as this can lead to
             memory issues if the estimation is significantly wrong.
@@ -101,7 +96,6 @@ def stats(
             The username to attribute the procedure run to
         concurrency : Optional[Any], default=None
             The number of concurrent threads used for the algorithm execution.
-            If not specified, uses the default concurrency level.
         job_id : Optional[Any], default=None
             An identifier for the job that can be used for monitoring and cancellation
 
@@ -133,10 +127,8 @@ def stream(
             The graph to run the algorithm on
         relationship_types : Optional[List[str]], default=None
             The relationship types used to select relationships for this algorithm run.
-            If not specified, all relationship types are considered.
         node_labels : Optional[List[str]], default=None
             The node labels used to select nodes for this algorithm run.
-            If not specified, all node labels are considered.
         sudo : Optional[bool], default=None
             Override memory estimation limits. Use with caution as this can lead to
             memory issues if the estimation is significantly wrong.
@@ -146,7 +138,6 @@ def stream(
             The username to attribute the procedure run to
         concurrency : Optional[Any], default=None
             The number of concurrent threads used for the algorithm execution.
-            If not specified, uses the default concurrency level.
         job_id : Optional[Any], default=None
             An identifier for the job that can be used for monitoring and cancellation
 
@@ -182,10 +173,8 @@ def write(
             The property name to write the harmonic closeness centrality scores to
         relationship_types : Optional[List[str]], default=None
             The relationship types used to select relationships for this algorithm run.
-            If not specified, all relationship types are considered.
         node_labels : Optional[List[str]], default=None
             The node labels used to select nodes for this algorithm run.
-            If not specified, all node labels are considered.
         sudo : Optional[bool], default=None
             Override memory estimation limits. Use with caution as this can lead to
             memory issues if the estimation is significantly wrong.
@@ -195,7 +184,6 @@ def write(
             The username to attribute the procedure run to
         concurrency : Optional[Any], default=None
             The number of concurrent threads used for the algorithm execution.
-            If not specified, uses the default concurrency level.
         job_id : Optional[Any], default=None
             An identifier for the job that can be used for monitoring and cancellation
         write_concurrency : Optional[Any], default=None