Improve doc strings for node similarity

Author: FlorentinD

graphdatascience/procedure_surface/api/similarity/node_similarity_endpoints.py

@@ -73,7 +73,7 @@ def mutate(
         similarity_metric : str, default="JACCARD"
             The similarity metric to use for computation.
         use_components : bool | str, default=False
-            Whether to compute similarity within connected components.
+            Whether to compute similarity within connected components. Given a string uses the node property stored in the graph
         relationship_weight_property : str | None, default=None
             The relationship property to use as weights.
         relationship_types : list[str] | None, default=None
@@ -143,7 +143,7 @@ def stats(
         similarity_metric : str, default="JACCARD"
             The similarity metric to use for computation.
         use_components : bool | str, default=False
-            Whether to compute similarity within connected components.
+            Whether to compute similarity within connected components. Given a string uses the node property stored in the graph
         relationship_weight_property : str | None, default=None
             The relationship property to use as weights.
         relationship_types : list[str] | None, default=None
@@ -213,7 +213,7 @@ def stream(
         similarity_metric : str, default="JACCARD"
             The similarity metric to use for computation.
         use_components : bool | str, default=False
-            Whether to compute similarity within connected components.
+            Whether to compute similarity within connected components. Given a string uses the node property stored in the graph
         relationship_weight_property : str | None, default=None
             The relationship property to use as weights.
         relationship_types : list[str] | None, default=None
@@ -290,7 +290,7 @@ def write(
         similarity_metric : str, default="JACCARD"
             The similarity metric to use for computation.
         use_components : bool | str, default=False
-            Whether to compute similarity within connected components.
+            Whether to compute similarity within connected components. Given a string uses the node property stored in the graph
         relationship_weight_property : str | None, default=None
             The relationship property to use as weights.
         relationship_types : list[str] | None, default=None
@@ -338,7 +338,7 @@ def estimate(
     ) -> EstimationResult:
         """
         Estimates the memory requirements for running the Node Similarity algorithm.
-        
+
         Parameters
         ----------
         G : GraphV2
@@ -360,7 +360,7 @@ def estimate(
         similarity_metric : str, default="JACCARD"
             The similarity metric to use for computation.
         use_components : bool | str, default=False
-            Whether to compute similarity within connected components.
+            Whether to compute similarity within connected components. Given a string uses the node property stored in the graph
         relationship_weight_property : str | None, default=None
             The relationship property to use as weights.
         relationship_types : list[str] | None, default=None

graphdatascience/procedure_surface/api/similarity/node_similarity_filtered_endpoints.py

@@ -71,9 +71,9 @@ def mutate(
         upper_degree_cutoff : int, default=2147483647
             The maximum degree a node can have to be considered.
         similarity_metric : str, default="JACCARD"
-            The similarity metric to use for computation.
+            The similarity metric to use for computation. JACCARD, OVERLAP or COSINE.
         use_components : bool | str, default=False
-            Whether to compute similarity within connected components.
+            Whether to compute similarity within connected components. Given a string uses the node property stored in the graph
         relationship_weight_property : str | None, default=None
             The relationship property to use as weights.
         relationship_types : list[str] | None, default=None
@@ -147,9 +147,9 @@ def stats(
         upper_degree_cutoff : int, default=2147483647
             The maximum degree a node can have to be considered.
         similarity_metric : str, default="JACCARD"
-            The similarity metric to use for computation.
+            The similarity metric to use for computation. JACCARD, OVERLAP or COSINE.
         use_components : bool | str, default=False
-            Whether to compute similarity within connected components.
+            Whether to compute similarity within connected components. Given a string uses the node property stored in the graph
         relationship_weight_property : str | None, default=None
             The relationship property to use as weights.
         relationship_types : list[str] | None, default=None
@@ -223,9 +223,9 @@ def stream(
         upper_degree_cutoff : int, default=2147483647
             The maximum degree a node can have to be considered.
         similarity_metric : str, default="JACCARD"
-            The similarity metric to use for computation.
+            The similarity metric to use for computation. JACCARD, OVERLAP or COSINE.
         use_components : bool | str, default=False
-            Whether to compute similarity within connected components.
+            Whether to compute similarity within connected components. Given a string uses the node property stored in the graph
         relationship_weight_property : str | None, default=None
             The relationship property to use as weights.
         relationship_types : list[str] | None, default=None
@@ -306,9 +306,9 @@ def write(
         upper_degree_cutoff : int, default=2147483647
             The maximum degree a node can have to be considered.
         similarity_metric : str, default="JACCARD"
-            The similarity metric to use for computation.
+            The similarity metric to use for computation. JACCARD, OVERLAP or COSINE.
         use_components : bool | str, default=False
-            Whether to compute similarity within connected components.
+            Whether to compute similarity within connected components. Given a string uses the node property stored in the graph
         relationship_weight_property : str | None, default=None
             The relationship property to use as weights.
         relationship_types : list[str] | None, default=None
@@ -382,9 +382,9 @@ def estimate(
         upper_degree_cutoff : int, default=2147483647
             The maximum degree a node can have to be considered.
         similarity_metric : str, default="JACCARD"
-            The similarity metric to use for computation.
+            The similarity metric to use for computation. JACCARD, OVERLAP or COSINE.
         use_components : bool | str, default=False
-            Whether to compute similarity within connected components.
+            Whether to compute similarity within connected components. Given a string uses the node property stored in the graph
         relationship_weight_property : str | None, default=None
             The relationship property to use as weights.
         relationship_types : list[str] | None, default=None