Modify api description (#665)

Signed-off-by: yhmo <[email protected]>
milvus-io · Aug 26, 2021 · 9aaee8a · 9aaee8a
1 parent d5b0ccf
commit 9aaee8a
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 17 deletions.
diff --git a/pymilvus/client/grpc_handler.py b/pymilvus/client/grpc_handler.py
@@ -1163,6 +1163,7 @@ def calc_distance(self, vectors_left, vectors_right, params, timeout=30, **kwarg
         params = params or {"metric": config.CALC_DIST_METRIC}
         if "metric_type" in params.keys():
             params["metric"] = params["metric_type"]
+            params.pop("metric_type")
 
         req = Prepare.calc_distance_request(vectors_left, vectors_right, params)
         future = self._stub.CalcDistance.future(req, wait_for_ready=True, timeout=timeout)

diff --git a/pymilvus/client/stub.py b/pymilvus/client/stub.py
@@ -1078,16 +1078,19 @@ def calc_distance(self, vectors_left, vectors_right, params=None, timeout=None,
         or
         `{"bin_vectors": [b'\x94', b'N', ... b'\xca']}`
 
-        :param params: parameters, currently only support "metric_type", default value is "L2"
-                       extra parameter for "L2" distance: "sqrt", true or false, default is false
-                       extra parameter for "HAMMING" and "TANIMOTO": "dim", set this value if dimension is not a multiple of 8, otherwise the dimension will be calculted by list length
+        :param params: key-value pair parameters
+                       Key: "metric_type"/"metric"    Value: "L2"/"IP"/"HAMMING"/"TANIMOTO", default is "L2",
+                       Key: "sqrt"    Value: true or false, default is false    Only for "L2" distance
+                       Key: "dim"     Value: set this value if dimension is not a multiple of 8,
+                                             otherwise the dimension will be calculted by list length,
+                                             only for "HAMMING" and "TANIMOTO"
         :type  params: dict
-            There are examples of supported metric_type:
-                `{"metric_type": "L2"}`
+            Examples of supported metric_type:
+                `{"metric_type": "L2", "sqrt": true}`
                 `{"metric_type": "IP"}`
-                `{"metric_type": "HAMMING"}`
+                `{"metric_type": "HAMMING", "dim": 17}`
                 `{"metric_type": "TANIMOTO"}`
-            Note: "L2", "IP", "HAMMING", "TANIMOTO" are case insensitive
+            Note: metric type are case insensitive
 
         :return: 2-d array distances
         :rtype: list[list[int]] for "HAMMING" or list[list[float]] for others

diff --git a/pymilvus/orm/pymilvus_orm/utility.py b/pymilvus/orm/pymilvus_orm/utility.py
@@ -314,16 +314,19 @@ def calc_distance(vectors_left, vectors_right, params=None, timeout=None, using=
     or
     `{"bin_vectors": [b'\x94', b'N', ... b'\xca']}`
 
-    :param params: parameters, currently only support "metric_type", default value is "L2"
-                   extra parameter for "L2" distance: "sqrt", true or false, default is false
-                   extra parameter for "HAMMING" and "TANIMOTO": "dim", set this value if dimension is not a multiple of 8, otherwise the dimension will be calculted by list length
-    :type  params: dict
-        There are examples of supported metric_type:
-            `{"metric_type": "L2"}`
-            `{"metric_type": "IP"}`
-            `{"metric_type": "HAMMING"}`
-            `{"metric_type": "TANIMOTO"}`
-        Note: "L2", "IP", "HAMMING", "TANIMOTO" are case insensitive
+    :param params: key-value pair parameters
+                       Key: "metric_type"/"metric"    Value: "L2"/"IP"/"HAMMING"/"TANIMOTO", default is "L2",
+                       Key: "sqrt"    Value: true or false, default is false    Only for "L2" distance
+                       Key: "dim"     Value: set this value if dimension is not a multiple of 8,
+                                             otherwise the dimension will be calculted by list length,
+                                             only for "HAMMING" and "TANIMOTO"
+        :type  params: dict
+            Examples of supported metric_type:
+                `{"metric_type": "L2", "sqrt": true}`
+                `{"metric_type": "IP"}`
+                `{"metric_type": "HAMMING", "dim": 17}`
+                `{"metric_type": "TANIMOTO"}`
+            Note: metric type are case insensitive
 
     :return: 2-d array distances
     :rtype: list[list[int]] for "HAMMING" or list[list[float]] for others